tauri-remote-ui 0.24.0 → 0.26.0

package/README.md

@@ -11,6 +11,20 @@
 - **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.
 
+## Completed Features
+
+### Javascript
+- **api/core** - `invoke`
+- **api/event** - `listen`
+- **api/app**
+  - `defaultWindowIcon`,`fetchDataStoreIdentifiers`,`getBundleType`,
+  - `getIdentifier`,`getName`,`getTauriVersion`,
+  - `getVersion`,`hide`,`removeDataStore`,
+  - `setDockVisibility`,`setTheme`,`show`
+
+### Rust
+- `emit` - Emit method is updated to handle in this plugin.
+
 ## Operation Flow
 
 - **WebView:** Uses IPC for communication between frontend and backend.
@@ -20,14 +34,67 @@
 
 ## Usage
 
-1. **Install the Rust plugin** in your Tauri project.
-2. **Install the NPM plugin** in your frontend.
+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
+```
+To
+```rust
+use tauri_remote_ui::EmitterExt;
+```
+4. **Start/Stop Server**
+```rust
+fn enable_server(app: AppHandle) -> String {
+    match app.start_remote_ui(RemoteUiConfig::default().set_port(Some(9090))) {
+        Ok(()) => format!("Server Started."),
+        Err(err) => format!("Server Error {:?}", err),
+    }
+}
+fn disable_server(app: AppHandle) -> String {
+    match app.stop_remote_ui() {
+        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";
+```
 3. **Access the UI remotely** via the provided web interface when activated.
 
 ## Development
 
 - Build Rust: `cargo build`
-- Build JS: `pnpm build` (from the root)
+- Build JS: `pnpm build`
 - Example app: See `examples/tauri-app/`
 
 ## License

package/package.json

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

package/socket.cjs

@@ -21,7 +21,7 @@ function getWsUrl() {
 }
 function getUrl() {
     const loc = window.location;
-    const wsUrl = `${loc.protocol}//${loc.host}/remote_ui`;
+    const wsUrl = `${loc.protocol}//${loc.host}/remote_ui_disconnect`;
     return wsUrl;
 }
 /**

package/socket.js

@@ -19,7 +19,7 @@ function getWsUrl() {
 }
 function getUrl() {
     const loc = window.location;
-    const wsUrl = `${loc.protocol}//${loc.host}/remote_ui`;
+    const wsUrl = `${loc.protocol}//${loc.host}/remote_ui_disconnect`;
     return wsUrl;
 }
 /**