electron-incremental-update 2.3.6 → 2.3.8

package/README.md

@@ -278,7 +278,7 @@ const plugin = electronWithUpdater({
         db: './electron/native/db.ts',
         img: './electron/native/img.ts',
       },
-      postBuild: async ({ copyToEntryOutputDir, copyModules }) => {
+      postBuild: ({ copyToEntryOutputDir, copyModules }) => {
         // for better-sqlite3
         copyToEntryOutputDir({
           from: './node_modules/better-sqlite3/build/Release/better_sqlite3.node',
@@ -286,7 +286,7 @@ const plugin = electronWithUpdater({
         })
         // for @napi-rs/image
         const startStr = '@napi-rs+image-'
-        const fileName = (await readdir('./node_modules/.pnpm')).filter(p => p.startsWith(startStr))[0]
+        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`,
@@ -350,6 +350,74 @@ module.exports = {
 }
 ```
 
+#### Result in app.asar
+
+Before: Redundant 🤮
+
+```
+.
+├── dist-entry
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   └── image.js
+├── node_modules
+│   ├── @napi-rs
+│   ├── base64-js
+│   ├── better-sqlite3
+│   ├── bindings
+│   ├── bl
+│   ├── buffer
+│   ├── chownr
+│   ├── decompress-response
+│   ├── deep-extend
+│   ├── detect-libc
+│   ├── end-of-stream
+│   ├── expand-template
+│   ├── file-uri-to-path
+│   ├── fs-constants
+│   ├── github-from-package
+│   ├── ieee754
+│   ├── inherits
+│   ├── ini
+│   ├── mimic-response
+│   ├── minimist
+│   ├── mkdirp-classic
+│   ├── napi-build-utils
+│   ├── node-abi
+│   ├── once
+│   ├── prebuild-install
+│   ├── pump
+│   ├── rc
+│   ├── readable-stream
+│   ├── safe-buffer
+│   ├── semver
+│   ├── simple-concat
+│   ├── simple-get
+│   ├── string_decoder
+│   ├── strip-json-comments
+│   ├── tar-fs
+│   ├── tar-stream
+│   ├── tunnel-agent
+│   ├── util-deprecate
+│   └── wrappy
+└── package.json
+```
+
+After: Clean 😍
+
+```
+.
+├── dist-entry
+│   ├── better_sqlite3.node
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   ├── image.js
+│   └── image.win32-x64-msvc.node
+└── package.json
+```
+
 ### Bytecode Protection
 
 Use V8 cache to protect the source code
@@ -433,12 +501,13 @@ function disableHWAccForWin7(): void
  */
 function singleInstance(window?: BrowserWindow): void
 /**
- * Set `AppData` dir to the dir of .exe file
+ * 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 setPortableAppDataPath(dirName?: string): void
+function setPortableDataPath(dirName?: string, create?: boolean): void
 /**
  * Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
  * @param win window
@@ -922,7 +991,9 @@ export interface BuildEntryOption {
   /**
    * `external` option in `build.rollupOptions`,
    * default is node built-in modules or native modules.
-   * If is in dev, also external `dependencies` in package.json
+   *
+   * If is in dev and {@link postBuild} is not setup, will also
+   * external `dependencies` in `package.json`
    */
   external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external']
   /**
@@ -943,8 +1014,9 @@ export interface BuildEntryOption {
    */
   overrideViteOptions?: InlineConfig
   /**
-   * Resolve extra files on startup, such as `.node`
-   * @remark won't trigger will reload
+   * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+   * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+   * to manually handle the native module files.
    */
   postBuild?: (args: {
     /**

package/dist/{chunk-QKKPETVJ.js → chunk-IVHNGRZY.js}

@@ -1,6 +1,6 @@
 import { __require } from './chunk-AAAM44NW.js';
-import fs from 'node:fs';
-import path from 'node:path';
+import fs from 'fs';
+import path from 'path';
 import electron from 'electron';
 
 var isDev = __EIU_IS_DEV__;
@@ -40,7 +40,7 @@ function setAppUserModelId(id) {
   }
 }
 function disableHWAccForWin7() {
-  if (!__EIU_IS_ESM__ && __require("node:os").release().startsWith("6.1")) {
+  if (!__EIU_IS_ESM__ && __require("os").release().startsWith("6.1")) {
     electron.app.disableHardwareAcceleration();
   }
 }
@@ -55,13 +55,24 @@ function singleInstance(window) {
     }
   });
 }
-function setPortableAppDataPath(dirName = "data") {
-  const portablePath = path.join(path.dirname(electron.app.getPath("exe")), dirName);
-  if (!fs.existsSync(portablePath)) {
-    fs.mkdirSync(portablePath);
+function setPortableDataPath(dirName = "data", create = true) {
+  if (electron.app.isReady()) {
+    throw new Error("Portable app data dir must be setup before app is ready");
   }
-  electron.app.setPath("appData", portablePath);
+  const portableDir = path.join(path.dirname(electron.app.getPath("exe")), dirName);
+  if (create) {
+    if (!fs.existsSync(portableDir)) {
+      fs.mkdirSync(portableDir);
+    } else if (!fs.statSync(portableDir).isDirectory()) {
+      fs.rmSync(portableDir);
+      fs.mkdirSync(portableDir);
+    }
+  } else if (!fs.existsSync(portableDir)) {
+    throw new Error("Portable app data dir does not exists");
+  }
+  electron.app.setPath("userData", portableDir);
 }
+var setPortableAppDataPath = setPortableDataPath;
 function loadPage(win, htmlFilePath = "index.html") {
   if (isDev) {
     win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath);
@@ -108,4 +119,4 @@ function reloadOnPreloadScriptChanged() {
   }
 }
 
-export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };
+export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, setPortableDataPath, singleInstance };

package/dist/{chunk-QPAKJHVM.js → chunk-PD4EV4MM.js}

@@ -1,7 +1,7 @@
 import { isUpdateJSON } from './chunk-AAAM44NW.js';
-import crypto from 'node:crypto';
+import crypto from 'crypto';
 import electron from 'electron';
-import zlib from 'node:zlib';
+import zlib from 'zlib';
 
 function hashBuffer(data, length) {
   const hash = crypto.createHash("SHA256").update(data).digest("binary");

package/dist/index.js

@@ -1,9 +1,9 @@
-import { isDev, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-QKKPETVJ.js';
+import { isDev, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-IVHNGRZY.js';
 import { isUpdateJSON, __require } from './chunk-AAAM44NW.js';
-import fs from 'node:fs';
-import path from 'node:path';
+import fs from 'fs';
+import path from 'path';
 import electron2 from 'electron';
-import { EventEmitter } from 'node:events';
+import { EventEmitter } from 'events';
 
 // src/entry/types.ts
 var UpdaterError = class extends Error {

package/dist/provider.js

@@ -1,7 +1,7 @@
-import { defaultVerifySignature, defaultUnzipFile, defaultDownloadUpdateJSON, defaultDownloadAsar, defaultDownloadText, resolveJson } from './chunk-QPAKJHVM.js';
-export { defaultDownloadAsar, defaultDownloadText, defaultDownloadUpdateJSON, downloadUtil, getHeader, resolveJson } from './chunk-QPAKJHVM.js';
+import { defaultVerifySignature, defaultUnzipFile, defaultDownloadUpdateJSON, defaultDownloadAsar, defaultDownloadText, resolveJson } from './chunk-PD4EV4MM.js';
+export { defaultDownloadAsar, defaultDownloadText, defaultDownloadUpdateJSON, downloadUtil, getHeader, resolveJson } from './chunk-PD4EV4MM.js';
 import { defaultIsLowerVersion } from './chunk-AAAM44NW.js';
-import { URL } from 'node:url';
+import { URL } from 'url';
 
 // src/provider/base.ts
 var BaseProvider = class {
@@ -149,8 +149,6 @@ var GitHubAtomProvider = class extends BaseGitHubProvider {
     return `releases/download/v${tag}/${versionPath}`;
   }
 };
-
-// src/provider/github/file.ts
 var GitHubProvider = class extends BaseGitHubProvider {
   name = "GithubProvider";
   /**

package/dist/utils.cjs

@@ -266,13 +266,24 @@ function singleInstance(window) {
     }
   });
 }
-function setPortableAppDataPath(dirName = "data") {
-  const portablePath = path__default.default.join(path__default.default.dirname(electron2__default.default.app.getPath("exe")), dirName);
-  if (!fs__default.default.existsSync(portablePath)) {
-    fs__default.default.mkdirSync(portablePath);
+function setPortableDataPath(dirName = "data", create = true) {
+  if (electron2__default.default.app.isReady()) {
+    throw new Error("Portable app data dir must be setup before app is ready");
   }
-  electron2__default.default.app.setPath("appData", portablePath);
+  const portableDir = path__default.default.join(path__default.default.dirname(electron2__default.default.app.getPath("exe")), dirName);
+  if (create) {
+    if (!fs__default.default.existsSync(portableDir)) {
+      fs__default.default.mkdirSync(portableDir);
+    } else if (!fs__default.default.statSync(portableDir).isDirectory()) {
+      fs__default.default.rmSync(portableDir);
+      fs__default.default.mkdirSync(portableDir);
+    }
+  } else if (!fs__default.default.existsSync(portableDir)) {
+    throw new Error("Portable app data dir does not exists");
+  }
+  electron2__default.default.app.setPath("userData", portableDir);
 }
+var setPortableAppDataPath = setPortableDataPath;
 function loadPage(win, htmlFilePath = "index.html") {
   if (isDev) {
     win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath);
@@ -367,4 +378,5 @@ exports.resolveJson = resolveJson;
 exports.restartApp = restartApp;
 exports.setAppUserModelId = setAppUserModelId;
 exports.setPortableAppDataPath = setPortableAppDataPath;
+exports.setPortableDataPath = setPortableDataPath;
 exports.singleInstance = singleInstance;

package/dist/utils.d.cts

@@ -60,12 +60,18 @@ declare function disableHWAccForWin7(): void;
  */
 declare function singleInstance(window?: BrowserWindow): void;
 /**
- * Set `AppData` dir to the dir of .exe file
+ * 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`
  */
-declare function setPortableAppDataPath(dirName?: string): void;
+declare function setPortableDataPath(dirName?: string, create?: boolean): void;
+/**
+ * @deprecated
+ * @alias {@link setPortableDataPath}
+ */
+declare const setPortableAppDataPath: typeof setPortableDataPath;
 /**
  * Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
  * @param win window
@@ -120,4 +126,4 @@ declare function getPathFromEntryAsar(...paths: string[]): string;
 declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 declare function reloadOnPreloadScriptChanged(): void;
 
-export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };
+export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, setPortableDataPath, singleInstance };

package/dist/utils.d.ts

@@ -60,12 +60,18 @@ declare function disableHWAccForWin7(): void;
  */
 declare function singleInstance(window?: BrowserWindow): void;
 /**
- * Set `AppData` dir to the dir of .exe file
+ * 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`
  */
-declare function setPortableAppDataPath(dirName?: string): void;
+declare function setPortableDataPath(dirName?: string, create?: boolean): void;
+/**
+ * @deprecated
+ * @alias {@link setPortableDataPath}
+ */
+declare const setPortableAppDataPath: typeof setPortableDataPath;
 /**
  * Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
  * @param win window
@@ -120,4 +126,4 @@ declare function getPathFromEntryAsar(...paths: string[]): string;
 declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 declare function reloadOnPreloadScriptChanged(): void;
 
-export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };
+export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, setPortableDataPath, singleInstance };

package/dist/utils.js

@@ -1,3 +1,3 @@
-export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance } from './chunk-QKKPETVJ.js';
-export { aesDecrypt, aesEncrypt, defaultDownloadAsar, defaultDownloadText, defaultDownloadUpdateJSON, defaultSignature, defaultUnzipFile, defaultVerifySignature, defaultZipFile, downloadUtil, getHeader, hashBuffer, resolveJson } from './chunk-QPAKJHVM.js';
+export { beautifyDevTools, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromMain, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, importNative, isDev, isLinux, isMac, isWin, loadPage, reloadOnPreloadScriptChanged, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, setPortableDataPath, singleInstance } from './chunk-IVHNGRZY.js';
+export { aesDecrypt, aesEncrypt, defaultDownloadAsar, defaultDownloadText, defaultDownloadUpdateJSON, defaultSignature, defaultUnzipFile, defaultVerifySignature, defaultZipFile, downloadUtil, getHeader, hashBuffer, resolveJson } from './chunk-PD4EV4MM.js';
 export { defaultIsLowerVersion, defaultVersionJsonGenerator, isUpdateJSON, parseVersion } from './chunk-AAAM44NW.js';

package/dist/vite.d.ts

@@ -106,7 +106,9 @@ interface BuildEntryOption {
     /**
      * `external` option in `build.rollupOptions`,
      * default is node built-in modules or native modules.
-     * If is in dev, also external `dependencies` in package.json
+     *
+     * If is in dev and {@link postBuild} is not setup, will also
+     * external `dependencies` in `package.json`
      */
     external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external'];
     /**
@@ -127,8 +129,12 @@ interface BuildEntryOption {
      */
     overrideViteOptions?: InlineConfig;
     /**
-     * Resolve extra files on startup, such as `.node`
-     * @remark won't trigger will reload
+     * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+     * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+     * to manually handle the native module files.
+     *
+     * If you are using `electron-buidler`, don't forget to append `'!node_modules/**'` in
+     * electron-build config's `files` array
      */
     postBuild?: (args: {
         /**

package/dist/vite.js

@@ -1,5 +1,5 @@
-import fs5 from 'node:fs';
-import path5 from 'node:path';
+import fs5 from 'fs';
+import path5 from 'path';
 import { isCI } from 'ci-info';
 export { isCI } from 'ci-info';
 import { getPackageInfoSync, loadPackageJSON } from 'local-pkg';
@@ -10,11 +10,11 @@ import { notBundle } from 'vite-plugin-electron/plugin';
 import ElectronSimple from 'vite-plugin-electron/simple';
 import Asar from '@electron/asar';
 import MagicString from 'magic-string';
-import cp from 'node:child_process';
+import cp from 'child_process';
 import * as babel from '@babel/core';
-import { builtinModules } from 'node:module';
-import crypto from 'node:crypto';
-import zlib from 'node:zlib';
+import { builtinModules } from 'module';
+import crypto from 'crypto';
+import zlib from 'zlib';
 import { generate } from 'selfsigned';
 
 // src/vite/index.ts
@@ -607,7 +607,7 @@ function parseOptions(isBuild, pkg, sourcemap = false, minify = false, options =
         /.*\.(node|dll|dylib|so)$/,
         "original-fs",
         ...builtinModules,
-        ...isBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
+        ...isBuild || postBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
       ],
       overrideViteOptions = {}
     } = {},
@@ -696,7 +696,7 @@ async function filterErrorMessageStartup(args, filter) {
 function fixWinCharEncoding(fn) {
   return async (...args) => {
     if (process.platform === "win32") {
-      (await import('node:child_process')).spawnSync("chcp", ["65001"]);
+      (await import('child_process')).spawnSync("chcp", ["65001"]);
     }
     await fn(...args);
   };
@@ -792,12 +792,12 @@ async function electronWithUpdater(options) {
       getPathFromEntryOutputDir(...paths) {
         return path5.join(entryOutputDirPath, ...paths);
       },
-      copyToEntryOutputDir({ from, to, skipIfExist = true }) {
+      copyToEntryOutputDir({ from, to = path5.basename(from), skipIfExist = true }) {
         if (!fs5.existsSync(from)) {
           log.warn(`${from} not found`, { timestamp: true });
           return;
         }
-        const target = path5.join(entryOutputDirPath, to ?? path5.basename(from));
+        const target = path5.join(entryOutputDirPath, to);
         copyAndSkipIfExist(from, target, skipIfExist);
       },
       copyModules({ modules, skipIfExist = true }) {
@@ -895,7 +895,7 @@ async function electronWithUpdater(options) {
           ...electronPluginOptions,
           updater: { buildAsarOption, buildEntryOption, buildVersionOption }
         },
-        (key, value) => (key === "privateKey" || key === "cert") && shouldShowKey ? `<${key.toUpperCase()}>` : value,
+        (key, value) => key === "privateKey" || key === "cert" ? shouldShowKey ? value : `<${key.toUpperCase()}>` : value,
         2
       ),
       { timestamp: true }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.3.6",
+  "version": "2.3.8",
   "description": "Electron incremental update tools with Vite plugin, support bytecode protection",
   "author": "subframe7536",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "@electron/asar": "*"
   },
   "dependencies": {
-    "@babel/core": "^7.27.1",
+    "@babel/core": "^7.27.4",
     "@babel/plugin-transform-arrow-functions": "^7.27.1",
     "@babel/plugin-transform-template-literals": "^7.27.1",
     "@subframe7536/type-utils": "^0.2.0",
@@ -70,19 +70,19 @@
     "vite-plugin-electron": "^0.29.0"
   },
   "devDependencies": {
-    "@subframe7536/eslint-config": "^1.2.4",
+    "@subframe7536/eslint-config": "^1.3.1",
     "@types/babel__core": "^7.20.5",
-    "@types/node": "^22.15.17",
-    "@vitest/eslint-plugin": "^1.1.44",
-    "bumpp": "^10.1.0",
+    "@types/node": "^22.15.30",
+    "@vitest/eslint-plugin": "^1.2.1",
+    "bumpp": "^10.1.1",
     "electron": "36.2.0",
     "esbuild": "^0.25.4",
-    "eslint": "^9.26.0",
-    "tsup": "^8.4.0",
+    "eslint": "^9.28.0",
+    "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
     "vite-plugin-electron": "^0.29.0",
-    "vitest": "^3.1.3"
+    "vitest": "^3.2.2"
   },
   "pnpm": {
     "overrides": {