@bobfrankston/msger 0.1.30 → 0.1.32

package/README.md

@@ -6,7 +6,7 @@ This package provides a TypeScript/JavaScript API that wraps the native Rust imp
 - **10-20x faster startup** (~50-200ms vs ~2-3s)
 - **50x smaller binary** (~2-5MB vs ~100MB)
 - **5x less memory** (~20-50MB vs ~100-200MB)
-- **Cross-platform**: Windows (WebView2), macOS (WebKit), Linux (WebKitGTK)
+- **Cross-platform**: Windows (WebView2), Linux x86_64 (WebKitGTK), Linux ARM64/Raspberry Pi (WebKitGTK)
 
 ## Installation
 
@@ -19,6 +19,13 @@ For global CLI usage:
 npm install -g @bobfrankston/msger
 ```
 
+**Platform Support:**
+- Windows (x64) - Uses WebView2
+- Linux x86_64 - Uses WebKitGTK 4.0
+- Linux ARM64/Raspberry Pi - Uses WebKitGTK 4.0
+
+The correct binary is automatically selected based on your platform and architecture.
+
 ## Usage
 
 ### As a Library (Recommended)
@@ -43,13 +50,23 @@ if (result.value) {
 
 ```bash
 # Simple message
-msger "Hello, World!"
+msger -t "Hello" -m "Hello, World!"
 
 # With HTML content
-msger "Enter your name:" "<p>Please provide your <strong>full name</strong></p>"
+msger -t "Welcome" -html "<h1>Welcome!</h1><p>This is <strong>HTML</strong></p>"
+
+# Load a URL (web page or local file)
+msger -url "https://example.com"
+msger -url "file:///path/to/page.html"
+
+# With custom size
+msger -t "Big Window" -m "Hello" -w 800 -h 600
+
+# With timeout (auto-close after 5 seconds)
+msger -t "Notification" -m "This will close in 5 seconds" -timeout 5
 
-# From JSON stdin
-echo '{"message":"Test","buttons":["Cancel","OK"]}' | msger
+# See all options
+msger --help
 ```
 
 ## API
@@ -62,14 +79,25 @@ Display a message box dialog and wait for user response.
 
 ```typescript
 interface MessageBoxOptions {
-    title?: string;          // Window title (default: "Message")
-    message: string;         // Plain text message (required)
-    html?: string;          // HTML content (overrides message display)
-    width?: number;         // Window width in pixels (default: 600)
-    height?: number;        // Window height in pixels (default: 400)
-    buttons?: string[];     // Button labels (default: ["OK"])
-    defaultValue?: string;  // Default input value
-    allowInput?: boolean;   // Show input field (default: false)
+    title?: string;           // Window title (default: "Message")
+    message?: string;         // Plain text message (optional if url or html provided)
+    html?: string;            // HTML content to display
+    url?: string;             // URL to load (web URL or file:// path)
+    size?: {                  // Window size in pixels
+        width: number;        // Window width (default: 600)
+        height: number;       // Window height (default: 400)
+    };
+    buttons?: string[];       // Button labels (default: ["OK"])
+    defaultValue?: string;    // Default input value
+    allowInput?: boolean;     // Show input field (default: false)
+    timeout?: number;         // Auto-close after N seconds
+    detach?: boolean;         // Launch detached from parent process
+    
+    // Not yet implemented:
+    // fullPage?: boolean;    // Display HTML as complete page without wrapping
+    // pos?: { x: number; y: number; screen?: number };  // Window position
+    // zoomPercent?: number;  // Initial zoom level (100=100%, 150=150%)
+    // devTools?: boolean;    // Open DevTools for debugging
 }
 ```
 
@@ -77,10 +105,12 @@ interface MessageBoxOptions {
 
 ```typescript
 interface MessageBoxResult {
-    button: string;    // Label of clicked button
-    value?: string;    // Input value (if allowInput was true)
-    closed?: boolean;  // True if window was closed
-    dismissed?: boolean; // True if dismissed with Escape
+    button: string;       // Label of clicked button
+    value?: string;       // Input value (if allowInput was true)
+    form?: object;        // Form data (if form elements present)
+    closed?: boolean;     // True if window was closed
+    dismissed?: boolean;  // True if dismissed with Escape
+    timeout?: boolean;    // True if auto-closed by timeout
 }
 ```
 
@@ -121,7 +151,6 @@ if (result.button === 'OK') {
 ```typescript
 const result = await showMessageBox({
     title: 'Welcome',
-    message: 'Welcome message',
     html: `
         <div style="font-family: sans-serif;">
             <h2 style="color: #2563eb;">Welcome!</h2>
@@ -133,75 +162,163 @@ const result = await showMessageBox({
             </ul>
         </div>
     `,
-    width: 700,
-    height: 500,
+    size: { width: 700, height: 500 },
     buttons: ['Close']
 });
 ```
 
+### Display a Web Page
+
+```typescript
+// Load external website
+await showMessageBox({
+    title: 'Documentation',
+    url: 'https://github.com/BobFrankston/msger',
+    size: { width: 1024, height: 768 }
+});
+
+// Load local HTML file
+await showMessageBox({
+    title: 'Help',
+    url: 'file:///path/to/help.html',
+    size: { width: 800, height: 600 }
+});
+```
+
+### Auto-Close with Timeout
+
+```typescript
+// Show notification that auto-closes after 3 seconds
+const result = await showMessageBox({
+    title: 'Notification',
+    message: 'File saved successfully!',
+    timeout: 3,
+    buttons: ['OK']
+});
+
+if (result.timeout) {
+    console.log('Notification auto-closed');
+}
+```
+
 ## Architecture
 
 ```
 @bobfrankston/msger (TypeScript wrapper)
-    ↓ spawns with JSON via stdin
-@bobfrankston/msger-native (Rust binary)
+    ↓ spawns native binary with JSON via stdin
+@bobfrankston/msger-native (Rust binary - platform-specific)
     ↓ creates native window with webview
-    ↓ displays HTML message with buttons
+    ↓ displays HTML/URL content with buttons
     ↓ outputs JSON result to stdout
-TypeScript wrapper returns Promise
+TypeScript wrapper returns Promise<MessageBoxResult>
 ```
 
+**Platform-specific binaries:**
+- `msgernative.exe` - Windows x64 (WebView2)
+- `msgernative` - Linux x86_64 (WebKitGTK)
+- `msgernative-arm64` - Linux ARM64/Raspberry Pi (WebKitGTK)
+
+The correct binary is automatically selected based on `process.platform` and `process.arch`.
+
 ## Building from Source
 
 ```bash
-# Build both Rust binary and TypeScript wrapper
+# Build everything (TypeScript + all native binaries)
 npm run build
 
-# Build only TypeScript (assumes Rust binary exists)
+# Build only TypeScript wrapper
 npm run build:ts
 
-# Build only Rust binary
+# Build Windows binary
 npm run build:native
 
+# Build Linux x64 binary (via WSL)
+npm run build:native:wsl
+
+# Build ARM64 binary (via SSH to Raspberry Pi)
+npm run build:native:pi
+
+# Build all native binaries
+npm run build:native:all
+
 # Watch mode for TypeScript development
 npm run watch
 ```
 
+### Building ARM64 Binary
+
+To build the ARM64 binary for Raspberry Pi:
+
+1. Update `PI_HOST` in `msger-native/build-pi.ts` with your Pi's hostname/IP
+2. Ensure SSH keys are set up: `ssh-copy-id pi@your-pi`
+3. Run: `npm run build:native:pi`
+
+The script will automatically:
+- Copy source files to the Pi via SSH
+- Install Rust and build dependencies if needed
+- Build the binary on the Pi
+- Copy the binary back to your development machine
+
 ## Development
 
 The project consists of two parts:
 
-1. **`msger-native/`** - Pure Rust binary (subdirectory)
-2. **Root directory** - TypeScript wrapper (this project)
+1. **`msger-native/`** - Rust binary (subdirectory with its own Cargo.toml)
+2. **Root directory** - TypeScript wrapper and npm package
 
 When you run `npm run build`, it:
-1. Builds the Rust binary in the `msger-native/` subdirectory
-2. Copies the binary to `./bin/`
+1. Builds platform-specific Rust binaries
+2. Copies binaries to `msger-native/bin/`
 3. Compiles TypeScript to JavaScript
 
-The binary is bundled with the npm package, so users get everything in one install.
+All binaries are bundled with the npm package, and the correct one is selected at runtime.
 
 ## Features
 
-- ✅ Cross-platform native webview
+- ✅ Cross-platform native webview (Windows, Linux x64, Linux ARM64)
 - ✅ Full HTML/CSS support
+- ✅ Load external URLs or local files
 - ✅ Customizable buttons
 - ✅ Input field support
+- ✅ Auto-close with timeout
 - ✅ Keyboard shortcuts (Enter, Escape)
 - ✅ Window close detection
 - ✅ TypeScript type definitions
-- ✅ Small binary size (~2-5MB)
+- ✅ Small binary size (~1-2MB per platform)
 - ✅ Fast startup (~50-200ms)
+- ✅ Detached process mode
+- ⏳ Coming soon: Window positioning, zoom control, DevTools
 
 ## Performance Comparison
 
 |  | **Electron (msgview)** | **Rust (msger)** | **Improvement** |
 |---|---|---|---|
-| **Binary Size** | ~100MB | ~2-5MB | **50x smaller** |
+| **Binary Size** | ~100MB | ~1-2MB per platform | **50-100x smaller** |
 | **Startup Time** | ~2-3 seconds | ~50-200ms | **10-20x faster** |
-| **Memory Usage** | ~100-200MB | ~20-50MB | **5x less** |
-| **Cross-Platform** | ✅ Win/Mac/Linux | ✅ Win/Mac/Linux | Same |
+| **Memory Usage** | ~100-200MB | ~20-50MB | **3-5x less** |
+| **Cross-Platform** | ✅ Win/Mac/Linux | ✅ Win/Linux x64/ARM64 | Similar |
 | **Full HTML/CSS** | ✅ Chromium | ✅ WebView2/WebKit | Same |
+| **URL Loading** | ✅ | ✅ | Same |
+
+## CLI Options
+
+```
+Usage: msger [options]
+
+Options:
+  -t, --title <title>          Window title
+  -m, --message <message>      Plain text message
+  -html, --html <html>         HTML content
+  -url, --url <url>            URL to load (web or file://)
+  -w, --width <width>          Window width in pixels (default: 600)
+  -h, --height <height>        Window height in pixels (default: 400)
+  -b, --buttons <buttons>      Comma-separated button labels (default: "OK")
+  -i, --allowInput             Enable input field
+  -d, --defaultValue <value>   Default input value
+  -timeout, --timeout <sec>    Auto-close after N seconds
+  --help                       Show help
+  --version                    Show version
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bobfrankston/msger",
-    "version": "0.1.30",
+    "version": "0.1.32",
     "description": "Fast, lightweight, cross-platform message box - Rust-powered alternative to msgview",
     "type": "module",
     "main": "./index.js",