tauri-remote-ui 0.26.0 → 0.28.0

package/README.md

@@ -1,15 +1,19 @@
 # Tauri Remote UI
 
-**Tauri Remote UI** is a plugin that allows you to expose your Tauri application's UI to any web browser, enabling seamless remote interaction 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, 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.
+
+## 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
 
 - **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.
-- **Zero App Changes:** No additional changes required to your app after plugin setup.
-- **Future Compatibility:** 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.
+- **Future Compatibility For Test Migration:** When [CEF-RS](https://github.com/tauri-apps/cef-rs) 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.
 
 ## Completed Features
 
@@ -57,22 +61,24 @@ pub fn run() {
 ```
 3. **Replace Emitter trait**
 ```rust
-use tauri::Emitter
+use tauri::Emitter;
+webview_window.emit(data)
 ```
 To
 ```rust
 use tauri_remote_ui::EmitterExt;
+webview_window.emit(data).await
 ```
 4. **Start/Stop Server**
 ```rust
-fn enable_server(app: AppHandle) -> String {
-    match app.start_remote_ui(RemoteUiConfig::default().set_port(Some(9090))) {
+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),
     }
 }
-fn disable_server(app: AppHandle) -> String {
-    match app.stop_remote_ui() {
+async fn disable_server(app: AppHandle) -> String {
+    match app.stop_remote_ui().await {
         Ok(()) => format!("Server Stoped"),
         Err(err) => format!("Server Error {:?}", err),
     }
@@ -89,12 +95,13 @@ To
 import { invoke } from "tauri-remote-ui/api/core";
 import { listen } from "tauri-remote-ui/api/event";
 ```
-3. **Access the UI remotely** via the provided web interface when activated.
+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**
 
-## Development
+## Plugin Development
 
 - Build Rust: `cargo build`
-- Build JS: `pnpm build`
+- Build JS: `cd guest-js && pnpm build`
 - Example app: See `examples/tauri-app/`
 
 ## License

package/api/event/index.d.ts

@@ -4,6 +4,7 @@
  * 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';
 /**
  * Listen to events from the Tauri application
  * Falls back to WebSocket if Tauri Event API is not available

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tauri-remote-ui",
   "license": "MIT",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "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",