tauri-remote-ui 0.27.0 → 1.0.1-alpha.8

package/LICENSE

@@ -1,21 +1,39 @@
-MIT License
-
-Copyright (c) 2025 - DraviaVemal
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# License Information
+
+This project is licensed under **AGPL-3.0** starting from version 1.x.
+
+---
+
+## 📜 Open Source (AGPL-3.0)
+
+- You are free to use, study, and modify this project under the terms of the **GNU Affero General Public License v3.0 (AGPL-3.0)**.  
+- **Important:** If you build on top of this project (derivative works, forks, integrations, etc.) you must also release your work under **AGPL-3.0**.  
+- This ensures improvements and extensions remain open to the community.  
+
+---
+
+## 💼 Commercial Use (Sponsorware Model)
+
+- Commercial use **is not allowed** under AGPL-3.0 without a separate license.  
+- To use this project in **commercial products, SaaS, internal tools, or client projects**, your organization must:  
+  1. **Sponsor this project** at the required tier on [GitHub Sponsors](https://github.com/sponsors/DraviaVemal).  
+  2. Sponsored organizations are granted access to a **private repository**, licensed under a **commercial-friendly license (MIT terms)**.  
+  3. This private repo contains the same core code under commercial terms, plus optional add-ons.  
+
+---
+
+## 🚀 Sponsor Benefits
+
+- Access to a **commercial license** for this project (MIT terms).  
+- Access to the **private repo** with code updates.  
+- **Priority support** — issues and feature requests in the private repo are handled **before public requests**.  
+
+---
+
+## ✅ How to Comply
+
+- **Individuals, students, hobbyists** → Use under **AGPL-3.0** (non-commercial OK).  
+- **Businesses, organizations, contractors** → Must **sponsor** to obtain commercial rights.  
+
+For details on AGPL-3.0, see [LICENSE](https://opensource.org/license/agpl-v3).  
+For commercial licensing inquiries, contact: **contact@draviavemal.com**.  

package/README.md

@@ -1,109 +1,48 @@
-# Tauri Remote UI
+# tauri-remote-ui  (AGPL-3.0)
 
-**Tauri Remote UI** is a plugin that allows you to expose your Tauri application's UI to any web browser, enabling seamless remote interaction for development and end-to-end testing. The plugin bridges your native app and commercial browsers, letting you use standard web automation tools for testing and debugging—without modifying your app's logic.
+**Tauri Remote UI** is a plugin that allows you to expose your Tauri application's UI to any web browser.
 
 ## Badges
-![Crates.io Version](https://img.shields.io/crates/v/tauri-remote-ui?style=flat&label=crates.io%20%3A%20tauri-remote-ui) ![NPM Version](https://img.shields.io/npm/v/tauri-remote-ui?label=npm%20%3A%20tauri-remote-ui)
-
 
-## Features
+![Crates.io Version](https://img.shields.io/crates/v/tauri-remote-ui?style=flat&label=crates.io%20%3A%20tauri-remote-ui) ![NPM Version](https://img.shields.io/npm/v/tauri-remote-ui?label=npm%20%3A%20tauri-remote-ui)
 
-- **Remote UI Exposure:** Interact with your Tauri app from any browser.
-- **Seamless Development:** Enable Development debug attachment for fronend debugging.
-- **Seamless E2E Testing:** Use existing web automation/testing tools.
-- **Automatic Transport Switching:** IPC for WebView, WebSocket for browsers—handled transparently.
-- **Customizable Security:** Control and secure remote access as needed.
-- **Future Compatibility For Test Migration:** When [CEF-RS](https://github.com/cef-rs/cef) becomes available, the same E2E tests (e.g., written with Playwright or similar tools that use the Chromium debug port) will work seamlessly in debug mode, ensuring long-term support for modern testing workflows.
+## 📜 License
 
-## Completed Features
+- Open Source: AGPL-3.0 (see LICENSE)
+- Commercial: Available via sponsorship (see LICENSE)
 
-### Javascript
-- **api/core** - `invoke`
-- **api/event** - `listen`
-- **api/app**
-  - `defaultWindowIcon`,`fetchDataStoreIdentifiers`,`getBundleType`,
-  - `getIdentifier`,`getName`,`getTauriVersion`,
-  - `getVersion`,`hide`,`removeDataStore`,
-  - `setDockVisibility`,`setTheme`,`show`
+## ✨ Features
 
-### Rust
-- `emit` - Emit method is updated to handle in this plugin.
+- Seamless enable/diable integration
+- Network level access control setting
+- Network latency tracking
 
-## Operation Flow
+## Supports
 
-- **WebView:** Uses IPC for communication between frontend and backend.
-- **Commercial Browser:** Uses WebSocket (WS) for remote frontend-backend communication.
-- **Automatic Switching:** The Rust backend plugin and npm frontend wrapper handle transport selection automatically.
-- **Security:** The exposure of the web app can be secured and customized by the end user.
+|Environment|Support|
+|-|-|
+|Windows|✅|
+|Mac|✅|
+|Linux|✅|
+|Android|❌|
+|iOS|❌|
 
-## Usage
+## Use Case
 
-1. **Install the Rust plugin** in your Tauri project `cargo add tauri-remote-ui`.
-2. **Initialize the Rust plugin** 
-```rust
-pub fn run() {
-    tauri::Builder::default()
-        .plugin(tauri_remote_ui::init())
-        .invoke_handler(tauri::generate_handler![
-            increment,
-            decrement,
-            enable_server,
-            disable_server,
-            exit_app,
-        ])
-        .setup(|app| {
-            app.manage(Arc::new(RwLock::new(Counter { now: 0 })));
-            Ok(())
-        })
-        .run(tauri::generate_context!())
-        .expect("error while running tauri application");
-}
-```
-3. **Replace Emitter trait**
-```rust
-use tauri::Emitter;
-webview_window.emit(data)
-```
-To
-```rust
-use tauri_remote_ui::EmitterExt;
-webview_window.emit(data).await
-```
-4. **Start/Stop Server**
-```rust
-async fn enable_server(app: AppHandle) -> String {
-    match app.start_remote_ui(RemoteUiConfig::default().set_port(Some(9090))).await {
-        Ok(()) => format!("Server Started."),
-        Err(err) => format!("Server Error {:?}", err),
-    }
-}
-async fn disable_server(app: AppHandle) -> String {
-    match app.stop_remote_ui().await {
-        Ok(()) => format!("Server Stoped"),
-        Err(err) => format!("Server Error {:?}", err),
-    }
-}
-```
-5. **Install the NPM plugin** in your frontend `npm i tauri-remote-ui`.
-6. **Replace the NPM package** 
-```typescript
-import { invoke } from "@tauri-apps/api/core";
-import { listen } from "@tauri-apps/api/event";
-```
-To
-```typescript
-import { invoke } from "tauri-remote-ui/api/core";
-import { listen } from "tauri-remote-ui/api/event";
-```
-7. **Development WebSocket Proxy** `/remote_ui_ws` proxy remote_ui url ws to your dev server like vite.
-8. **Enable Source Map and update lauch.json setup in vscode to debug frontend**
+- Enabling seamless remote interaction for development debugging—without modifying your app's logic.
+- Enabling end-to-end testing of tauri application using standard web automation tools like playwright.
+  - Note : Based on tauri target OS the webkit will change windows will be 100% match test case as both are chromium rest of OS around maximum 10% UI difference are expected from actual application
+- Enable remote access feature for local close ciruit hardware related application
 
-## Plugin Development
+## Planned Features
 
-- Build Rust: `cargo build`
-- Build JS: `cd guest-js && pnpm build`
-- Example app: See `examples/tauri-app/`
+- Multiple Window of Tauri app support in Remote UI logic
+- SSO Ingration Option
+- Custom Starting window name options
+- Dynamic Port mapping
+- SSL Certificate ingration
+- Authendication system for remote access (User_id,Password)
 
-## License
+## [Documents](https://docs.draviavemal.com)
 
-MIT
+Refer document central for detailed information [docs](https://docs.draviavemal.com)

package/api/event/index.cjs

@@ -27,30 +27,20 @@ async function listen(event$1, handler, options) {
         if (socket.wsReady) {
             await socket.wsReady;
         }
-        if (socket.ws && socket.ws.readyState === WebSocket.OPEN) {
-            // Handle WebSocket messages for events
-            const messageHandler = (wsEvent) => {
-                try {
-                    const data = JSON.parse(wsEvent.data);
-                    if (data.event === event$1) {
-                        handler(data);
-                    }
-                }
-                catch (err) {
-                    console.error(err);
-                    throw new Error('Error handling WebSocket event');
-                }
-            };
-            socket.ws.addEventListener('message', messageHandler);
-            // Return an unlisten function
-            return () => {
-                socket.ws === null || socket.ws === void 0 ? void 0 : socket.ws.removeEventListener('message', messageHandler);
-            };
-        }
-        else {
-            throw new Error("No WebSocket or Tauri IPC available to invoke");
-        }
+        // Handle WebSocket messages for events
+        const messageHandler = ({ data }) => {
+            handler(data);
+        };
+        socket.listenEvent.addEventListener(event$1, messageHandler);
+        // Return an unlisten function
+        return () => {
+            socket.listenEvent.removeEventListener(event$1, messageHandler);
+        };
     }
 }
 
+Object.defineProperty(exports, "latencyMs", {
+    enumerable: true,
+    get: function () { return socket.latencyMs; }
+});
 exports.listen = listen;

package/api/event/index.d.ts

@@ -4,6 +4,8 @@
  * This module handles listening to events from the Tauri application via WebSocket
  */
 import { EventCallback, EventName, Options, UnlistenFn } from '@tauri-apps/api/event';
+export type { UnlistenFn } from '@tauri-apps/api/event';
+export { latencyMs } from "../../socket";
 /**
  * Listen to events from the Tauri application
  * Falls back to WebSocket if Tauri Event API is not available

package/api/event/index.js

@@ -1,5 +1,6 @@
 import { listen as listen$1 } from '@tauri-apps/api/event';
-import { initWebSocket, wsReady, ws } from '../../socket.js';
+import { initWebSocket, wsReady, listenEvent } from '../../socket.js';
+export { latencyMs } from '../../socket.js';
 
 /**
  * Event API module for Tauri Remote UI
@@ -25,29 +26,15 @@ async function listen(event, handler, options) {
         if (wsReady) {
             await wsReady;
         }
-        if (ws && ws.readyState === WebSocket.OPEN) {
-            // Handle WebSocket messages for events
-            const messageHandler = (wsEvent) => {
-                try {
-                    const data = JSON.parse(wsEvent.data);
-                    if (data.event === event) {
-                        handler(data);
-                    }
-                }
-                catch (err) {
-                    console.error(err);
-                    throw new Error('Error handling WebSocket event');
-                }
-            };
-            ws.addEventListener('message', messageHandler);
-            // Return an unlisten function
-            return () => {
-                ws === null || ws === void 0 ? void 0 : ws.removeEventListener('message', messageHandler);
-            };
-        }
-        else {
-            throw new Error("No WebSocket or Tauri IPC available to invoke");
-        }
+        // Handle WebSocket messages for events
+        const messageHandler = ({ data }) => {
+            handler(data);
+        };
+        listenEvent.addEventListener(event, messageHandler);
+        // Return an unlisten function
+        return () => {
+            listenEvent.removeEventListener(event, messageHandler);
+        };
     }
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tauri-remote-ui",
-  "license": "MIT",
-  "version": "0.27.0",
+  "license": "AGPL-3.0-only",
+  "version": "1.0.1-alpha.8",
   "author": "DraviaVemal",
   "description": "A Tauri plugin that exposes the application's UI to a web browser, allowing full interaction while the native app continues running. This enables end-to-end UI testing using existing web-based testing tools without requiring modifications to the app itself.",
   "type": "module",
@@ -9,8 +9,9 @@
   "main": "./index.cjs",
   "module": "./index.js",
   "repository": {
-    "url": "https://github.com/DraviaVemal/tauri-remote-ui"
+    "url": "git+https://github.com/DraviaVemal/tauri-remote-ui.git"
   },
+  "readme": "./README.md",
   "exports": {
     ".": {
       "types": "./index.d.ts",
@@ -49,4 +50,4 @@
   "peerDependencies": {
     "@tauri-apps/api": ">=2.0.0"
   }
-}
+}

package/socket.cjs

@@ -8,8 +8,10 @@
  * with a Tauri application.
  */
 exports.ws = null;
+let listenEvent = new EventTarget();
 exports.wsReady = null;
 const filterCollection = {};
+exports.latencyMs = 0;
 /**
  * Get the WebSocket URL based on the current window location
  */
@@ -42,37 +44,57 @@ function initWebSocket() {
     catch {
         if (exports.ws)
             return;
-        console.info("Remote RPC Attempting...");
+        console.info("Tauri-Remote-UI : Remote RPC Attempting...");
         const wsUrl = getWsUrl();
         try {
+            let lastPingTimestamp = Date.now();
+            let pingPongTimer;
             exports.ws = new WebSocket(wsUrl);
             exports.wsReady = new Promise((resolve, reject) => {
                 exports.ws.onopen = () => {
-                    console.info("Remote Connected.");
+                    console.info("Tauri-Remote-UI : Remote Connected.");
+                    lastPingTimestamp = Date.now();
+                    exports.ws === null || exports.ws === void 0 ? void 0 : exports.ws.send("ping");
+                    pingPongTimer = setInterval(() => {
+                        lastPingTimestamp = Date.now();
+                        exports.ws === null || exports.ws === void 0 ? void 0 : exports.ws.send("ping");
+                    }, 10000);
                     resolve();
                 };
+                exports.ws.onmessage = ({ data }) => {
+                    if (data === "pong") {
+                        exports.latencyMs = Date.now() - lastPingTimestamp;
+                        if (exports.latencyMs > 200) {
+                            console.warn(`Tauri-Remote-UI : High latency detected - ${exports.latencyMs}ms`);
+                        }
+                        return;
+                    }
+                    let jsonData = JSON.parse(data);
+                    if (jsonData.id && filterCollection[jsonData.id]) {
+                        filterCollection[jsonData.id](JSON.parse(jsonData.payload));
+                    }
+                    else {
+                        listenEvent.dispatchEvent(new MessageEvent(jsonData.event, { data: jsonData }));
+                    }
+                };
                 exports.ws.onclose = () => {
                     exports.ws = null;
                     exports.wsReady = null;
-                    console.info("Remote Dis-Connected.");
-                    window.location.replace(getUrl());
+                    pingPongTimer && clearInterval(pingPongTimer);
+                    console.info("Tauri-Remote-UI : Remote DisConnected.");
+                    window.location.href = getUrl();
                 };
                 exports.ws.onerror = (e) => {
                     reject(e);
                 };
-                exports.ws.onmessage = ({ data }) => {
-                    let json_data = JSON.parse(data);
-                    json_data.id && filterCollection[json_data.id] && filterCollection[json_data.id](JSON.parse(json_data.payload));
-                };
             });
         }
         catch (e) {
-            setTimeout(() => {
-                initWebSocket();
-            }, 5000);
+            console.error(e);
         }
     }
 }
 
 exports.filterCollection = filterCollection;
 exports.initWebSocket = initWebSocket;
+exports.listenEvent = listenEvent;

package/socket.d.ts

@@ -6,10 +6,12 @@
  * with a Tauri application.
  */
 export declare let ws: WebSocket | null;
+export declare let listenEvent: EventTarget;
 export declare let wsReady: Promise<void> | null;
 export declare const filterCollection: {
     [msg_id: string]: (response: any) => any;
 };
+export declare let latencyMs: number;
 /**
  * Initialize the WebSocket connection
  * This should be called once at the start of your application

package/socket.js

@@ -6,8 +6,10 @@
  * with a Tauri application.
  */
 let ws = null;
+let listenEvent = new EventTarget();
 let wsReady = null;
 const filterCollection = {};
+let latencyMs = 0;
 /**
  * Get the WebSocket URL based on the current window location
  */
@@ -40,36 +42,55 @@ function initWebSocket() {
     catch {
         if (ws)
             return;
-        console.info("Remote RPC Attempting...");
+        console.info("Tauri-Remote-UI : Remote RPC Attempting...");
         const wsUrl = getWsUrl();
         try {
+            let lastPingTimestamp = Date.now();
+            let pingPongTimer;
             ws = new WebSocket(wsUrl);
             wsReady = new Promise((resolve, reject) => {
                 ws.onopen = () => {
-                    console.info("Remote Connected.");
+                    console.info("Tauri-Remote-UI : Remote Connected.");
+                    lastPingTimestamp = Date.now();
+                    ws === null || ws === void 0 ? void 0 : ws.send("ping");
+                    pingPongTimer = setInterval(() => {
+                        lastPingTimestamp = Date.now();
+                        ws === null || ws === void 0 ? void 0 : ws.send("ping");
+                    }, 10000);
                     resolve();
                 };
+                ws.onmessage = ({ data }) => {
+                    if (data === "pong") {
+                        latencyMs = Date.now() - lastPingTimestamp;
+                        if (latencyMs > 200) {
+                            console.warn(`Tauri-Remote-UI : High latency detected - ${latencyMs}ms`);
+                        }
+                        return;
+                    }
+                    let jsonData = JSON.parse(data);
+                    if (jsonData.id && filterCollection[jsonData.id]) {
+                        filterCollection[jsonData.id](JSON.parse(jsonData.payload));
+                    }
+                    else {
+                        listenEvent.dispatchEvent(new MessageEvent(jsonData.event, { data: jsonData }));
+                    }
+                };
                 ws.onclose = () => {
                     ws = null;
                     wsReady = null;
-                    console.info("Remote Dis-Connected.");
-                    window.location.replace(getUrl());
+                    pingPongTimer && clearInterval(pingPongTimer);
+                    console.info("Tauri-Remote-UI : Remote DisConnected.");
+                    window.location.href = getUrl();
                 };
                 ws.onerror = (e) => {
                     reject(e);
                 };
-                ws.onmessage = ({ data }) => {
-                    let json_data = JSON.parse(data);
-                    json_data.id && filterCollection[json_data.id] && filterCollection[json_data.id](JSON.parse(json_data.payload));
-                };
             });
         }
         catch (e) {
-            setTimeout(() => {
-                initWebSocket();
-            }, 5000);
+            console.error(e);
         }
     }
 }
 
-export { filterCollection, initWebSocket, ws, wsReady };
+export { filterCollection, initWebSocket, latencyMs, listenEvent, ws, wsReady };