@liminal-hq/plugin-desktop-integration 0.1.0 → 0.2.0

package/README.md

@@ -64,6 +64,12 @@ confirmation dialog. Call `set_shortcut_window(&window)` once your first window
 shown to kick off the deferred binding, and listen for the `shortcut-binding-result`
 event to know when it resolves.
 
+The compositor's own settings UI can also rebind the shortcut independently of the app
+(e.g. GNOME Settings → Apps → <App> → Global Shortcuts) — listen for the
+`shortcut-changed` event (Wayland-only) to keep your own UI in sync.
+`DesktopIntegrationExt::last_shortcut_trigger_description` covers the race where the
+rebind happens before your listener attaches.
+
 ### JavaScript
 
 JS-only apps (no custom Rust command of their own) can register shortcuts directly —
@@ -90,18 +96,37 @@ Rust consumers should prefer calling `DesktopIntegrationExt::register_shortcut`
 from `setup()` — it delivers activation via a real closure instead of an event
 round-trip. The `register_shortcut` command exists specifically for JS-only consumers.
 
+To detect an external rebind (Wayland-only), listen for `shortcut-changed` directly via
+`@tauri-apps/api/event`, and use `checkShortcutTriggerDescription` as a race guard for
+UI that mounts after a missed event:
+
+```typescript
+import { listen } from '@tauri-apps/api/event';
+import {
+	desktopIntegration,
+	type ShortcutChangedPayload,
+} from '@liminal-hq/plugin-desktop-integration';
+
+await listen<ShortcutChangedPayload>('shortcut-changed', ({ payload }) => {
+	console.log(`rebound externally to: ${payload.triggerDescription}`);
+});
+
+const lastKnownTrigger = await desktopIntegration.checkShortcutTriggerDescription();
+```
+
 ### Generated types
 
-`ShortcutBindingResult` and `ShortcutActivatedPayload` (the payloads of the
-`shortcut-binding-result` and `shortcut-activated` events) are generated from their Rust
-definitions via [`ts-rs`](https://github.com/Aleph-Alpha/ts-rs) into
-`guest-js/bindings/` and re-exported from the package root, so the JS/Rust shapes can't
-drift:
+`ShortcutBindingResult`, `ShortcutActivatedPayload`, and `ShortcutChangedPayload` (the
+payloads of the `shortcut-binding-result`, `shortcut-activated`, and `shortcut-changed`
+events) are generated from their Rust definitions via
+[`ts-rs`](https://github.com/Aleph-Alpha/ts-rs) into `guest-js/bindings/` and re-exported
+from the package root, so the JS/Rust shapes can't drift:
 
 ```typescript
 import type {
 	ShortcutActivatedPayload,
 	ShortcutBindingResult,
+	ShortcutChangedPayload,
 } from '@liminal-hq/plugin-desktop-integration';
 ```
 
@@ -116,6 +141,7 @@ This plugin requires these permissions:
 - `allow-register-shortcut`: Grants access to `register_shortcut`
 - `allow-check-shortcut-binding-complete`: Grants access to `check_shortcut_binding_complete`
 - `allow-check-shortcut-binding-error`: Grants access to `check_shortcut_binding_error`
+- `allow-check-shortcut-trigger-description`: Grants access to `check_shortcut_trigger_description`
 
 ## Platform Support
 

package/api-iife.js

@@ -49,6 +49,14 @@ var __TAURI_PLUGIN_DESKTOP_INTEGRATION__ = (function (exports, core, event) {
          * shortcut-binding-result listener — complements checkShortcutBindingComplete.
          */
         checkShortcutBindingError: () => cmd('check_shortcut_binding_error'),
+        /**
+         * Returns the trigger description (e.g. "Super+E") from the most recent
+         * shortcut-changed event, or null if the shortcut hasn't been externally
+         * rebound yet this session. Use this to hydrate UI that mounts after a missed
+         * event — listen for the `shortcut-changed` event directly via
+         * `@tauri-apps/api/event`'s `listen()` for live updates.
+         */
+        checkShortcutTriggerDescription: () => cmd('check_shortcut_trigger_description'),
     };
 
     exports.desktopIntegration = desktopIntegration;

package/dist-js/bindings/ShortcutChangedPayload.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Payload emitted on the `shortcut-changed` event, fired when the user rebinds the
+ * shortcut through the compositor's own settings UI (e.g. GNOME Settings → Apps →
+ * <App> → Global Shortcuts) rather than through this app. Wayland-only — X11 direct
+ * grabs have no equivalent out-of-band rebind path, so this never fires there.
+ */
+export type ShortcutChangedPayload = {
+    sessionId: string;
+    triggerDescription: string;
+};
+//# sourceMappingURL=ShortcutChangedPayload.d.ts.map

package/dist-js/bindings/ShortcutChangedPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShortcutChangedPayload.d.ts","sourceRoot":"","sources":["../../guest-js/bindings/ShortcutChangedPayload.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAC;CAAE,CAAC"}

package/dist-js/index.cjs

@@ -50,6 +50,14 @@ const desktopIntegration = {
      * shortcut-binding-result listener — complements checkShortcutBindingComplete.
      */
     checkShortcutBindingError: () => cmd('check_shortcut_binding_error'),
+    /**
+     * Returns the trigger description (e.g. "Super+E") from the most recent
+     * shortcut-changed event, or null if the shortcut hasn't been externally
+     * rebound yet this session. Use this to hydrate UI that mounts after a missed
+     * event — listen for the `shortcut-changed` event directly via
+     * `@tauri-apps/api/event`'s `listen()` for live updates.
+     */
+    checkShortcutTriggerDescription: () => cmd('check_shortcut_trigger_description'),
 };
 
 exports.desktopIntegration = desktopIntegration;

package/dist-js/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":["invoke","listen"],"mappings":";;;;;AAAA;AACA;AACA;AACA;AASA,MAAM,MAAM,GAAG,6BAA6B;AAE5C,SAAS,GAAG,CAAI,IAAY,EAAE,IAA8B,EAAA;IAC3D,OAAOA,WAAM,CAAI,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE,IAAI,CAAC;AAC3C;AAEA,IAAI,kBAAkB,GAAwB,IAAI;AAClD,IAAI,mBAAmB,GAA4B,IAAI;AAEvD,SAAS,wBAAwB,GAAA;AAChC,IAAA,IAAI,mBAAmB;QAAE;AACzB,IAAA,mBAAmB,GAAGC,YAAM,CAA2B,oBAAoB,EAAE,MAAK;QACjF,kBAAkB,IAAI;AACvB,IAAA,CAAC,CAAC;AACH;AAEO,MAAM,kBAAkB,GAAG;AACjC;;;;;;;;;;;AAWG;IACH,gBAAgB,EAAE,CACjB,SAAiB,EACjB,kBAA0B,EAC1B,QAAgB,EAChB,WAAuB,KACL;QAClB,kBAAkB,GAAG,WAAW;AAChC,QAAA,wBAAwB,EAAE;AAC1B,QAAA,OAAO,GAAG,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IAC7E,CAAC;AAED;;;;AAIG;AACH,IAAA,4BAA4B,EAAE,MAAM,GAAG,CAAU,iCAAiC,CAAC;AAEnF;;;;AAIG;AACH,IAAA,yBAAyB,EAAE,MAAM,GAAG,CAAgB,8BAA8B,CAAC;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":["invoke","listen"],"mappings":";;;;;AAAA;AACA;AACA;AACA;AAUA,MAAM,MAAM,GAAG,6BAA6B;AAE5C,SAAS,GAAG,CAAI,IAAY,EAAE,IAA8B,EAAA;IAC3D,OAAOA,WAAM,CAAI,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE,IAAI,CAAC;AAC3C;AAEA,IAAI,kBAAkB,GAAwB,IAAI;AAClD,IAAI,mBAAmB,GAA4B,IAAI;AAEvD,SAAS,wBAAwB,GAAA;AAChC,IAAA,IAAI,mBAAmB;QAAE;AACzB,IAAA,mBAAmB,GAAGC,YAAM,CAA2B,oBAAoB,EAAE,MAAK;QACjF,kBAAkB,IAAI;AACvB,IAAA,CAAC,CAAC;AACH;AAEO,MAAM,kBAAkB,GAAG;AACjC;;;;;;;;;;;AAWG;IACH,gBAAgB,EAAE,CACjB,SAAiB,EACjB,kBAA0B,EAC1B,QAAgB,EAChB,WAAuB,KACL;QAClB,kBAAkB,GAAG,WAAW;AAChC,QAAA,wBAAwB,EAAE;AAC1B,QAAA,OAAO,GAAG,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IAC7E,CAAC;AAED;;;;AAIG;AACH,IAAA,4BAA4B,EAAE,MAAM,GAAG,CAAU,iCAAiC,CAAC;AAEnF;;;;AAIG;AACH,IAAA,yBAAyB,EAAE,MAAM,GAAG,CAAgB,8BAA8B,CAAC;AAEnF;;;;;;AAMG;AACH,IAAA,+BAA+B,EAAE,MAAM,GAAG,CAAgB,oCAAoC,CAAC;;;;;"}

package/dist-js/index.d.ts

@@ -1,6 +1,7 @@
 import type { ShortcutActivatedPayload } from './bindings/ShortcutActivatedPayload';
 import type { ShortcutBindingResult } from './bindings/ShortcutBindingResult';
-export type { ShortcutActivatedPayload, ShortcutBindingResult };
+import type { ShortcutChangedPayload } from './bindings/ShortcutChangedPayload';
+export type { ShortcutActivatedPayload, ShortcutBindingResult, ShortcutChangedPayload };
 export declare const desktopIntegration: {
     /**
      * Registers a global shortcut. On X11 it's bound immediately; on Wayland,
@@ -27,5 +28,13 @@ export declare const desktopIntegration: {
      * shortcut-binding-result listener — complements checkShortcutBindingComplete.
      */
     checkShortcutBindingError: () => Promise<string | null>;
+    /**
+     * Returns the trigger description (e.g. "Super+E") from the most recent
+     * shortcut-changed event, or null if the shortcut hasn't been externally
+     * rebound yet this session. Use this to hydrate UI that mounts after a missed
+     * event — listen for the `shortcut-changed` event directly via
+     * `@tauri-apps/api/event`'s `listen()` for live updates.
+     */
+    checkShortcutTriggerDescription: () => Promise<string | null>;
 };
 //# sourceMappingURL=index.d.ts.map

package/dist-js/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../guest-js/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAE9E,YAAY,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,CAAC;AAkBhE,eAAO,MAAM,kBAAkB;IAC9B;;;;;;;;;;;OAWG;kCAES,MAAM,sBACG,MAAM,YAChB,MAAM,eACH,MAAM,IAAI,KACrB,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;;IAGH;;;;OAIG;;CAEH,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../guest-js/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAEhF,YAAY,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,CAAC;AAkBxF,eAAO,MAAM,kBAAkB;IAC9B;;;;;;;;;;;OAWG;kCAES,MAAM,sBACG,MAAM,YAChB,MAAM,eACH,MAAM,IAAI,KACrB,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;CAEH,CAAC"}

package/dist-js/index.js

@@ -48,6 +48,14 @@ const desktopIntegration = {
      * shortcut-binding-result listener — complements checkShortcutBindingComplete.
      */
     checkShortcutBindingError: () => cmd('check_shortcut_binding_error'),
+    /**
+     * Returns the trigger description (e.g. "Super+E") from the most recent
+     * shortcut-changed event, or null if the shortcut hasn't been externally
+     * rebound yet this session. Use this to hydrate UI that mounts after a missed
+     * event — listen for the `shortcut-changed` event directly via
+     * `@tauri-apps/api/event`'s `listen()` for live updates.
+     */
+    checkShortcutTriggerDescription: () => cmd('check_shortcut_trigger_description'),
 };
 
 export { desktopIntegration };

package/dist-js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAAA;AACA;AACA;AACA;AASA,MAAM,MAAM,GAAG,6BAA6B;AAE5C,SAAS,GAAG,CAAI,IAAY,EAAE,IAA8B,EAAA;IAC3D,OAAO,MAAM,CAAI,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE,IAAI,CAAC;AAC3C;AAEA,IAAI,kBAAkB,GAAwB,IAAI;AAClD,IAAI,mBAAmB,GAA4B,IAAI;AAEvD,SAAS,wBAAwB,GAAA;AAChC,IAAA,IAAI,mBAAmB;QAAE;AACzB,IAAA,mBAAmB,GAAG,MAAM,CAA2B,oBAAoB,EAAE,MAAK;QACjF,kBAAkB,IAAI;AACvB,IAAA,CAAC,CAAC;AACH;AAEO,MAAM,kBAAkB,GAAG;AACjC;;;;;;;;;;;AAWG;IACH,gBAAgB,EAAE,CACjB,SAAiB,EACjB,kBAA0B,EAC1B,QAAgB,EAChB,WAAuB,KACL;QAClB,kBAAkB,GAAG,WAAW;AAChC,QAAA,wBAAwB,EAAE;AAC1B,QAAA,OAAO,GAAG,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IAC7E,CAAC;AAED;;;;AAIG;AACH,IAAA,4BAA4B,EAAE,MAAM,GAAG,CAAU,iCAAiC,CAAC;AAEnF;;;;AAIG;AACH,IAAA,yBAAyB,EAAE,MAAM,GAAG,CAAgB,8BAA8B,CAAC;;;;;"}
+{"version":3,"file":"index.js","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAAA;AACA;AACA;AACA;AAUA,MAAM,MAAM,GAAG,6BAA6B;AAE5C,SAAS,GAAG,CAAI,IAAY,EAAE,IAA8B,EAAA;IAC3D,OAAO,MAAM,CAAI,CAAA,EAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAE,EAAE,IAAI,CAAC;AAC3C;AAEA,IAAI,kBAAkB,GAAwB,IAAI;AAClD,IAAI,mBAAmB,GAA4B,IAAI;AAEvD,SAAS,wBAAwB,GAAA;AAChC,IAAA,IAAI,mBAAmB;QAAE;AACzB,IAAA,mBAAmB,GAAG,MAAM,CAA2B,oBAAoB,EAAE,MAAK;QACjF,kBAAkB,IAAI;AACvB,IAAA,CAAC,CAAC;AACH;AAEO,MAAM,kBAAkB,GAAG;AACjC;;;;;;;;;;;AAWG;IACH,gBAAgB,EAAE,CACjB,SAAiB,EACjB,kBAA0B,EAC1B,QAAgB,EAChB,WAAuB,KACL;QAClB,kBAAkB,GAAG,WAAW;AAChC,QAAA,wBAAwB,EAAE;AAC1B,QAAA,OAAO,GAAG,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IAC7E,CAAC;AAED;;;;AAIG;AACH,IAAA,4BAA4B,EAAE,MAAM,GAAG,CAAU,iCAAiC,CAAC;AAEnF;;;;AAIG;AACH,IAAA,yBAAyB,EAAE,MAAM,GAAG,CAAgB,8BAA8B,CAAC;AAEnF;;;;;;AAMG;AACH,IAAA,+BAA+B,EAAE,MAAM,GAAG,CAAgB,oCAAoC,CAAC;;;;;"}

package/dist-js/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist-js/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../guest-js/index.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@liminal-hq/plugin-desktop-integration",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"license": "Apache-2.0 OR MIT",
 	"authors": [
 		"Liminal HQ Contributors"