nexfep 0.6.0 → 0.6.1

package/README-CN.md

@@ -148,15 +148,22 @@ const locker = app.createLocker("my-app");
 try {
   // 尝试获取应用实例锁
   await locker.lock();
+  // 也可以带参数获取锁，例如：
+  // await locker.lock(process.argv[2]);
 } catch {
   // 应用实例已存在，退出应用
   app.exit();
 }
-// 在其它实例抢锁时聚焦当前实例
-locker.whenLost(() => {
+// 你可以在其它实例抢锁时聚焦当前实例
+locker.whenLost((data) => {
   if (!win.isFocused()) {
     win.focus();
   }
+  // 如果对方实例在获取锁时传递了参数，你可以使用它来执行特定操作
+  // 若没有传递，data 字段将会是 null
+  if (data) {
+    console.log("传递了参数:", data);
+  }
 });
 // 释放锁
 locker.unlock();
@@ -166,7 +173,7 @@ locker.unlock();
 
 | 方法                 | 描述                     |
 | -------------------- | ------------------------ |
-| `lock()`             | 尝试获取应用实例锁       |
+| `lock(data?)`        | 尝试获取应用实例锁       |
 | `whenLost(callback)` | 当其它实例抢锁时执行回调 |
 | `unlock()`           | 释放锁                   |
 
@@ -404,6 +411,12 @@ window.addEventListener("user-login", (event) => {
 });
 ```
 
+特别地，主进程可以通过 `pool.broadcast` 向所有打开的窗口发送事件，参数与页面中的 `window.broadcast` 相同：
+
+```typescript
+pool.broadcast("user-login", { userId: 123 });
+```
+
 #### 定向发送
 
 通过 `window.tell` 向指定 ID 的窗口发送消息：
@@ -432,6 +445,12 @@ window.addEventListener("custom-message", (event) => {
 console.log("当前窗口 ID:", window.id);
 ```
 
+主进程也可通过 `win.tell` 向该窗口发送消息：
+
+```typescript
+win.tell("custom-message", { text: `你好，窗口 ${win.id}` });
+```
+
 ### 自定义消息
 
 #### 发送消息

package/README.md

@@ -148,15 +148,22 @@ const locker = app.createLocker("my-app");
 try {
   // Try to acquire the lock
   await locker.lock();
+  // You can also pass data to the other instance when acquiring the lock
+  // await locker.lock(process.argv[2]);
 } catch {
   // Instance already exists, exit the application
   app.exit();
 }
 // Focus the current instance when other instances acquire the lock
-locker.whenLost(() => {
+locker.whenLost((data) => {
   if (!win.isFocused()) {
     win.focus();
   }
+  // If the other instance passed data, you can use it to perform specific actions
+  // If no data was passed, data will be null
+  if (data) {
+    console.log("Other instance passed data:", data);
+  }
 });
 // Release the lock
 locker.unlock();
@@ -164,7 +171,7 @@ locker.unlock();
 
 **Methods**
 
-- `lock()` — Try to acquire the lock
+- `lock(data?)` — Try to acquire the lock
 - `whenLost(callback)` — Register a callback to be called when other instances acquire the lock
 - `unlock()` — Release the lock
 
@@ -402,6 +409,12 @@ window.addEventListener("user-login", (event) => {
 });
 ```
 
+The main process can send events to all open windows via `pool.broadcast`, with parameters identical to those of `window.broadcast` in the page:
+
+```typescript
+pool.broadcast("user-login", { userId: 123 });
+```
+
 #### Tell
 
 Send a message to a specific window by its ID via `window.tell`:
@@ -430,6 +443,12 @@ Each window's ID can be accessed via `window.id`:
 console.log("This window ID:", window.id);
 ```
 
+The main process can also send messages to this window through `win.tell`:
+
+```typescript
+win.tell("custom-message", { text: `Hello Window ${win.id}` });
+```
+
 ### Custom Messages
 
 #### Send Messages

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nexfep",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "A desktop application framework based on @webviewjs/webview",
   "keywords": [
     "@webviewjs/webview",
@@ -65,7 +65,7 @@
     "lint:fix": "oxlint --fix"
   },
   "dependencies": {
-    "@nexfteam/single-instance": "^0.0.7",
+    "@nexfteam/single-instance": "0.0.8",
     "@webviewjs/webview": "0.4.1"
   },
   "devDependencies": {

package/src/SingleInstance.d.ts

@@ -2,8 +2,8 @@ import { SingleInstance } from "@nexfteam/single-instance";
 declare class Locker {
     locker: SingleInstance;
     constructor(appName: string);
-    lock(): Promise<void>;
+    lock(data?: string): Promise<void>;
     unlock(): Promise<void>;
-    whenLost(callback: () => void): void;
+    whenLost(callback: (data?: string) => void): void;
 }
 export { Locker };

package/src/SingleInstance.js

@@ -4,8 +4,8 @@ class Locker {
     constructor(appName) {
         this.locker = new SingleInstance(appName);
     }
-    lock() {
-        return this.locker.lock();
+    lock(data) {
+        return this.locker.lock(data);
     }
     unlock() {
         return this.locker.unlock();

package/src/WindowManager.d.ts

@@ -34,6 +34,7 @@ declare class Window {
     getPosition(): import("@webviewjs/webview").Position;
     isFocused(): boolean;
     focus(): void;
+    tell(message: string, data: any): void;
     hide(): void;
     show(): void;
     close(): void;
@@ -69,5 +70,6 @@ declare class WindowPool {
     closeWindow(window: Window): Promise<void>;
     handle(event: string, callback: (data: any) => any): Promise<void>;
     unhandle(event: string, callback: (data: any) => any): Promise<void>;
+    broadcast(event: string, data: any): Promise<void>;
 }
 export { WindowPool, Window };

package/src/WindowManager.js

@@ -121,6 +121,9 @@ class Window {
         this.unMinimize();
         this.window.focus();
     }
+    tell(message, data) {
+        this.webview.evaluateScript(`window.dispatchEvent(new CustomEvent('${message}', { detail: ${JSON.stringify(data)} }));`);
+    }
     hide() {
         this.window.hide();
         this.isShow = false;
@@ -370,13 +373,14 @@ class WindowPool {
                     const dataText = data.body.toString();
                     const dataObj = JSON.parse(dataText);
                     if (dataObj.type == "NexfepBeforeUnload") {
-                        webview.evaluateScript(`if(window?.isNexfepLoadDone){
-                            const MessageBody = { type: 'NexfepBeforeUnload' }
-                            window.ipc.postMessage(JSON.stringify(MessageBody));
-                        }else{
-                            const MessageBody = { type: 'NexfepLoadFalse' }
-                            window.ipc.postMessage(JSON.stringify(MessageBody));
-                        }`);
+                        webview.evaluateScript(`
+              if(window?.isNexfepLoadDone){
+                const MessageBody = { type: 'NexfepBeforeUnload' }
+                window.ipc.postMessage(JSON.stringify(MessageBody));
+              }else{
+                const MessageBody = { type: 'NexfepLoadFalse' }
+                window.ipc.postMessage(JSON.stringify(MessageBody));
+              }`);
                     }
                     else if (dataObj.type == "NexfepLoadFalse") {
                         this.__injectControlFunctions(windowObj);
@@ -416,14 +420,10 @@ class WindowPool {
                         handlers.forEach(async (handler) => {
                             const result = await handler(dataObj.data);
                             if (result) {
-                                webview.evaluateScript(`
-                                    window.dispatchEvent(new CustomEvent('nexfep-invoke-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: ${JSON.stringify(result)} }));
-                                `);
+                                webview.evaluateScript(`window.dispatchEvent(new CustomEvent('nexfep-invoke-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: ${JSON.stringify(result)} }));`);
                             }
                             else {
-                                webview.evaluateScript(`
-                                    window.dispatchEvent(new CustomEvent('nexfep-invoke-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: undefined }));
-                                `);
+                                webview.evaluateScript(`window.dispatchEvent(new CustomEvent('nexfep-invoke-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: undefined }));`);
                             }
                         });
                     }
@@ -432,16 +432,12 @@ class WindowPool {
                     }
                     else if (dataObj.type == "NexfepGetGlobal") {
                         const value = this.global.get(dataObj.name);
-                        webview.evaluateScript(`
-                            window.dispatchEvent(new CustomEvent('nexfep-get-global-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: ${JSON.stringify(value)} }));
-                        `);
+                        webview.evaluateScript(`window.dispatchEvent(new CustomEvent('nexfep-get-global-result-${dataObj.eventId[0]}-${dataObj.eventId[1]}', { detail: ${JSON.stringify(value)} }));`);
                     }
                     else if (dataObj.type == "NexfepBroadcast") {
                         this.windows.forEach(async (w) => {
                             if (w != windowObj && w.isOpen) {
-                                w.webview.evaluateScript(`
-                                    window.dispatchEvent(new CustomEvent('${dataObj.name}', { detail: ${JSON.stringify(dataObj.data)} }));
-                                `);
+                                w.webview.evaluateScript(`window.dispatchEvent(new CustomEvent('${dataObj.name}', { detail: ${JSON.stringify(dataObj.data)} }));`);
                             }
                         });
                     }
@@ -451,9 +447,7 @@ class WindowPool {
                         }
                         this.windows.forEach(async (w) => {
                             if (w.id == dataObj.to) {
-                                w.webview.evaluateScript(`
-                                    window.dispatchEvent(new CustomEvent('${dataObj.message}', { detail: ${JSON.stringify(dataObj.data)} }));
-                                `);
+                                w.webview.evaluateScript(`window.dispatchEvent(new CustomEvent('${dataObj.message}', { detail: ${JSON.stringify(dataObj.data)} }));`);
                             }
                         });
                     }
@@ -518,5 +512,12 @@ class WindowPool {
     async unhandle(event, callback) {
         this.handlers.set(event, (this.handlers.get(event) || []).filter((c) => c !== callback));
     }
+    async broadcast(event, data) {
+        this.windows.forEach(async (w) => {
+            if (w.isOpen) {
+                w.webview.evaluateScript(`window.dispatchEvent(new CustomEvent('${event}', { detail: ${JSON.stringify(data)} }));`);
+            }
+        });
+    }
 }
 export { WindowPool, Window };