electron-incremental-update 0.8.9 → 0.9.0

package/README.md

@@ -175,7 +175,7 @@ However, you have the option to customize the download function when creating th
 ```ts
 // electron/main/index.ts
 import type { StartupWithUpdater, Updater } from 'electron-incremental-update'
-import { appInfo, getProductAsarPath } from 'electron-incremental-update/utils'
+import { appInfo, getAppVersion, getElectronVersion, getProductAsarPath } from 'electron-incremental-update/utils'
 import { app } from 'electron'
 import { name } from '../../package.json'
 
@@ -183,8 +183,8 @@ const startup: StartupWithUpdater = (updater: Updater) => {
   await app.whenReady()
   console.log('\ncurrent:')
   console.log(`\tasar path: ${getProductAsarPath(name)}`)
-  console.log(`\tapp:       ${appInfo.appVersion(name)}`)
-  console.log(`\telectron:  ${appInfo.electronVersion}`)
+  console.log(`\tapp:       ${getAppVersion(name)}`)
+  console.log(`\telectron:  ${getElectronVersion()}`)
   updater.onDownloading = ({ percent }) => {
     console.log(percent)
   }

package/dist/{chunk-6V5SXFGA.mjs → chunk-6UZHBPFT.mjs}

@@ -5,15 +5,13 @@ import {
 // src/utils/core.ts
 import { readFileSync } from "node:fs";
 import { dirname, join } from "node:path";
-import { release } from "node:os";
 import { app } from "electron";
 var DEFAULT_APP_NAME = "product";
-var appInfo = {
+var is = {
   dev: !app.isPackaged,
   win: process.platform === "win32",
   mac: process.platform === "darwin",
-  linux: process.platform === "linux",
-  systemVersion: release()
+  linux: process.platform === "linux"
 };
 function getLocale() {
   return app.isReady() ? app.getLocale() : void 0;
@@ -47,6 +45,8 @@ function requireNative(packageName) {
 }
 
 // src/utils/utils.ts
+import { dirname as dirname2, join as join2 } from "node:path";
+import { existsSync, mkdirSync } from "node:fs";
 import { app as app2 } from "electron";
 function parseGithubCdnURL(originRepoURL, cdnPrefix, relativeFilePath) {
   if (!originRepoURL.startsWith("https://github.com/")) {
@@ -61,6 +61,23 @@ function restartApp() {
   app2.relaunch();
   app2.quit();
 }
+function setAppUserModelId(id) {
+  is.win && app2.setAppUserModelId(is.dev ? process.execPath : id);
+}
+function setPortableAppDataPath(dirName = "data", create) {
+  if (!is.win) {
+    return;
+  }
+  const portablePath = join2(dirname2(app2.getPath("exe")), dirName);
+  let exists = existsSync(portablePath);
+  if (create && !exists) {
+    mkdirSync(portablePath);
+    exists = true;
+  }
+  if (exists) {
+    app2.setPath("appData", portablePath);
+  }
+}
 function waitAppReady(timeout = 1e3) {
   return app2.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
     const _ = setTimeout(() => {
@@ -79,7 +96,7 @@ function handleUnexpectedErrors(callback) {
 
 export {
   DEFAULT_APP_NAME,
-  appInfo,
+  is,
   getLocale,
   getProductAsarPath,
   getElectronVersion,
@@ -89,6 +106,8 @@ export {
   requireNative,
   parseGithubCdnURL,
   restartApp,
+  setAppUserModelId,
+  setPortableAppDataPath,
   waitAppReady,
   handleUnexpectedErrors
 };

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { U as UpdateJSON } from './updateJson-synsK-Pt.mjs';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -260,4 +260,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, IncrementalUpdater, StartupWithUpdater, Updater, UpdaterOption, createUpdater, initApp };
+export { type AppOption, IncrementalUpdater, type StartupWithUpdater, type Updater, type UpdaterOption, createUpdater, initApp };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { U as UpdateJSON } from './updateJson-synsK-Pt.js';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -260,4 +260,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, IncrementalUpdater, StartupWithUpdater, Updater, UpdaterOption, createUpdater, initApp };
+export { type AppOption, IncrementalUpdater, type StartupWithUpdater, type Updater, type UpdaterOption, createUpdater, initApp };

package/dist/index.js

@@ -25,26 +25,24 @@ __export(src_exports, {
   initApp: () => initApp
 });
 module.exports = __toCommonJS(src_exports);
-var import_node_path2 = require("path");
-var import_node_fs4 = require("fs");
+var import_node_path3 = require("path");
+var import_node_fs5 = require("fs");
 var import_electron4 = require("electron");
 
 // src/updater/index.ts
-var import_node_fs3 = require("fs");
+var import_node_fs4 = require("fs");
 var import_promises = require("fs/promises");
 
 // src/utils/core.ts
 var import_node_fs = require("fs");
 var import_node_path = require("path");
-var import_node_os = require("os");
 var import_electron = require("electron");
 var DEFAULT_APP_NAME = "product";
-var appInfo = {
+var is = {
   dev: !import_electron.app.isPackaged,
   win: process.platform === "win32",
   mac: process.platform === "darwin",
-  linux: process.platform === "linux",
-  systemVersion: (0, import_node_os.release)()
+  linux: process.platform === "linux"
 };
 function getProductAsarPath(name = DEFAULT_APP_NAME) {
   return !import_electron.app.isPackaged ? (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${name}.asar`) : "DEV.asar";
@@ -103,6 +101,8 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
 }
 
 // src/utils/utils.ts
+var import_node_path2 = require("path");
+var import_node_fs3 = require("fs");
 var import_electron2 = require("electron");
 function waitAppReady(timeout = 1e3) {
   return import_electron2.app.isReady() ? Promise.resolve() : new Promise((resolve2, reject) => {
@@ -140,8 +140,8 @@ var verify = (buffer, signature, cert) => {
 
 // src/updateJson.ts
 function isUpdateJSON(json) {
-  const is = (j) => "signature" in j && "version" in j && "size" in j && "minimumVersion" in j;
-  return is(json) && "beta" in json && is(json.beta);
+  const is2 = (j) => "signature" in j && "version" in j && "size" in j && "minimumVersion" in j;
+  return is2(json) && "beta" in json && is2(json.beta);
 }
 
 // src/updater/types.ts
@@ -295,11 +295,11 @@ var IncrementalUpdater = class {
     return await compare(productVersion, version);
   }
   async parseData(format, data) {
-    if ((0, import_node_fs3.existsSync)(this.tmpFilePath)) {
+    if ((0, import_node_fs4.existsSync)(this.tmpFilePath)) {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
       await (0, import_promises.rm)(this.tmpFilePath);
     }
-    if ((0, import_node_fs3.existsSync)(this.gzipPath)) {
+    if ((0, import_node_fs4.existsSync)(this.gzipPath)) {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
       await (0, import_promises.rm)(this.gzipPath);
     }
@@ -429,12 +429,12 @@ function initApp(appOptions) {
     try {
       const asarPath = getProductAsarPath(updater.productName);
       const updateAsarPath = `${asarPath}.tmp`;
-      if ((0, import_node_fs4.existsSync)(updateAsarPath)) {
+      if ((0, import_node_fs5.existsSync)(updateAsarPath)) {
         await beforeDoUpdate?.(asarPath, updateAsarPath);
-        (0, import_node_fs4.renameSync)(updateAsarPath, asarPath);
+        (0, import_node_fs5.renameSync)(updateAsarPath, asarPath);
       }
       const mainDir = import_electron4.app.isPackaged ? asarPath : electronDevDistPath;
-      const entry = (0, import_node_path2.resolve)(__dirname, mainDir, mainPath);
+      const entry = (0, import_node_path3.resolve)(__dirname, mainDir, mainPath);
       await beforeStart?.(entry);
       require(entry)(updater);
     } catch (error) {

package/dist/index.mjs

@@ -8,7 +8,7 @@ import {
   getElectronVersion,
   getProductAsarPath,
   waitAppReady
-} from "./chunk-6V5SXFGA.mjs";
+} from "./chunk-6UZHBPFT.mjs";
 import {
   __require,
   parseVersion,

package/dist/{updateJson-7e45d9e1.d.ts → updateJson-synsK-Pt.d.mts}

@@ -8,4 +8,4 @@ type UpdateJSON = UpdateInfo & {
     beta: UpdateInfo;
 };
 
-export { UpdateJSON as U };
+export type { UpdateJSON as U };

package/dist/updateJson-synsK-Pt.d.ts

@@ -0,0 +1,11 @@
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+
+export type { UpdateJSON as U };

package/dist/utils.d.mts

@@ -1,18 +1,14 @@
 declare const DEFAULT_APP_NAME = "product";
-type Info = {
+type Is = {
     dev: boolean;
     win: boolean;
     mac: boolean;
     linux: boolean;
-    /**
-     * `os.release()`
-     */
-    systemVersion: string;
 };
 /**
  * get app info
  */
-declare const appInfo: Info;
+declare const is: Is;
 declare function getLocale(): string | undefined;
 /**
  * get the application asar absolute path (not `app.asar`),
@@ -64,6 +60,15 @@ declare function parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, rel
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
+/**
+ * fix app use model id, only for Windows
+ * @param id app id
+ */
+declare function setAppUserModelId(id: string): void;
+/**
+ * set AppData dir for portable Windows app
+ */
+declare function setPortableAppDataPath(dirName?: string, create?: boolean): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
@@ -75,4 +80,4 @@ declare function waitAppReady(timeout?: number): Promise<void>;
  */
 declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, Version, appInfo, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, unzipFile, waitAppReady, zipFile };
+export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, unzipFile, waitAppReady, zipFile };

package/dist/utils.d.ts

@@ -1,18 +1,14 @@
 declare const DEFAULT_APP_NAME = "product";
-type Info = {
+type Is = {
     dev: boolean;
     win: boolean;
     mac: boolean;
     linux: boolean;
-    /**
-     * `os.release()`
-     */
-    systemVersion: string;
 };
 /**
  * get app info
  */
-declare const appInfo: Info;
+declare const is: Is;
 declare function getLocale(): string | undefined;
 /**
  * get the application asar absolute path (not `app.asar`),
@@ -64,6 +60,15 @@ declare function parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, rel
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
+/**
+ * fix app use model id, only for Windows
+ * @param id app id
+ */
+declare function setAppUserModelId(id: string): void;
+/**
+ * set AppData dir for portable Windows app
+ */
+declare function setPortableAppDataPath(dirName?: string, create?: boolean): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
@@ -75,4 +80,4 @@ declare function waitAppReady(timeout?: number): Promise<void>;
  */
 declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, Version, appInfo, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, unzipFile, waitAppReady, zipFile };
+export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, unzipFile, waitAppReady, zipFile };

package/dist/utils.js

@@ -22,17 +22,19 @@ var utils_exports = {};
 __export(utils_exports, {
   DEFAULT_APP_NAME: () => DEFAULT_APP_NAME,
   NoSuchNativeModuleError: () => NoSuchNativeModuleError,
-  appInfo: () => appInfo,
   getAppVersion: () => getAppVersion,
   getElectronVersion: () => getElectronVersion,
   getLocale: () => getLocale,
   getProductAsarPath: () => getProductAsarPath,
   handleUnexpectedErrors: () => handleUnexpectedErrors,
+  is: () => is,
   isNoSuchNativeModuleError: () => isNoSuchNativeModuleError,
   parseGithubCdnURL: () => parseGithubCdnURL,
   parseVersion: () => parseVersion,
   requireNative: () => requireNative,
   restartApp: () => restartApp,
+  setAppUserModelId: () => setAppUserModelId,
+  setPortableAppDataPath: () => setPortableAppDataPath,
   unzipFile: () => unzipFile,
   waitAppReady: () => waitAppReady,
   zipFile: () => zipFile
@@ -42,15 +44,13 @@ module.exports = __toCommonJS(utils_exports);
 // src/utils/core.ts
 var import_node_fs = require("fs");
 var import_node_path = require("path");
-var import_node_os = require("os");
 var import_electron = require("electron");
 var DEFAULT_APP_NAME = "product";
-var appInfo = {
+var is = {
   dev: !import_electron.app.isPackaged,
   win: process.platform === "win32",
   mac: process.platform === "darwin",
-  linux: process.platform === "linux",
-  systemVersion: (0, import_node_os.release)()
+  linux: process.platform === "linux"
 };
 function getLocale() {
   return import_electron.app.isReady() ? import_electron.app.getLocale() : void 0;
@@ -145,6 +145,8 @@ async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
 }
 
 // src/utils/utils.ts
+var import_node_path2 = require("path");
+var import_node_fs3 = require("fs");
 var import_electron2 = require("electron");
 function parseGithubCdnURL(originRepoURL, cdnPrefix, relativeFilePath) {
   if (!originRepoURL.startsWith("https://github.com/")) {
@@ -159,6 +161,23 @@ function restartApp() {
   import_electron2.app.relaunch();
   import_electron2.app.quit();
 }
+function setAppUserModelId(id) {
+  is.win && import_electron2.app.setAppUserModelId(is.dev ? process.execPath : id);
+}
+function setPortableAppDataPath(dirName = "data", create) {
+  if (!is.win) {
+    return;
+  }
+  const portablePath = (0, import_node_path2.join)((0, import_node_path2.dirname)(import_electron2.app.getPath("exe")), dirName);
+  let exists = (0, import_node_fs3.existsSync)(portablePath);
+  if (create && !exists) {
+    (0, import_node_fs3.mkdirSync)(portablePath);
+    exists = true;
+  }
+  if (exists) {
+    import_electron2.app.setPath("appData", portablePath);
+  }
+}
 function waitAppReady(timeout = 1e3) {
   return import_electron2.app.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
     const _ = setTimeout(() => {
@@ -178,17 +197,19 @@ function handleUnexpectedErrors(callback) {
 0 && (module.exports = {
   DEFAULT_APP_NAME,
   NoSuchNativeModuleError,
-  appInfo,
   getAppVersion,
   getElectronVersion,
   getLocale,
   getProductAsarPath,
   handleUnexpectedErrors,
+  is,
   isNoSuchNativeModuleError,
   parseGithubCdnURL,
   parseVersion,
   requireNative,
   restartApp,
+  setAppUserModelId,
+  setPortableAppDataPath,
   unzipFile,
   waitAppReady,
   zipFile

package/dist/utils.mjs

@@ -1,18 +1,20 @@
 import {
   DEFAULT_APP_NAME,
   NoSuchNativeModuleError,
-  appInfo,
   getAppVersion,
   getElectronVersion,
   getLocale,
   getProductAsarPath,
   handleUnexpectedErrors,
+  is,
   isNoSuchNativeModuleError,
   parseGithubCdnURL,
   requireNative,
   restartApp,
+  setAppUserModelId,
+  setPortableAppDataPath,
   waitAppReady
-} from "./chunk-6V5SXFGA.mjs";
+} from "./chunk-6UZHBPFT.mjs";
 import {
   parseVersion,
   unzipFile,
@@ -21,17 +23,19 @@ import {
 export {
   DEFAULT_APP_NAME,
   NoSuchNativeModuleError,
-  appInfo,
   getAppVersion,
   getElectronVersion,
   getLocale,
   getProductAsarPath,
   handleUnexpectedErrors,
+  is,
   isNoSuchNativeModuleError,
   parseGithubCdnURL,
   parseVersion,
   requireNative,
   restartApp,
+  setAppUserModelId,
+  setPortableAppDataPath,
   unzipFile,
   waitAppReady,
   zipFile

package/dist/vite.d.mts

@@ -1,5 +1,5 @@
 import { Plugin } from 'vite';
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { U as UpdateJSON } from './updateJson-synsK-Pt.mjs';
 
 type DistinguishedName = {
     countryName?: string;
@@ -146,4 +146,4 @@ type Options = {
 
 declare function ElectronUpdater(options: Options): Plugin;
 
-export { ElectronUpdater, Options };
+export { ElectronUpdater, type Options };

package/dist/vite.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from 'vite';
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { U as UpdateJSON } from './updateJson-synsK-Pt.js';
 
 type DistinguishedName = {
     countryName?: string;
@@ -146,4 +146,4 @@ type Options = {
 
 declare function ElectronUpdater(options: Options): Plugin;
 
-export { ElectronUpdater, Options };
+export { ElectronUpdater, type Options };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-incremental-update",
-  "version": "0.8.9",
+  "version": "0.9.0",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",
@@ -46,17 +46,17 @@
   "dependencies": {
     "@electron/asar": "^3.2.8",
     "ci-info": "^4.0.0",
-    "selfsigned": "^2.4.1",
-    "vite": "^4.5.0"
+    "selfsigned": "^2.4.1"
   },
   "devDependencies": {
-    "@subframe7536/eslint-config": "^0.4.1",
-    "@types/node": "^20.9.0",
+    "@subframe7536/eslint-config": "^0.5.0",
+    "@types/node": "^20.9.4",
     "bumpp": "^9.2.0",
-    "electron": "^27.0.4",
-    "eslint": "^8.53.0",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
+    "electron": "^27.1.0",
+    "eslint": "^8.54.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.2",
+    "vite": "^5.0.2",
     "vitest": "^0.34.6"
   }
 }