autotype-rs 1.3.2 → 1.5.0

package/README.md

@@ -2,25 +2,55 @@
 
 Compact Rust typing app for **Windows x64** and **Linux x64**, supporting both
 **X11/Xorg** and **Wayland**. Adjustable delay (0.1–3600 seconds, default 2), custom
-header, and dark/light themes.
+header, custom global Start/Stop shortcuts, instant start, and dark/light themes.
 
 ```sh
-npx autotype-rs@1.3.2
-bunx --bun autotype-rs@1.3.2
+npx autotype-rs@1.5.0
+bunx --bun autotype-rs@1.5.0
 # or install once:
-npm install -g autotype-rs@1.3.2
+npm install -g autotype-rs@1.5.0
 autotype-rs
 ```
 
 Enter text, choose a delay, click **Start typing**, and focus your destination.
-On Wayland, click **Enable typing** and approve the desktop keyboard-control dialog
-first. Cancel or return to the app to stop; Escape works globally on Windows/X11
-and when the app is focused on Wayland. Windows/X11 stop if the destination window
-changes. Wayland cannot monitor other windows' focus, so changing destinations can
-redirect the remaining text.
-
-Wayland needs a desktop portal backend with RemoteDesktop keyboard-control support
-(compatible GNOME/KDE installations). Xwayland does not bypass that requirement.
+On Wayland, click **Enable typing** and approve the desktop keyboard-control dialog.
+Cancel works during approval and typing; returning to the app also stops typing.
+Escape works globally on Windows/X11 and when focused on Wayland. Custom global
+Start/Stop shortcuts are available in **Keys**.
+
+Open **Keys** to enable and customize global shortcuts. Defaults are
+**Ctrl+Shift+F6** (Start) and **Ctrl+Shift+F7** (Stop). Focus your destination and
+release the full Start shortcut. Instant typing is available on Windows/X11 and
+protected GNOME sessions. Other Wayland paths require your selected positive
+countdown; release all shortcut keys before it ends. Clear **Start shortcut skips
+the delay** to use the delay where Instant is supported; the regular Start button
+still uses it.
+Shortcuts are off until enabled. Shortcut settings are saved across launches;
+entered text stays in memory.
+
+On Wayland, the desktop chooses and approves your shortcuts in its dialog.
+Global shortcuts also require a GlobalShortcuts portal backend; keyboard control
+still needs **Enable typing**. The app displays the approved combinations.
+**Change in desktop…** requires GlobalShortcuts version 2; with older versions,
+disable and enable shortcuts to reassign them. Release the full shortcut before
+typing. Portal closure or restart cancels typing and clears approved bindings;
+enable shortcuts again to rebind. Wayland creates a hidden desktop entry for portal
+identification.
+
+Wayland's **Protect destination** defaults on, with adapters for GNOME, KDE Plasma,
+Hyprland and Sway. GNOME needs the bundled companion extension; export it with
+`autotype-rs --export-gnome-extension NEW_DIRECTORY`, then install and enable it as
+explained in the [Wayland setup guide](https://github.com/Jeremiah-C27/autotype/blob/v1.5.0/docs/wayland.md).
+KDE uses a temporary script. The guard stops on window changes or adapter failure;
+it cannot protect individual fields/tabs or make checking and input atomic.
+Explicitly disabling it allows destination changes to redirect the remaining text.
+**Remember permission** saves only a private portal restore token, if the desktop
+allows it. **Disconnect** closes the session and forgets the local token.
+
+All four Wayland desktops still need a portal backend with RemoteDesktop
+keyboard-control support. Focus adapters do not supply missing keyboard permission;
+some Hyprland/Sway portal installations offer only screenshots/screencasts.
+Xwayland does not bypass that requirement.
 Linux needs a graphical session, glibc 2.35+, OpenGL/EGL, libxkbcommon and, on X11,
 libxkbcommon-x11. On Debian/Ubuntu:
 
@@ -31,7 +61,8 @@ sudo apt install libgl1 libegl1 libxkbcommon0 libxkbcommon-x11-0
 No Rust compiler is required. Both executables are bundled; installation does not
 run an install script or download another binary. Node.js 18+ or Bun is required.
 The GUI runs independently of the terminal. `--help` and `--version` work without
-opening a window. Text stays in memory and is never uploaded or saved.
+opening a window. Text stays in memory and is never uploaded or saved; only
+opt-in permission restoration saves a private desktop token.
 
 For Proxmox/noVNC, match local/guest keyboard layouts and Caps Lock. Windows/X11
 use physical Shift for capitals; Unicode fallback may not work in remote consoles.
@@ -52,3 +83,17 @@ Native Linux builds need Rust and a C compiler. Native Windows builds need Rust
 and Visual Studio C++ tools. CI combines Ubuntu 22.04 and Windows builds into one
 package. Prepack validates both executable formats, metadata, hashes and Linux
 executable permissions. Registry publication requires npm sign-in.
+
+## Updating
+
+Use the package manager rather than a separate app self-updater:
+
+```sh
+npx autotype-rs@latest
+bunx --bun autotype-rs@latest
+# For a global npm install:
+npm install -g autotype-rs@latest
+```
+
+Explicit versions such as `@1.3.2` remain pinned. Close the app before replacing
+its bundled executable. Standalone downloads are updated from GitHub releases.

package/lib/launcher.cjs

@@ -17,7 +17,7 @@ function launch({
   setExitCode = (code) => { process.exitCode = code; },
 } = {}) {
   if (args.length === 1 && ['--help', '-h'].includes(args[0])) {
-    stdout.write('autotype-rs\n\nOpens the Windows or Linux x64 typing app. Enter text, set the delay, click Start typing,\nthen click the destination field. On Wayland, enable keyboard control first.\n');
+    stdout.write('autotype-rs\n\nOpens the Windows or Linux x64 typing app. Enter text, set the delay, click Start typing,\nthen click the destination field. On Wayland, enable keyboard control first.\n\nUpdate a global install: npm install -g autotype-rs@latest\nRun the latest release: npx autotype-rs@latest or bunx --bun autotype-rs@latest\n\nLinux GNOME setup: autotype-rs --export-gnome-extension NEW_DIRECTORY\n');
     return;
   }
   if (args.length === 1 && ['--version', '-v'].includes(args[0])) {
@@ -28,7 +28,8 @@ function launch({
     stderr.write(`autotype-rs: ${message}\n`);
     setExitCode(1);
   };
-  if (args.length !== 0) {
+  const exportGnome = args.length === 2 && args[0] === '--export-gnome-extension' && args[1].length > 0;
+  if (args.length !== 0 && !exportGnome) {
     fail('Unsupported arguments. Run autotype-rs --help for usage.');
     return;
   }
@@ -36,7 +37,11 @@ function launch({
     fail('This app requires x64 Windows or Linux.');
     return;
   }
-  if (platform === 'linux' && !env.DISPLAY && !env.WAYLAND_DISPLAY) {
+  if (exportGnome && platform !== 'linux') {
+    fail('The GNOME extension export requires Linux.');
+    return;
+  }
+  if (!exportGnome && platform === 'linux' && !env.DISPLAY && !env.WAYLAND_DISPLAY) {
     fail('Run this app in a Linux desktop session (X11 or Wayland).');
     return;
   }
@@ -46,16 +51,17 @@ function launch({
     return;
   }
   try {
-    const child = spawn(executable, [], {
-      detached: true,
-      stdio: platform === 'linux' ? ['ignore', 'ignore', 'inherit'] : 'ignore',
+    const child = spawn(executable, exportGnome ? args : [], {
+      detached: !exportGnome,
+      stdio: exportGnome ? 'inherit' : platform === 'linux' ? ['ignore', 'ignore', 'inherit'] : 'ignore',
       shell: false,
     });
     child.once('error', (error) => {
       fail(`Could not start the app (${error.code || 'unknown error'}).`);
     });
+    if (exportGnome) child.once('exit', (code, signal) => { setExitCode(signal ? 1 : (code ?? 1)); });
     child.once('spawn', () => {
-      child.unref();
+      if (!exportGnome) child.unref();
     });
   } catch (error) {
     fail(`Could not start the app (${error.code || 'unknown error'}).`);

package/native/linux-x64/build.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.2",
+  "version": "1.5.0",
   "target": "x86_64-unknown-linux-gnu",
-  "sha256": "7043678d65baa17ab61944c732c53cb64a580052bbe0377a322186c1c2fa0863"
+  "sha256": "d0c6d7ecf8d0e3c578d1f7ff778bf67aa27291e9c17c31f8c7ab5641f49edf0b"
 }

package/native/win32-x64/build.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.2",
+  "version": "1.5.0",
   "target": "x86_64-pc-windows-msvc",
-  "sha256": "3966067df273532e810929240f36cb606359ce550f633176116998f54c798dc3"
+  "sha256": "131f2060dbb5e27802d9e8a642bcd7958e7ad5f09e832057ebf671ae767edba2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "autotype-rs",
-  "version": "1.3.2",
-  "description": "Compact Rust typing app for Windows and Linux X11/Wayland with adjustable delay and dark/light themes",
+  "version": "1.5.0",
+  "description": "Compact Rust typing app for Windows and Linux X11/Wayland with custom global hotkeys, instant start, adjustable delay and dark/light themes",
   "license": "MIT",
   "repository": {
     "type": "git",