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

package/README.md

@@ -30,9 +30,11 @@ It use 2 asar file structure for updates:
 ```sh
 npm install -D electron-incremental-update
 ```
+
 ```sh
 yarn add -D electron-incremental-update
 ```
+
 ```sh
 pnpm add -D electron-incremental-update
 ```
@@ -113,16 +115,18 @@ export default defineConfig(async ({ command }) => {
         },
         updater: {
           // options
-        }
+        },
       }),
     ],
-    server: process.env.VSCODE_DEBUG && (() => {
-      const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
-      return {
-        host: url.hostname,
-        port: +url.port,
-      }
-    })(),
+    server:
+      process.env.VSCODE_DEBUG &&
+      (() => {
+        const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
+        return {
+          host: url.hostname,
+          port: +url.port,
+        }
+      })(),
   }
 })
 ```
@@ -145,14 +149,16 @@ export default defineElectronConfig({
     // options
   },
   renderer: {
-    server: process.env.VSCODE_DEBUG && (() => {
-      const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
-      return {
-        host: url.hostname,
-        port: +url.port,
-      }
-    })(),
-  }
+    server:
+      process.env.VSCODE_DEBUG &&
+      (() => {
+        const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
+        return {
+          host: url.hostname,
+          port: +url.port,
+        }
+      })(),
+  },
 })
 ```
 
@@ -181,9 +187,7 @@ module.exports = {
     'dist-entry',
   ],
   npmRebuild: false,
-  asarUnpack: [
-    '**/*.{node,dll,dylib,so}',
-  ],
+  asarUnpack: ['**/*.{node,dll,dylib,so}'],
   directories: {
     output: 'release',
   },
@@ -264,7 +268,7 @@ updater.provider = new GitHubProvider({
     url.hostname = 'mirror.ghproxy.com'
     url.pathname = `https://github.com${url.pathname}`
     return url
-  }
+  },
 })
 ```
 
@@ -314,7 +318,7 @@ const plugin = electronWithUpdater({
         })
         // for @napi-rs/image
         const startStr = '@napi-rs+image-'
-        const fileName = readdirSync('./node_modules/.pnpm').find(p => p.startsWith(startStr))!
+        const fileName = readdirSync('./node_modules/.pnpm').find((p) => p.startsWith(startStr))!
         const archName = fileName.substring(startStr.length).split('@')[0]
         copyToEntryOutputDir({
           from: `./node_modules/.pnpm/${fileName}/node_modules/@napi-rs/image-${archName}/image.${archName}.node`,
@@ -333,12 +337,14 @@ in `electron/native/db.ts`
 import Database from 'better-sqlite3'
 import { getPathFromEntryAsar } from 'electron-incremental-update/utils'
 
-const db = new Database(':memory:', { nativeBinding: getPathFromEntryAsar('./better_sqlite3.node') })
+const db = new Database(':memory:', {
+  nativeBinding: getPathFromEntryAsar('./better_sqlite3.node'),
+})
 
 export function test(): void {
   db.exec(
-    'DROP TABLE IF EXISTS employees; '
-    + 'CREATE TABLE IF NOT EXISTS employees (name TEXT, salary INTEGER)',
+    'DROP TABLE IF EXISTS employees; ' +
+      'CREATE TABLE IF NOT EXISTS employees (name TEXT, salary INTEGER)',
   )
 
   db.prepare('INSERT INTO employees VALUES (:n, :s)').run({
@@ -374,7 +380,7 @@ module.exports = {
     'dist-entry',
     // exclude all dependencies in electron-builder config
     '!node_modules/**',
-  ]
+  ],
 }
 ```
 
@@ -597,11 +603,7 @@ function downloadUtil<T>(
   url: string,
   headers: Record<string, any>,
   signal: AbortSignal,
-  onResponse: (
-    resp: IncomingMessage,
-    resolve: (data: T) => void,
-    reject: (e: any) => void
-  ) => void
+  onResponse: (resp: IncomingMessage, resolve: (data: T) => void, reject: (e: any) => void) => void,
 ): Promise<T>
 /**
  * Default function to download json and parse to UpdateJson
@@ -614,7 +616,7 @@ function defaultDownloadJSON<T>(
   url: string,
   headers: Record<string, any>,
   signal: AbortSignal,
-  resolveData?: ResolveDataFn
+  resolveData?: ResolveDataFn,
 ): Promise<T>
 /**
  * Default function to download json and parse to UpdateJson
@@ -625,7 +627,7 @@ function defaultDownloadJSON<T>(
 function defaultDownloadUpdateJSON(
   url: string,
   headers: Record<string, any>,
-  signal: AbortSignal
+  signal: AbortSignal,
 ): Promise<UpdateJSON>
 /**
  * Default function to download asar buffer,
@@ -639,7 +641,7 @@ function defaultDownloadAsar(
   url: string,
   headers: Record<string, any>,
   signal: AbortSignal,
-  onDownloading?: (progress: DownloadingInfo) => void
+  onDownloading?: (progress: DownloadingInfo) => void,
 ): Promise<Buffer>
 ```
 
@@ -688,7 +690,7 @@ type OnInstallFunction = (
   install: VoidFunction,
   tempAsarPath: string,
   appNameAsarPath: string,
-  logger?: Logger
+  logger?: Logger,
 ) => Promisable<void>
 ```
 
@@ -724,6 +726,7 @@ export type Logger = {
   error: (msg: string, e?: Error) => void
 }
 ```
+
 #### Provider
 
 ```ts
@@ -778,7 +781,7 @@ export interface IProvider {
     name: string,
     updateInfo: UpdateInfo,
     signal: AbortSignal,
-    onDownloading?: (info: DownloadingInfo) => void
+    onDownloading?: (info: DownloadingInfo) => void,
   ) => Promise<Buffer>
   /**
    * Check the old version is less than new version
@@ -799,13 +802,18 @@ export interface IProvider {
    * @param signature signature
    * @param cert certificate
    */
-  verifySignaure: (buffer: Buffer, version: string, signature: string, cert: string) => Promisable<boolean>
+  verifySignaure: (
+    buffer: Buffer,
+    version: string,
+    signature: string,
+    cert: string,
+  ) => Promisable<boolean>
 }
 ```
 
 #### Plugin
 
-```ts
+````ts
 export interface ElectronWithUpdaterOptions {
   /**
    * Whether is in build mode
@@ -1111,7 +1119,7 @@ export interface GeneratorOverrideFunctions {
     buffer: Buffer,
     privateKey: string,
     cert: string,
-    version: string
+    version: string,
   ) => Promisable<string>
   /**
    * Custom generate update json function
@@ -1125,7 +1133,7 @@ export interface GeneratorOverrideFunctions {
     existingJson: UpdateJSON,
     signature: string,
     version: string,
-    minVersion: string
+    minVersion: string,
   ) => Promisable<UpdateJSON>
   /**
    * Custom generate zip file buffer
@@ -1133,7 +1141,7 @@ export interface GeneratorOverrideFunctions {
    */
   generateGzipFile?: (buffer: Buffer) => Promisable<Buffer>
 }
-```
+````
 
 ## Credits
 

package/dist/download-BN4uMS4_.d.mts

@@ -0,0 +1,39 @@
+import { p as Arrayable, s as UpdateJSON, t as DownloadingInfo } from "./types-DASqEPXE.mjs";
+import { ClientRequest, IncomingMessage } from "electron";
+
+//#region src/utils/download.d.ts
+/**
+* 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;
+declare function downloadUtil<T>(url: string, headers: Record<string, any>, onResponse: (req: ClientRequest, resp: IncomingMessage, resolve: (data: T) => void, reject: (e: any) => void) => void): Promise<T>;
+type ResolveDataFn = (data: string, resolve: (data: any) => void, reject: (e: any) => void) => void;
+declare const resolveJson: ResolveDataFn;
+/**
+* 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 defaultDownloadText<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?: (progress: DownloadingInfo) => void): Promise<Buffer>;
+//#endregion
+export { getHeader as a, downloadUtil as i, defaultDownloadText as n, resolveJson as o, defaultDownloadUpdateJSON as r, defaultDownloadAsar as t };

package/dist/download-DO7iuxEJ.d.cts

@@ -0,0 +1,39 @@
+import { p as Arrayable, s as UpdateJSON, t as DownloadingInfo } from "./types-BM9Jfu7q.cjs";
+import { ClientRequest, IncomingMessage } from "electron";
+
+//#region src/utils/download.d.ts
+/**
+* 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;
+declare function downloadUtil<T>(url: string, headers: Record<string, any>, onResponse: (req: ClientRequest, resp: IncomingMessage, resolve: (data: T) => void, reject: (e: any) => void) => void): Promise<T>;
+type ResolveDataFn = (data: string, resolve: (data: any) => void, reject: (e: any) => void) => void;
+declare const resolveJson: ResolveDataFn;
+/**
+* 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 defaultDownloadText<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?: (progress: DownloadingInfo) => void): Promise<Buffer>;
+//#endregion
+export { getHeader as a, downloadUtil as i, defaultDownloadText as n, resolveJson as o, defaultDownloadUpdateJSON as r, defaultDownloadAsar as t };

package/dist/electron-BFoZUBhU.cjs

@@ -0,0 +1,320 @@
+const require_version = require('./version-aPrLuz_-.cjs');
+let electron = require("electron");
+let node_fs = require("node:fs");
+node_fs = require_version.__toESM(node_fs);
+let node_path = require("node:path");
+node_path = require_version.__toESM(node_path);
+
+//#region src/utils/electron.ts
+/**
+* Compile time dev check
+*/
+const isDev = __EIU_IS_DEV__;
+const isWin = process.platform === "win32";
+const isMac = process.platform === "darwin";
+const isLinux = process.platform === "linux";
+/**
+* Get joined path of `${electron.app.name}.asar` (not `app.asar`)
+*
+* If is in dev, **always** return `'DEV.asar'`
+*/
+function getPathFromAppNameAsar(...paths) {
+	return isDev ? "DEV.asar" : node_path.default.join(node_path.default.dirname(electron.app.getAppPath()), `${electron.app.name}.asar`, ...paths);
+}
+/**
+* Get app version, if is in dev, return `getEntryVersion()`
+*/
+function getAppVersion() {
+	return isDev ? getEntryVersion() : node_fs.default.readFileSync(getPathFromAppNameAsar("version"), "utf-8");
+}
+/**
+* Get entry version
+*/
+function getEntryVersion() {
+	return electron.app.getVersion();
+}
+/**
+* Use `require` to load native module from entry asar
+* @param moduleName file name in entry
+* @example
+* requireNative<typeof import('../native/db')>('db')
+*/
+function requireNative(moduleName) {
+	const m = getPathFromEntryAsar(moduleName);
+	if (__EIU_IS_ESM__) throw new Error(`Cannot require "${m}", \`requireNative\` only support CommonJS, use \`importNative\` instead`);
+	return require(m);
+}
+/**
+* Use `import` to load native module from entry asar
+* @param moduleName file name in entry
+* @example
+* await importNative<typeof import('../native/db')>('db')
+*/
+async function importNative(moduleName) {
+	const m = getPathFromEntryAsar(moduleName);
+	if (!__EIU_IS_ESM__) throw new Error(`Cannot import "${m}", \`importNative\` only support ESModule, use \`requireNative\` instead`);
+	return await import(`file://${m}.js`);
+}
+/**
+* Restarts the Electron app.
+*/
+function restartApp() {
+	electron.app.relaunch();
+	electron.app.quit();
+}
+/**
+* Fix app use model id, only for Windows
+* @param id app id, default is `org.${electron.app.name}`
+*/
+function setAppUserModelId(id) {
+	if (isWin) electron.app.setAppUserModelId(id ?? `org.${electron.app.name}`);
+}
+/**
+* Disable hardware acceleration for Windows 7
+*
+* Only support CommonJS
+*/
+function disableHWAccForWin7() {
+	if (!__EIU_IS_ESM__ && require("node:os").release().startsWith("6.1")) electron.app.disableHardwareAcceleration();
+}
+/**
+* Keep single electron instance and auto restore window on `second-instance` event
+* @param window brwoser window to show
+*/
+function singleInstance(window) {
+	electron.app.on("second-instance", () => {
+		if (window) {
+			window.show();
+			if (window.isMinimized()) window.restore();
+			window.focus();
+		}
+	});
+}
+/**
+* Set `userData` dir to the dir of .exe file
+*
+* Useful for portable Windows app
+* @param dirName dir name, default to `data`
+* @param create whether to create dir, default to `true`
+*/
+function setPortableDataPath(dirName = "data", create = true) {
+	if (electron.app.isReady()) throw new Error("Portable app data dir must be setup before app is ready");
+	const portableDir = node_path.default.join(node_path.default.dirname(electron.app.getPath("exe")), dirName);
+	if (create) {
+		if (!node_fs.default.existsSync(portableDir)) node_fs.default.mkdirSync(portableDir);
+		else if (!node_fs.default.statSync(portableDir).isDirectory()) {
+			node_fs.default.rmSync(portableDir);
+			node_fs.default.mkdirSync(portableDir);
+		}
+	} else if (!node_fs.default.existsSync(portableDir)) throw new Error("Portable app data dir does not exists");
+	electron.app.setPath("userData", portableDir);
+}
+/**
+* @deprecated Use {@link setPortableDataPath} instead
+*/
+const setPortableAppDataPath = setPortableDataPath;
+/**
+* Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
+* @param win window
+* @param htmlFilePath html file path, default is `index.html`
+*/
+function loadPage(win, htmlFilePath = "index.html") {
+	if (isDev) win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath);
+	else win.loadFile(getPathFromAppNameAsar("renderer", htmlFilePath));
+}
+/**
+* Beautify devtools' font and scrollbar
+* @param win target window
+* @param options sans font family, mono font family and scrollbar
+* @see https://github.com/electron/electron/issues/42055
+*/
+function beautifyDevTools(win, options) {
+	const { mono, sans, scrollbar = true } = options;
+	win.webContents.on("devtools-opened", async () => {
+		let css = `:root{--sans:${sans};--mono:${mono}}:root, body { --source-code-font-family: var(--mono) !important; --source-code-font-size: 12px !important; --monospace-font-family: var(--mono) !important; --monospace-font-size: 12px !important; --default-font-family: var(--sans), sans-serif !important; --default-font-size: 12px !important; } button, input, select, .undisplayable-text, .expandable-inline-button { font-family: var(--sans) !important; } `;
+		if (scrollbar) css += ":root { --scrollbar-width: max(0.85vw, 10px); } @media (prefers-color-scheme: light) { :root { --scrollbar-color-rgb: 0, 0, 0; } } @media (prefers-color-scheme: dark) { :root { --scrollbar-color-rgb: 255, 255, 255; } } *::-webkit-scrollbar { width: var(--scrollbar-width) !important; height: var(--scrollbar-width) !important; } *::-webkit-scrollbar-track { background-color: transparent !important; border-radius: var(--scrollbar-width) !important; box-shadow: none !important; } *::-webkit-scrollbar-thumb { box-shadow: inset 0 0 0 var(--scrollbar-width) !important; border-radius: var(--scrollbar-width) !important; border: calc(var(--scrollbar-width) * 2 / 9) solid transparent !important; background-clip: content-box; background-color: transparent !important; color: rgba(var(--scrollbar-color-rgb), 30%) !important; } *::-webkit-scrollbar-thumb:hover { color: rgba(var(--scrollbar-color-rgb), 45%) !important; } *::-webkit-scrollbar-thumb:active { color: rgba(var(--scrollbar-color-rgb), 60%) !important; } @supports not selector(::-webkit-scrollbar) { html { scrollbar-color: rgb(var(--scrollbar-color-rgb)); scrollbar-width: thin; } } ";
+		const js = `const __CSS__='${css}';function e(e){let t=document.createElement(\`style\`);t.innerHTML=e,document.body.append(t),[\`platform-windows\`,\`platform-mac\`,\`platform-linux\`].forEach(e=>document.querySelectorAll(\`.\${e}\`).forEach(t=>t.classList.remove(e))),r();let n=new MutationObserver(e=>{for(let t of e)if(t.type===\`childList\`)for(let e=0;e<t.addedNodes.length;e++)t.addedNodes[e].classList.contains(\`editor-tooltip-host\`)&&r()});n.observe(document.body,{childList:!0});function r(){document.querySelectorAll(\`.editor-tooltip-host\`).forEach(t=>{if(t?.shadowRoot?.querySelectorAll(\`[data-key="overridden-dev-tools-font"]\`).length===0){let n=document.createElement(\`style\`);n.dataset.key=\`overridden-dev-tools-font\`,n.innerHTML=\`\${e}.cm-tooltip-autocomplete ul[role=listbox]{font-family:var(--mono)!important;}\`,t.shadowRoot.append(n)}})}window.onbeforeunload=()=>n.disconnect()}e(__CSS__);`;
+		await win?.webContents.devToolsWebContents?.executeJavaScript(js);
+	});
+}
+/**
+* Get joined path from main dir
+* @param paths rest paths
+*/
+function getPathFromMain(...paths) {
+	return isDev ? node_path.default.join(electron.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "main", ...paths) : getPathFromAppNameAsar("main", ...paths);
+}
+/**
+* Get joined path from preload dir
+* @param paths rest paths
+*/
+function getPathFromPreload(...paths) {
+	return isDev ? node_path.default.join(electron.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "preload", ...paths) : getPathFromAppNameAsar("preload", ...paths);
+}
+/**
+* Get joined path from publich dir
+* @param paths rest paths
+*/
+function getPathFromPublic(...paths) {
+	return isDev ? node_path.default.join(electron.app.getAppPath(), "public", ...paths) : getPathFromAppNameAsar("renderer", ...paths);
+}
+/**
+* Get joined path from entry asar
+* @param paths rest paths
+*/
+function getPathFromEntryAsar(...paths) {
+	return node_path.default.join(electron.app.getAppPath(), __EIU_ENTRY_DIST_PATH__, ...paths);
+}
+/**
+* Handle all unhandled error
+* @param callback callback function
+*/
+function handleUnexpectedErrors(callback) {
+	process.on("uncaughtException", callback);
+	process.on("unhandledRejection", callback);
+}
+function reloadOnPreloadScriptChanged() {
+	if (isDev) process.on("message", (msg) => {
+		if (msg === "electron-vite&type=hot-reload") for (const window of electron.BrowserWindow.getAllWindows()) window.reload();
+	});
+}
+
+//#endregion
+Object.defineProperty(exports, 'beautifyDevTools', {
+  enumerable: true,
+  get: function () {
+    return beautifyDevTools;
+  }
+});
+Object.defineProperty(exports, 'disableHWAccForWin7', {
+  enumerable: true,
+  get: function () {
+    return disableHWAccForWin7;
+  }
+});
+Object.defineProperty(exports, 'getAppVersion', {
+  enumerable: true,
+  get: function () {
+    return getAppVersion;
+  }
+});
+Object.defineProperty(exports, 'getEntryVersion', {
+  enumerable: true,
+  get: function () {
+    return getEntryVersion;
+  }
+});
+Object.defineProperty(exports, 'getPathFromAppNameAsar', {
+  enumerable: true,
+  get: function () {
+    return getPathFromAppNameAsar;
+  }
+});
+Object.defineProperty(exports, 'getPathFromEntryAsar', {
+  enumerable: true,
+  get: function () {
+    return getPathFromEntryAsar;
+  }
+});
+Object.defineProperty(exports, 'getPathFromMain', {
+  enumerable: true,
+  get: function () {
+    return getPathFromMain;
+  }
+});
+Object.defineProperty(exports, 'getPathFromPreload', {
+  enumerable: true,
+  get: function () {
+    return getPathFromPreload;
+  }
+});
+Object.defineProperty(exports, 'getPathFromPublic', {
+  enumerable: true,
+  get: function () {
+    return getPathFromPublic;
+  }
+});
+Object.defineProperty(exports, 'handleUnexpectedErrors', {
+  enumerable: true,
+  get: function () {
+    return handleUnexpectedErrors;
+  }
+});
+Object.defineProperty(exports, 'importNative', {
+  enumerable: true,
+  get: function () {
+    return importNative;
+  }
+});
+Object.defineProperty(exports, 'isDev', {
+  enumerable: true,
+  get: function () {
+    return isDev;
+  }
+});
+Object.defineProperty(exports, 'isLinux', {
+  enumerable: true,
+  get: function () {
+    return isLinux;
+  }
+});
+Object.defineProperty(exports, 'isMac', {
+  enumerable: true,
+  get: function () {
+    return isMac;
+  }
+});
+Object.defineProperty(exports, 'isWin', {
+  enumerable: true,
+  get: function () {
+    return isWin;
+  }
+});
+Object.defineProperty(exports, 'loadPage', {
+  enumerable: true,
+  get: function () {
+    return loadPage;
+  }
+});
+Object.defineProperty(exports, 'reloadOnPreloadScriptChanged', {
+  enumerable: true,
+  get: function () {
+    return reloadOnPreloadScriptChanged;
+  }
+});
+Object.defineProperty(exports, 'requireNative', {
+  enumerable: true,
+  get: function () {
+    return requireNative;
+  }
+});
+Object.defineProperty(exports, 'restartApp', {
+  enumerable: true,
+  get: function () {
+    return restartApp;
+  }
+});
+Object.defineProperty(exports, 'setAppUserModelId', {
+  enumerable: true,
+  get: function () {
+    return setAppUserModelId;
+  }
+});
+Object.defineProperty(exports, 'setPortableAppDataPath', {
+  enumerable: true,
+  get: function () {
+    return setPortableAppDataPath;
+  }
+});
+Object.defineProperty(exports, 'setPortableDataPath', {
+  enumerable: true,
+  get: function () {
+    return setPortableDataPath;
+  }
+});
+Object.defineProperty(exports, 'singleInstance', {
+  enumerable: true,
+  get: function () {
+    return singleInstance;
+  }
+});