electron-incremental-update 0.8.4 → 0.8.5

package/README.md

@@ -1,234 +1,233 @@
-## electron incremental updater
-
-This project provide a vite plugin, `Updater` class and some useful functions to generate incremental update.
-
-There will be two asar in production, `app.asar` and `main.asar` (if "main" is your app's name).
-
-The `app.asar` is used to load `main.asar` and initialize the `updater`. Also, all the **native modules**, which are set as `dependencies` in `package.json`, will be packaged into `app.asar` by `electron-builder`, [see usage](#use-native-modules).
-
-The new `main.asar` downloaded from remote will be verified by presigned RSA + Signature. When pass the check and restart, the old `main.asar` will be replaced by the new one. Hooks like `beforeDoUpdate` are provided.
-
-- inspired by Obsidian's update strategy
-
-### notice
-
-- this plugin is developed with [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron), and may be effect in other electron vite frameworks
-- **all options are documented in the jsdoc**
-- entry file's EOL will force to `\n`
-
-## install
-
-### npm
-```bash
-npm install electron-incremental-update
-```
-### yarn
-```bash
-yarn add electron-incremental-update
-```
-### pnpm
-```bash
-pnpm add electron-incremental-update
-```
-
-## setup
-
-base on [electron-vite-vue](https://github.com/electron-vite/electron-vite-vue)
-
-```
-electron
-├── app.ts // <- add app entry file
-├── electron-env.d.ts
-├── main
-│   ├── db.ts
-│   ├── index.ts
-└── preload
-    └── index.ts
-src
-└── ...
-```
-
-### setup app
-
-```ts
-// electron/app.ts
-import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
-import { name, repository } from '../package.json'
-
-const SIGNATURE_CERT = '' // auto generate certificate when start app
-
-const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
-const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
-initApp({ onStart: console.log })
-  // can be updater option or function that return updater
-  .setUpdater({
-    SIGNATURE_CERT,
-    productName: name,
-    repository,
-    updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
-    releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
-    receiveBeta: true
-  })
-```
-
-### setup vite.config.ts
-
-make sure the plugin is set in the **last** build task
-
-- for `vite-plugin-electron`, set it to `preload` (the second object in the plugin option array)
-
-```ts
-// vite.config.ts
-export default defineConfig(({ command }) => {
-
-  const isBuild = command === 'build'
-  // ...
-
-  return {
-    plugins: [
-      electron([
-        // main
-        {
-          // ...
-        },
-        // preload
-        {
-          // ...
-          vite: {
-            plugins: [
-              updater({
-                productName: pkg.name,
-                version: pkg.version,
-                isBuild,
-              }),
-            ],
-            // ...
-          }
-        },
-        // when using vite-plugin-electron-renderer
-        {
-          // ...
-        }
-      ]),
-      // ...
-    ],
-    // ...
-  }
-})
-```
-
-### modify package.json
-
-```json
-{
-  // ...
-  "main": "app.js" // <- app entry file
-}
-```
-
-### config electron-builder
-
-```js
-const { name } = require('./package.json')
-
-const target = `${name}.asar`
-/**
- * @type {import('electron-builder').Configuration}
- */
-module.exports = {
-  appId: 'YourAppID',
-  productName: name,
-  files: [
-    'app.js', // <- app entry file
-    '!**/{.eslintignore,.eslintrc.cjs,.editorconfig,.prettierignore,.prettierrc.yaml,dev-app-update.yml,LICENSE,.nvmrc,.npmrc}',
-    '!**/{tsconfig.json,tsconfig.node.json,tsconfig.web.json}',
-    '!**/*debug*.*',
-    '!**/*.{md,zip,map}',
-    '!**/*.{c,cpp,h,hpp,cc,hh,cxx,hxx,gypi,gyp,sh}',
-    '!**/.{github,vscode}',
-    '!node_modules/**/better-sqlite3/deps/**',
-  ],
-  asarUnpack: [
-    '**/*.{node,dll}',
-  ],
-  directories: {
-    output: 'release',
-  },
-  extraResources: [
-    { from: `release/${target}`, to: target }, // <- asar file
-  ],
-  publish: null, // <- disable publish
-  // ...
-}
-```
-
-## Usage
-
-### use in main process
-
-To use electron's `net` module for updating, the `checkUpdate` and `download` functions must be called after the app is ready by default.
-
-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 { StartupWithUpdater, Updater } from 'electron-incremental-update'
-import { getEntryVersion, getProductAsarPath, getProductVersion } from 'electron-incremental-update'
-import { app } from 'electron'
-import { name } from '../../package.json'
-
-const startup: StartupWithUpdater = (updater: Updater) => {
-  await app.whenReady()
-  console.log('\ncurrent:')
-  console.log(`\tasar path: ${getProductAsarPath(name)}`)
-  console.log(`\tentry:     ${getEntryVersion()}`)
-  console.log(`\tapp:       ${getProductVersion(name)}`)
-  updater.onDownloading = ({ percent }) => {
-    console.log(percent)
-  }
-  updater.logger = console
-  updater.checkUpdate().then(async (result) => {
-    if (result === undefined) {
-      console.log('Update Unavailable')
-    } else if (result instanceof Error) {
-      console.error(result)
-    } else {
-      console.log('new version: ', result.version)
-      const { response } = await dialog.showMessageBox({
-        type: 'info',
-        buttons: ['Download', 'Later'],
-        message: 'Application update available!',
-      })
-      response === 0 && console.log(await updater.download())
-    }
-  })
-}
-export default startup
-```
-
-### use native modules
-
-```ts
-// db.ts
-import { requireNative } from 'electron-incremental-update'
-
-const Database = requireNative<typeof import('better-sqlite3')>('better-sqlite3')
-const db = new Database(':memory:')
-db.exec(
-  'DROP TABLE IF EXISTS employees; '
-    + 'CREATE TABLE IF NOT EXISTS employees (name TEXT, salary INTEGER)',
-)
-
-db.prepare('INSERT INTO employees VALUES (:n, :s)').run({
-  n: 'James',
-  s: 50000,
-})
-
-const r = db.prepare('SELECT * from employees').all()
-console.log(r)
-// [ { name: 'James', salary: 50000 } ]
-
-db.close()
-```
+## electron incremental updater
+
+This project provide a vite plugin, `Updater` class and some useful functions to generate incremental update.
+
+There will be two asar in production, `app.asar` and `main.asar` (if "main" is your app's name).
+
+The `app.asar` is used to load `main.asar` and initialize the `updater`. Also, all the **native modules**, which are set as `dependencies` in `package.json`, will be packaged into `app.asar` by `electron-builder`, [see usage](#use-native-modules).
+
+The new `main.asar` downloaded from remote will be verified by presigned RSA + Signature. When pass the check and restart, the old `main.asar` will be replaced by the new one. Hooks like `beforeDoUpdate` are provided.
+
+- inspired by Obsidian's update strategy
+
+### notice
+
+- this plugin is developed with [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron), and may be effect in other electron vite frameworks
+- **all options are documented in the jsdoc**
+
+## install
+
+### npm
+```bash
+npm install electron-incremental-update
+```
+### yarn
+```bash
+yarn add electron-incremental-update
+```
+### pnpm
+```bash
+pnpm add electron-incremental-update
+```
+
+## setup
+
+base on [electron-vite-vue](https://github.com/electron-vite/electron-vite-vue)
+
+```
+electron
+├── app.ts // <- add app entry file
+├── electron-env.d.ts
+├── main
+│   ├── db.ts
+│   ├── index.ts
+└── preload
+    └── index.ts
+src
+└── ...
+```
+
+### setup app
+
+```ts
+// electron/app.ts
+import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
+import { name, repository } from '../package.json'
+
+const SIGNATURE_CERT = '' // auto generate certificate when start app
+
+const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
+const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
+initApp({ onStart: console.log })
+  // can be updater option or function that return updater
+  .setUpdater({
+    SIGNATURE_CERT,
+    productName: name,
+    repository,
+    updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
+    releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+    receiveBeta: true
+  })
+```
+
+### setup vite.config.ts
+
+make sure the plugin is set in the **last** build task
+
+- for `vite-plugin-electron`, set it to `preload` (the second object in the plugin option array)
+
+```ts
+// vite.config.ts
+export default defineConfig(({ command }) => {
+
+  const isBuild = command === 'build'
+  // ...
+
+  return {
+    plugins: [
+      electron([
+        // main
+        {
+          // ...
+        },
+        // preload
+        {
+          // ...
+          vite: {
+            plugins: [
+              updater({
+                productName: pkg.name,
+                version: pkg.version,
+                isBuild,
+              }),
+            ],
+            // ...
+          }
+        },
+        // when using vite-plugin-electron-renderer
+        {
+          // ...
+        }
+      ]),
+      // ...
+    ],
+    // ...
+  }
+})
+```
+
+### modify package.json
+
+```json
+{
+  // ...
+  "main": "app.js" // <- app entry file
+}
+```
+
+### config electron-builder
+
+```js
+const { name } = require('./package.json')
+
+const target = `${name}.asar`
+/**
+ * @type {import('electron-builder').Configuration}
+ */
+module.exports = {
+  appId: 'YourAppID',
+  productName: name,
+  files: [
+    'app.js', // <- app entry file
+    '!**/{.eslintignore,.eslintrc.cjs,.editorconfig,.prettierignore,.prettierrc.yaml,dev-app-update.yml,LICENSE,.nvmrc,.npmrc}',
+    '!**/{tsconfig.json,tsconfig.node.json,tsconfig.web.json}',
+    '!**/*debug*.*',
+    '!**/*.{md,zip,map}',
+    '!**/*.{c,cpp,h,hpp,cc,hh,cxx,hxx,gypi,gyp,sh}',
+    '!**/.{github,vscode}',
+    '!node_modules/**/better-sqlite3/deps/**',
+  ],
+  asarUnpack: [
+    '**/*.{node,dll}',
+  ],
+  directories: {
+    output: 'release',
+  },
+  extraResources: [
+    { from: `release/${target}`, to: target }, // <- asar file
+  ],
+  publish: null, // <- disable publish
+  // ...
+}
+```
+
+## Usage
+
+### use in main process
+
+To use electron's `net` module for updating, the `checkUpdate` and `download` functions must be called after the app is ready by default.
+
+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 { StartupWithUpdater, Updater } from 'electron-incremental-update'
+import { getEntryVersion, getProductAsarPath, getProductVersion } from 'electron-incremental-update'
+import { app } from 'electron'
+import { name } from '../../package.json'
+
+const startup: StartupWithUpdater = (updater: Updater) => {
+  await app.whenReady()
+  console.log('\ncurrent:')
+  console.log(`\tasar path: ${getProductAsarPath(name)}`)
+  console.log(`\tentry:     ${getEntryVersion()}`)
+  console.log(`\tapp:       ${getProductVersion(name)}`)
+  updater.onDownloading = ({ percent }) => {
+    console.log(percent)
+  }
+  updater.logger = console
+  updater.checkUpdate().then(async (result) => {
+    if (result === undefined) {
+      console.log('Update Unavailable')
+    } else if (result instanceof Error) {
+      console.error(result)
+    } else {
+      console.log('new version: ', result.version)
+      const { response } = await dialog.showMessageBox({
+        type: 'info',
+        buttons: ['Download', 'Later'],
+        message: 'Application update available!',
+      })
+      response === 0 && console.log(await updater.download())
+    }
+  })
+}
+export default startup
+```
+
+### use native modules
+
+```ts
+// db.ts
+import { requireNative } from 'electron-incremental-update'
+
+const Database = requireNative<typeof import('better-sqlite3')>('better-sqlite3')
+const db = new Database(':memory:')
+db.exec(
+  'DROP TABLE IF EXISTS employees; '
+    + 'CREATE TABLE IF NOT EXISTS employees (name TEXT, salary INTEGER)',
+)
+
+db.prepare('INSERT INTO employees VALUES (:n, :s)').run({
+  n: 'James',
+  s: 50000,
+})
+
+const r = db.prepare('SELECT * from employees').all()
+console.log(r)
+// [ { name: 'James', salary: 50000 } ]
+
+db.close()
+```

package/dist/vite.js

@@ -200,7 +200,6 @@ var import_ci_info = require("ci-info");
 // src/build-plugins/key.ts
 var import_node_fs3 = require("fs");
 var import_node_path2 = require("path");
-var import_node_os = require("os");
 var import_selfsigned = require("selfsigned");
 function generateKeyPair(keyLength, subject, days, privateKeyPath, certPath) {
   const privateKeyDir = (0, import_node_path2.dirname)(privateKeyPath);
@@ -217,15 +216,18 @@ function generateKeyPair(keyLength, subject, days, privateKeyPath, certPath) {
 }
 function writeCertToMain(entryPath, cert) {
   const file = (0, import_node_fs3.readFileSync)(entryPath, "utf-8");
-  const regex = /const SIGNATURE_CERT\s*=\s*['"`][\s\S]*?['"`]/;
-  const replacement = `const SIGNATURE_CERT = \`${cert}\``;
+  const initRegex = /(?<=const SIGNATURE_CERT\s*=\s*)['"]{2}/m;
+  const existRegex = /(?<=const SIGNATURE_CERT\s*=\s*)(['"]-----BEGIN CERTIFICATE-----[\s\S]*-----END CERTIFICATE-----\\n['"])/m;
+  const eol = file.includes("\r") ? "\r\n" : "\n";
+  const replacement = cert.split("\n").filter(Boolean).map((s) => `'${s}\\n'`).join(`${eol}+ `);
   let replaced = file;
-  const signaturePubExists = regex.test(file);
-  if (signaturePubExists) {
-    replaced = file.replace(regex, replacement);
+  if (initRegex.test(file)) {
+    replaced = file.replace(initRegex, replacement);
+  } else if (existRegex.test(file)) {
+    replaced = file.replace(existRegex, replacement);
   } else {
-    const lines = file.split(import_node_os.EOL);
-    const r = `${import_node_os.EOL}${replacement}${import_node_os.EOL}`;
+    const lines = file.split(eol);
+    const r = `${eol}const SIGNATURE_CERT = ${replacement}${eol}`;
     let isMatched = false;
     for (let i = 0; i < lines.length; i++) {
       const line = lines[i];
@@ -236,9 +238,10 @@ function writeCertToMain(entryPath, cert) {
       }
     }
     !isMatched && lines.push(r);
-    replaced = lines.join(import_node_os.EOL);
+    replaced = lines.join(eol);
   }
-  (0, import_node_fs3.writeFileSync)(entryPath, replaced.replace(/\r\n?/g, "\n"));
+  console.log(JSON.stringify(replaced));
+  (0, import_node_fs3.writeFileSync)(entryPath, replaced);
 }
 function parseKeys({
   keyLength,

package/dist/vite.mjs

@@ -103,7 +103,6 @@ import { isCI } from "ci-info";
 // src/build-plugins/key.ts
 import { existsSync as existsSync2, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname } from "node:path";
-import { EOL } from "node:os";
 import { generate } from "selfsigned";
 function generateKeyPair(keyLength, subject, days, privateKeyPath, certPath) {
   const privateKeyDir = dirname(privateKeyPath);
@@ -120,15 +119,18 @@ function generateKeyPair(keyLength, subject, days, privateKeyPath, certPath) {
 }
 function writeCertToMain(entryPath, cert) {
   const file = readFileSync(entryPath, "utf-8");
-  const regex = /const SIGNATURE_CERT\s*=\s*['"`][\s\S]*?['"`]/;
-  const replacement = `const SIGNATURE_CERT = \`${cert}\``;
+  const initRegex = /(?<=const SIGNATURE_CERT\s*=\s*)['"]{2}/m;
+  const existRegex = /(?<=const SIGNATURE_CERT\s*=\s*)(['"]-----BEGIN CERTIFICATE-----[\s\S]*-----END CERTIFICATE-----\\n['"])/m;
+  const eol = file.includes("\r") ? "\r\n" : "\n";
+  const replacement = cert.split("\n").filter(Boolean).map((s) => `'${s}\\n'`).join(`${eol}+ `);
   let replaced = file;
-  const signaturePubExists = regex.test(file);
-  if (signaturePubExists) {
-    replaced = file.replace(regex, replacement);
+  if (initRegex.test(file)) {
+    replaced = file.replace(initRegex, replacement);
+  } else if (existRegex.test(file)) {
+    replaced = file.replace(existRegex, replacement);
   } else {
-    const lines = file.split(EOL);
-    const r = `${EOL}${replacement}${EOL}`;
+    const lines = file.split(eol);
+    const r = `${eol}const SIGNATURE_CERT = ${replacement}${eol}`;
     let isMatched = false;
     for (let i = 0; i < lines.length; i++) {
       const line = lines[i];
@@ -139,9 +141,10 @@ function writeCertToMain(entryPath, cert) {
       }
     }
     !isMatched && lines.push(r);
-    replaced = lines.join(EOL);
+    replaced = lines.join(eol);
   }
-  writeFileSync(entryPath, replaced.replace(/\r\n?/g, "\n"));
+  console.log(JSON.stringify(replaced));
+  writeFileSync(entryPath, replaced);
 }
 function parseKeys({
   keyLength,

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "electron-incremental-update",
   "author": "subframe7536",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup && node fix-module.js",
     "release": "pnpm test && pnpm run build && bumpp --all && npm publish",
-    "test": "vitest --run"
+    "test": "vitest --run",
+    "lint": "eslint . --fix"
   },
   "publishConfig": {
     "access": "public",
@@ -43,14 +44,14 @@
     "updater"
   ],
   "devDependencies": {
-    "@subframe7536/eslint-config": "^0.2.5",
-    "@types/node": "^20.5.1",
-    "bumpp": "^9.1.1",
-    "electron": "^26.0.0",
-    "eslint": "^8.47.0",
+    "@subframe7536/eslint-config": "^0.2.9",
+    "@types/node": "^20.6.0",
+    "bumpp": "^9.2.0",
+    "electron": "^26.2.0",
+    "eslint": "^8.49.0",
     "tsup": "^7.2.0",
-    "typescript": "^5.1.6",
-    "vitest": "^0.34.2"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.4"
   },
   "dependencies": {
     "@electron/asar": "^3.2.4",