electron-incremental-update 1.0.0 → 1.0.1

package/README.md

@@ -50,8 +50,9 @@ src
 
 ### Setup entry
 
+in `electron/entry.ts` (build by `Esbuild`)
+
 ```ts
-// electron/entry.ts
 import { initApp } from 'electron-incremental-update'
 import { parseGithubCdnURL } from 'electron-incremental-update/utils'
 import { repository } from '../package.json'
@@ -77,8 +78,9 @@ All options are documented with JSDoc
 - cert will read from `process.env.UPDATER_CERT` first, if absend, read config
 - privatekey will read from `process.env.UPDATER_PK` first, if absend, read config
 
+in `vite.config.mts`
+
 ```ts
-// vite.config.mts
 import { defineConfig } from 'vite'
 import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
 import pkg from './package.json'
@@ -164,8 +166,9 @@ However, you have the option to customize the download function when creating th
 
 **NOTE: There should only one function and should be default export in the entry file**
 
+in `electron/main/index.ts`
+
 ```ts
-// electron/main/index.ts
 import { startupWithUpdater } from 'electron-incremental-update'
 import { getPathFromAppNameAsar, getVersions } from 'electron-incremental-update/utils'
 import { app } from 'electron'
@@ -229,6 +232,13 @@ const plugin = electronWithUpdater({
           from: './node_modules/better-sqlite3/build/Release/better_sqlite3.node',
           skipIfExist: false,
         })
+        // for @napi-rs/image
+        const startStr = '@napi-rs+image-'
+        const fileName = (await readdir('./node_modules/.pnpm')).filter(p => p.startsWith(startStr))[0]
+        const archName = fileName.substring(startStr.length).split('@')[0]
+        existsAndCopyToEntryOutputDir({
+          from: `./node_modules/.pnpm/${fileName}/node_modules/@napi-rs/image-${archName}/image.${archName}.node`,
+        })
       },
     },
   },
@@ -280,6 +290,8 @@ module.exports = {
     'dist-entry',
     // exclude better-sqlite3 from electron-builder
     '!node_modules/better-sqlite3/**',
+    // exclude @napi-rs/image from electron-builder
+    '!node_modules/@napi-rs*/**',
   ]
 }
 ```

package/dist/vite.d.mts

@@ -287,27 +287,37 @@ type ElectronWithUpdaterOptions = {
  *
  * @example
  * import { defineConfig } from 'vite'
- * import electronSimple from 'vite-plugin-electron/simple'
- * import { buildElectronPluginOptions } from 'electron-incremental-update/vite'
+ * import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
  * import pkg from './package.json'
  *
- * export default defineConfig(({ command }) => {
- *   const electronOptions = buildElectronPluginOptions({
- *     isBuild: command === 'build',
- *     pkg,
- *     main: {
- *       files: ['./electron/main/index.ts', './electron/main/worker.ts'],
- *     },
- *     preload: {
- *       files: './electron/preload/index.ts',
- *     },
- *   })
+ * export default defineConfig(async ({ command }) => {
+ *   const isBuild = command === 'build'
  *   return {
- *     plugins: [electronSimple(electronOptions)],
+ *     plugins: [
+ *       electronWithUpdater({
+ *         pkg,
+ *         isBuild,
+ *         logParsedOptions: true,
+ *         main: {
+ *           files: ['./electron/main/index.ts', './electron/main/worker.ts'],
+ *           // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28
+ *           onstart: debugStartup,
+ *         },
+ *         preload: {
+ *           files: './electron/preload/index.ts',
+ *         },
+ *         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 }
- *     })()
+ *       return {
+ *         host: url.hostname,
+ *         port: +url.port,
+ *       }
+ *     })(),
  *   }
  * })
  */

package/dist/vite.d.ts

@@ -287,27 +287,37 @@ type ElectronWithUpdaterOptions = {
  *
  * @example
  * import { defineConfig } from 'vite'
- * import electronSimple from 'vite-plugin-electron/simple'
- * import { buildElectronPluginOptions } from 'electron-incremental-update/vite'
+ * import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
  * import pkg from './package.json'
  *
- * export default defineConfig(({ command }) => {
- *   const electronOptions = buildElectronPluginOptions({
- *     isBuild: command === 'build',
- *     pkg,
- *     main: {
- *       files: ['./electron/main/index.ts', './electron/main/worker.ts'],
- *     },
- *     preload: {
- *       files: './electron/preload/index.ts',
- *     },
- *   })
+ * export default defineConfig(async ({ command }) => {
+ *   const isBuild = command === 'build'
  *   return {
- *     plugins: [electronSimple(electronOptions)],
+ *     plugins: [
+ *       electronWithUpdater({
+ *         pkg,
+ *         isBuild,
+ *         logParsedOptions: true,
+ *         main: {
+ *           files: ['./electron/main/index.ts', './electron/main/worker.ts'],
+ *           // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28
+ *           onstart: debugStartup,
+ *         },
+ *         preload: {
+ *           files: './electron/preload/index.ts',
+ *         },
+ *         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 }
- *     })()
+ *       return {
+ *         host: url.hostname,
+ *         port: +url.port,
+ *       }
+ *     })(),
  *   }
  * })
  */

package/dist/vite.js

@@ -297,7 +297,8 @@ function parseOptions(isBuild, pkg, options = {}) {
       entryOutputDirPath = "dist-entry",
       appEntryPath = "electron/entry.ts",
       nativeModuleEntryMap = {},
-      postBuild
+      postBuild,
+      overrideEsbuildOptions
     } = {},
     paths: {
       asarOutputPath = `release/${pkg.name}.asar`,
@@ -335,7 +336,8 @@ function parseOptions(isBuild, pkg, options = {}) {
     entryOutputDirPath,
     appEntryPath,
     nativeModuleEntryMap,
-    postBuild
+    postBuild,
+    overrideEsbuildOptions
   };
   const { privateKey, cert } = parseKeys({
     keyLength,
@@ -386,7 +388,7 @@ function electronWithUpdater(options) {
   const sourcemap = isBuild || !!process.env.VSCODE_DEBUG;
   const _appPath = (0, import_node_path3.join)(entryOutputDirPath, "entry.js");
   if ((0, import_node_path3.resolve)((0, import_vite.normalizePath)(pkg.main)) !== (0, import_node_path3.resolve)((0, import_vite.normalizePath)(_appPath))) {
-    throw new Error(`wrong "main" field in package.json: "${pkg.main}", it should be "${_appPath.replace(/\\/g, "/")}"`);
+    throw new Error(`wrong "main" field in package.json: "${pkg.main}", it should be "${(0, import_vite.normalizePath)(_appPath)}"`);
   }
   let isInit = false;
   const _buildEntry = async () => {

package/dist/vite.mjs

@@ -203,7 +203,8 @@ function parseOptions(isBuild, pkg, options = {}) {
       entryOutputDirPath = "dist-entry",
       appEntryPath = "electron/entry.ts",
       nativeModuleEntryMap = {},
-      postBuild
+      postBuild,
+      overrideEsbuildOptions
     } = {},
     paths: {
       asarOutputPath = `release/${pkg.name}.asar`,
@@ -241,7 +242,8 @@ function parseOptions(isBuild, pkg, options = {}) {
     entryOutputDirPath,
     appEntryPath,
     nativeModuleEntryMap,
-    postBuild
+    postBuild,
+    overrideEsbuildOptions
   };
   const { privateKey, cert } = parseKeys({
     keyLength,
@@ -292,7 +294,7 @@ function electronWithUpdater(options) {
   const sourcemap = isBuild || !!process.env.VSCODE_DEBUG;
   const _appPath = join2(entryOutputDirPath, "entry.js");
   if (resolve(normalizePath(pkg.main)) !== resolve(normalizePath(_appPath))) {
-    throw new Error(`wrong "main" field in package.json: "${pkg.main}", it should be "${_appPath.replace(/\\/g, "/")}"`);
+    throw new Error(`wrong "main" field in package.json: "${pkg.main}", it should be "${normalizePath(_appPath)}"`);
   }
   let isInit = false;
   const _buildEntry = async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-incremental-update",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",