electron-incremental-update 1.0.3 → 1.2.0

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "electron-incremental-update",
-  "version": "1.0.3",
+  "type": "module",
+  "version": "1.2.0",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",
@@ -8,24 +9,24 @@
   "keywords": [
     "electron",
     "incremental update",
-    "updater"
+    "updater",
+    "bytecode"
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     },
     "./vite": {
-      "import": "./dist/vite.mjs",
-      "require": "./dist/vite.js"
+      "import": "./dist/vite.js"
     },
     "./utils": {
-      "import": "./dist/utils.mjs",
-      "require": "./dist/utils.js"
+      "import": "./dist/utils.js",
+      "require": "./dist/utils.cjs"
     }
   },
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "files": [
     "dist",
     "utils.d.ts",
@@ -35,39 +36,40 @@
   ],
   "scripts": {
     "dev": "tsup --watch",
-    "build": "tsup && node fix-module.js",
+    "build": "tsup && esno fix-module.cjs",
     "release": "pnpm test && pnpm run build && bumpp --all && npm publish",
     "test": "vitest --run",
-    "lint": "eslint . --fix"
+    "format": "eslint . --fix"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "peerDependencies": {
+    "@babel/core": "^7.24.7",
+    "@babel/plugin-transform-arrow-functions": "^7.24.7",
+    "@electron/asar": "*",
     "esbuild": "*",
+    "magic-string": "*",
     "vite-plugin-electron": "^0.15.6 || ^0.28"
   },
   "dependencies": {
-    "@electron/asar": "^3.2.9",
     "@subframe7536/type-utils": "^0.1.6",
+    "local-pkg": "^0.5.0",
     "selfsigned": "^2.4.1"
   },
   "devDependencies": {
-    "@subframe7536/eslint-config": "^0.6.0",
-    "@types/node": "^20.12.5",
-    "bumpp": "^9.4.0",
-    "electron": "28.1.1",
-    "eslint": "^8.57.0",
-    "tsup": "^8.0.2",
-    "typescript": "^5.4.4",
-    "vite": "^5.2.8",
-    "vite-plugin-electron": "^0.28.4",
-    "vitest": "^1.4.0"
-  },
-  "pnpm": {
-    "overrides": {
-      "has": "npm:@nolyfill/has@latest"
-    }
+    "@subframe7536/eslint-config": "^0.6.6",
+    "@types/babel__core": "^7.20.5",
+    "@types/node": "^20.14.7",
+    "bumpp": "^9.4.1",
+    "electron": "28.2.10",
+    "eslint": "^9.5.0",
+    "esno": "^4.7.0",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.2",
+    "vite": "^5.3.1",
+    "vite-plugin-electron": "^0.28.7",
+    "vitest": "^1.6.0"
   }
 }

package/utils.js

@@ -1 +1 @@
-module.exports = require('./dist/utils.js')
+module.exports = require('./dist/utils.cjs')

package/dist/chunk-GB6VLKJZ.mjs

@@ -1,95 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/utils/zip.ts
-import { existsSync, readFileSync, rmSync, writeFileSync } from "node:fs";
-import { gunzip, gzip } from "node:zlib";
-async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
-  if (!existsSync(gzipPath)) {
-    throw new Error(`path to zipped file not exist: ${gzipPath}`);
-  }
-  const compressedBuffer = readFileSync(gzipPath);
-  return new Promise((resolve, reject) => {
-    gunzip(compressedBuffer, (err, buffer) => {
-      rmSync(gzipPath);
-      if (err) {
-        reject(err);
-      }
-      writeFileSync(targetFilePath, buffer);
-      resolve(null);
-    });
-  });
-}
-async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
-  if (!existsSync(filePath)) {
-    throw new Error(`path to be zipped not exist: ${filePath}`);
-  }
-  const buffer = readFileSync(filePath);
-  return new Promise((resolve, reject) => {
-    gzip(buffer, (err, buffer2) => {
-      if (err) {
-        reject(err);
-      }
-      writeFileSync(targetFilePath, buffer2);
-      resolve(null);
-    });
-  });
-}
-
-// src/utils/noDep.ts
-function parseGithubCdnURL(originRepoURL, cdnPrefix, relativeFilePath) {
-  if (!originRepoURL.startsWith("https://github.com/")) {
-    throw new Error("origin url must start with https://github.com/");
-  }
-  originRepoURL = originRepoURL.trim().replace(/\/?$/, "/").trim();
-  relativeFilePath = relativeFilePath.trim().replace(/^\/|\/?$/g, "").trim();
-  cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
-  return originRepoURL.replace("github.com", cdnPrefix) + relativeFilePath;
-}
-function handleUnexpectedErrors(callback) {
-  process.on("uncaughtException", callback);
-  process.on("unhandledRejection", callback);
-}
-function parseVersion(version) {
-  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-zA-Z0-9\.-]+))?/i;
-  const match = semver.exec(version);
-  if (!match) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  const [major, minor, patch] = match.slice(1, 4).map(Number);
-  const ret = {
-    major,
-    minor,
-    patch,
-    stage: "",
-    stageVersion: -1
-  };
-  if (match[4]) {
-    let [stage, _v] = match[4].split(".");
-    ret.stage = stage;
-    ret.stageVersion = Number(_v) || -1;
-  }
-  if (Number.isNaN(major) || Number.isNaN(minor) || Number.isNaN(patch) || Number.isNaN(ret.stageVersion)) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  return ret;
-}
-function isUpdateJSON(json) {
-  const is = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
-  return is(json) && is(json?.beta);
-}
-
-export {
-  __require,
-  unzipFile,
-  zipFile,
-  parseGithubCdnURL,
-  handleUnexpectedErrors,
-  parseVersion,
-  isUpdateJSON
-};

package/dist/chunk-GXZSAUBR.mjs

@@ -1,36 +0,0 @@
-// src/crypto.ts
-import { createCipheriv, createDecipheriv, createHash, createPrivateKey, createSign, createVerify } from "node:crypto";
-function encrypt(plainText, key2, iv) {
-  const cipher = createCipheriv("aes-256-cbc", key2, iv);
-  let encrypted = cipher.update(plainText, "utf8", "base64url");
-  encrypted += cipher.final("base64url");
-  return encrypted;
-}
-function decrypt(encryptedText, key2, iv) {
-  const decipher = createDecipheriv("aes-256-cbc", key2, iv);
-  let decrypted = decipher.update(encryptedText, "base64url", "utf8");
-  decrypted += decipher.final("utf8");
-  return decrypted;
-}
-function key(data, length) {
-  const hash = createHash("SHA256").update(data).digest("binary");
-  return Buffer.from(hash).subarray(0, length);
-}
-var signature = (buffer, privateKey, cert, version) => {
-  const sig = createSign("RSA-SHA256").update(buffer).sign(createPrivateKey(privateKey), "base64");
-  return encrypt(`${sig}%${version}`, key(cert, 32), key(buffer, 16));
-};
-var verify = (buffer, signature2, cert) => {
-  try {
-    const [sig, version] = decrypt(signature2, key(cert, 32), key(buffer, 16)).split("%");
-    const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : false;
-  } catch (error) {
-    return false;
-  }
-};
-
-export {
-  signature,
-  verify
-};

package/dist/utils.mjs

@@ -1,40 +0,0 @@
-import {
-  disableHWAccForWin7,
-  getPathFromAppNameAsar,
-  getPaths,
-  getVersions,
-  is,
-  loadNativeModuleFromEntry,
-  restartApp,
-  setAppUserModelId,
-  setPortableAppDataPath,
-  singleInstance,
-  waitAppReady
-} from "./chunk-OUZLSVQC.mjs";
-import {
-  handleUnexpectedErrors,
-  isUpdateJSON,
-  parseGithubCdnURL,
-  parseVersion,
-  unzipFile,
-  zipFile
-} from "./chunk-GB6VLKJZ.mjs";
-export {
-  disableHWAccForWin7,
-  getPathFromAppNameAsar,
-  getPaths,
-  getVersions,
-  handleUnexpectedErrors,
-  is,
-  isUpdateJSON,
-  loadNativeModuleFromEntry,
-  parseGithubCdnURL,
-  parseVersion,
-  restartApp,
-  setAppUserModelId,
-  setPortableAppDataPath,
-  singleInstance,
-  unzipFile,
-  waitAppReady,
-  zipFile
-};

package/dist/vite.d.mts

@@ -1,329 +0,0 @@
-import * as vite from 'vite';
-import { Plugin } from 'vite';
-import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
-import { Promisable } from '@subframe7536/type-utils';
-import { BuildOptions } from 'esbuild';
-import { a as UpdateJSON } from './noDep-TvZoKVF8.mjs';
-
-type PKG = {
-    name: string;
-    version: string;
-    main: string;
-};
-type DistinguishedName = {
-    countryName?: string;
-    stateOrProvinceName?: string;
-    localityName?: string;
-    organizationName?: string;
-    organizationalUnitName?: string;
-    commonName?: string;
-    serialNumber?: string;
-    title?: string;
-    description?: string;
-    businessCategory?: string;
-    emailAddress?: string;
-};
-type BuildEntryOption = {
-    /**
-     * whether to minify
-     * @default isBuild
-     */
-    minify?: boolean;
-    /**
-     * whether to generate sourcemap
-     * @default isBuild
-     */
-    sourcemap?: boolean;
-    /**
-     * path to app entry output file
-     * @default 'dist-entry'
-     */
-    entryOutputDirPath?: string;
-    /**
-     * path to app entry file
-     * @default 'electron/entry.ts'
-     */
-    appEntryPath?: string;
-    /**
-     * esbuild path map of native modules in entry directory
-     *
-     * @default {}
-     * @example
-     * { db: './electron/native/db.ts' }
-     */
-    nativeModuleEntryMap?: Record<string, string>;
-    /**
-     * custom options for esbuild
-     * ```ts
-     * // default options
-     * const options = {
-     *   entryPoints: {
-     *     entry: appEntryPath,
-     *     ...moduleEntryMap,
-     *   },
-     *   bundle: true,
-     *   platform: 'node',
-     *   outdir: entryOutputDirPath,
-     *   minify,
-     *   sourcemap,
-     *   entryNames: '[dir]/[name]',
-     *   assetNames: '[dir]/[name]',
-     *   external: ['electron', 'original-fs'],
-     *   loader: {
-     *     '.node': 'empty',
-     *   },
-     * }
-     * ```
-     */
-    overrideEsbuildOptions?: BuildOptions;
-    /**
-     * resolve extra files on startup, such as `.node`
-     * @remark won't trigger will reload
-     */
-    postBuild?: (args: {
-        /**
-         * get path from `entryOutputDirPath`
-         */
-        getPathFromEntryOutputDir: (...paths: string[]) => string;
-        /**
-         * copy file to `entryOutputDirPath`
-         *
-         * if `to` absent, set to `basename(from)`
-         *
-         * if `skipIfExist` absent, skip copy if `to` exist
-         */
-        existsAndCopyToEntryOutputDir: (options: {
-            from: string;
-            to?: string;
-            /**
-             * skip copy if `to` exist
-             * @default true
-             */
-            skipIfExist?: boolean;
-        }) => void;
-    }) => Promisable<void>;
-};
-type GeneratorOverrideFunctions = {
-    /**
-     * custom signature generate function
-     * @param buffer file buffer
-     * @param privateKey private key
-     * @param cert certificate string, **EOL must be '\n'**
-     * @param version current version
-     */
-    generateSignature?: (buffer: Buffer, privateKey: string, cert: string, version: string) => string | Promise<string>;
-    /**
-     * custom generate version json function
-     * @param existingJson The existing JSON object.
-     * @param buffer file buffer
-     * @param signature generated signature
-     * @param version current version
-     * @param minVersion The minimum version
-     * @returns The updated version json
-     */
-    generateVersionJson?: (existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minVersion: string) => UpdateJSON | Promise<UpdateJSON>;
-};
-type ElectronUpdaterOptions = {
-    /**
-     * mini version of entry
-     * @default '0.0.0'
-     */
-    minimumVersion?: string;
-    /**
-     * config for entry (app.asar)
-     */
-    entry?: BuildEntryOption;
-    /**
-     * paths config
-     */
-    paths?: {
-        /**
-         * Path to asar file
-         * @default `release/${app.name}.asar`
-         */
-        asarOutputPath?: string;
-        /**
-         * Path to version info output, content is {@link UpdateJSON}
-         * @default `version.json`
-         */
-        versionPath?: string;
-        /**
-         * Path to gzipped asar file
-         * @default `release/${app.name}-${version}.asar.gz`
-         */
-        gzipPath?: string;
-        /**
-         * Path to electron build output
-         * @default `dist-electron`
-         */
-        electronDistPath?: string;
-        /**
-         * Path to renderer build output
-         * @default `dist`
-         */
-        rendererDistPath?: string;
-    };
-    /**
-     * signature config
-     */
-    keys?: {
-        /**
-         * path to the pem file that contains private key
-         * if not ended with .pem, it will be appended
-         *
-         * **if `UPDATER_PK` is set, will read it instead of read from `privateKeyPath`**
-         * @default 'keys/private.pem'
-         */
-        privateKeyPath?: string;
-        /**
-         * path to the pem file that contains public key
-         * if not ended with .pem, it will be appended
-         *
-         * **if `UPDATER_CERT` is set, will read it instead of read from `certPath`**
-         * @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: `${app.name}`, organizationName: `org.${app.name}` }
-             */
-            subject?: DistinguishedName;
-            /**
-             * expire days of the certificate
-             *
-             * @default 3650
-             */
-            days?: number;
-        };
-        overrideGenerator?: GeneratorOverrideFunctions;
-    };
-};
-
-type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
-    [P in K]-?: T[P];
-};
-type ReplaceKey<T, Key extends keyof T, NewKey extends string> = Omit<T, Key> & {
-    [P in NewKey]: T[Key];
-};
-type MakeRequiredAndReplaceKey<T, K extends keyof T, NewKey extends string> = MakeRequired<ReplaceKey<T, K, NewKey>, NewKey>;
-/**
- * startup function for debug (see {@link https://github.com/electron-vite/electron-vite-vue/blob/main/vite.config.ts electron-vite-vue template})
- * @example
- * import { debugStartup, buildElectronPluginOptions } from 'electron-incremental-update/vite'
- * const options = buildElectronPluginOptions({
- *   // ...
- *   main: {
- *     // ...
- *     startup: debugStartup
- *   },
- * })
- */
-declare function debugStartup(args: {
-    startup: (argv?: string[]) => Promise<void>;
-    reload: () => void;
-}): void;
-type ElectronWithUpdaterOptions = {
-    /**
-     * whether is in build mode
-     * ```ts
-     * export default defineConfig(({ command }) => {
-     *   const isBuild = command === 'build'
-     * })
-     * ```
-     */
-    isBuild: boolean;
-    /**
-     * name, version and main in `package.json`
-     * ```ts
-     * import pkg from './package.json'
-     * ```
-     */
-    pkg: PKG;
-    /**
-     * main options
-     */
-    main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'>;
-    /**
-     * preload options
-     */
-    preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'>;
-    /**
-     * updater options
-     */
-    updater?: ElectronUpdaterOptions;
-    /**
-     * use NotBundle() plugin in main
-     * @default true
-     */
-    useNotBundle?: boolean;
-    /**
-     * Whether to log parsed options
-     */
-    logParsedOptions?: boolean;
-};
-declare const log: vite.Logger;
-/**
- * build options for `vite-plugin-electron/simple`
- * - integrate with updater
- * - only contains `main` and `preload` configs
- * - remove old electron files
- * - externalize dependencies
- * - auto restart when entry file changes
- * - other configs in {@link https://github.com/electron-vite/electron-vite-vue/blob/main/vite.config.ts electron-vite-vue template}
- * - no `vite-plugin-electron-renderer` config
- *
- * you can override all the configs
- *
- * **Limitation**: entry file change cannot trigger auto restart
- *
- * @example
- * import { defineConfig } from 'vite'
- * import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
- * import pkg from './package.json'
- *
- * export default defineConfig(async ({ command }) => {
- *   const isBuild = command === 'build'
- *   return {
- *     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,
- *       }
- *     })(),
- *   }
- * })
- */
-declare function electronWithUpdater(options: ElectronWithUpdaterOptions): (Plugin<any> | Promise<Plugin<any>[]> | undefined)[];
-
-export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater, log };