@multiplatform.one/desktop 6.7.0 → 7.0.0

package/README.md

@@ -1,8 +1,8 @@
 # @multiplatform.one/desktop
 
-Desktop platform APIs for multiplatform.one [Tauri](https://tauri.app) apps —
-file system, dialogs, paths, and updater behind one interface that no-ops (or
-throws clearly) on non-desktop platforms.
+Capability interfaces for desktop-only concerns — file system, dialogs, paths,
+and updater — behind one import that no-ops (or throws clearly) everywhere the
+capability does not exist.
 
 ## Install
 
@@ -10,8 +10,9 @@ throws clearly) on non-desktop platforms.
 pnpm add @multiplatform.one/desktop
 ```
 
-Peers (desktop builds only): `@tauri-apps/api`, `@tauri-apps/plugin-dialog`,
-`@tauri-apps/plugin-fs`, `@tauri-apps/plugin-updater`.
+Peers (Tauri builds only, all optional): `@tauri-apps/api`,
+`@tauri-apps/plugin-dialog`, `@tauri-apps/plugin-fs`,
+`@tauri-apps/plugin-updater`.
 
 ## What it owns
 
@@ -21,23 +22,40 @@ Peers (desktop builds only): `@tauri-apps/api`, `@tauri-apps/plugin-dialog`,
 - **`paths`** — well-known directories (home, app data, …)
 - **`updater`** — check/install app updates
 
-Each API has a web default and a `.tauri` implementation selected at build
-time, so shared code can import unconditionally and gate at runtime with
-`isTauri` from `@multiplatform.one/platform`.
+Each API is an interface plus a default implementation, so shared code (for
+example `@multiplatform.one/frappe-ui`'s `FrappeForm` delete confirm) can
+import it unconditionally on every platform.
+
+> **State of play.** Tauri is the one backend with a full implementation:
+> each API has a `.tauri` file (selected at build time in Tauri bundles) that
+> rides the matching `@tauri-apps/plugin-*` peer. A Tauri window running the
+> plain web bundle (dev mode) gets the web defaults, which work there — the
+> webview has the browser modals.
+>
+> Outside Tauri: `dialog.message`, `.ask`, `.confirm` and `.prompt` are the
+> browser's modal globals and are therefore **web-only**. On GNOME they
+> **throw** a named error: GJS has no `window.confirm`, and neither silently
+> returning `false` (a confirm button that appears broken) nor silently
+> returning `true` (a delete nobody agreed to) is a defensible default for a
+> confirmation. `dialog.open` and `.save` return `null` on both. `fs` and
+> `paths` report unsupported outside Tauri; `updater` is a no-op there.
+>
+> The GNOME target has real GTK equivalents available (`Gtk.FileDialog`,
+> `Adw.AlertDialog`, `GLib.get_user_*_dir`); wiring them up as
+> `index.gnome.ts` files behind these same interfaces is the natural next
+> step — the interfaces exist precisely so that lands as an implementation
+> rather than an API change.
 
 ## What it must not do
 
-- No UI and no Tauri window management — this package wraps capability
-  plugins, not chrome
+- No UI and no window management — this package wraps capabilities, not chrome
 
 ## Usage
 
 ```ts
 import { dialog, fs } from "@multiplatform.one/desktop";
-import { isTauri } from "@multiplatform.one/platform";
 
 export async function exportNotes(contents: string) {
-  if (!isTauri) return; // web/native fall back elsewhere
   const path = await dialog.save({ defaultPath: "notes.md" });
   if (!path) return;
   await fs.writeTextFile(path, contents);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/desktop",
-  "version": "6.7.0",
+  "version": "7.0.0",
   "description": "Desktop platform APIs (Tauri) for multiplatform.one",
   "keywords": [
     "desktop",
@@ -61,6 +61,7 @@
   },
   "scripts": {
     "typecheck": "tsgo --noEmit",
-    "build": "rm -rf types 2>/dev/null && tsc -p tsconfig.build.json"
+    "build": "rm -rf types 2>/dev/null && tsc -p tsconfig.build.json",
+    "test": "vitest run --coverage --coverage.provider=v8 --coverage.reporter=text --coverage.reporter=lcov --coverage.reporter=html"
   }
 }

package/src/dialog/dialog.spec.ts

@@ -91,3 +91,47 @@ describe("dialog web stubs", () => {
     });
   });
 });
+
+/**
+ * GJS's `window` is a react-gnome polyfill stub with none of the modal
+ * globals on it. Reproduce that shape rather than deleting `window`, because
+ * `typeof window !== "undefined"` is true on GNOME and a guard written only
+ * against a missing `window` would sail straight past it.
+ */
+describe("dialog defaults on a platform with no modal globals (GJS)", () => {
+  beforeEach(() => {
+    for (const name of ["alert", "confirm", "prompt"] as const) {
+      vi.stubGlobal(name, undefined);
+      Reflect.deleteProperty(window, name);
+    }
+  });
+
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+
+  it("still has a window, exactly as GNOME does", () => {
+    expect(typeof window).not.toBe("undefined");
+  });
+
+  it.each([
+    ["message", () => dialog.message("hi")],
+    ["ask", () => dialog.ask("sure?")],
+    ["confirm", () => dialog.confirm("delete?")],
+    ["prompt", () => dialog.prompt("name?")],
+  ])("dialog.%s rejects instead of throwing a bare TypeError", async (api, call) => {
+    await expect(call()).rejects.toThrow(
+      new RegExp(`dialog\\.${api} needs window\\.(alert|confirm|prompt)`),
+    );
+  });
+
+  it("names the package and points at the GNOME backend that would fix it", async () => {
+    await expect(dialog.confirm("delete?")).rejects.toThrow(/@multiplatform.one\/desktop/);
+    await expect(dialog.confirm("delete?")).rejects.toThrow(/index\.gnome\.ts/);
+  });
+
+  it("leaves open and save working, since their default is an honest null", async () => {
+    expect(await dialog.open()).toBeNull();
+    expect(await dialog.save()).toBeNull();
+  });
+});

package/src/dialog/index.ts

@@ -39,26 +39,65 @@ export interface DialogApi {
   prompt(message: string, defaultValue?: string): Promise<string | null>;
 }
 
-// Default web implementation using browser APIs
+/**
+ * The default `message`/`ask`/`confirm`/`prompt` are the browser's modal
+ * globals, so they are **web-only** — not the "safe default every platform
+ * gets" the docs used to claim.
+ *
+ * GJS is the case that matters: react-gnome's polyfills define a stub
+ * `window` with no `alert`, `confirm` or `prompt` on it, so these used to
+ * dereference `undefined` and throw a bare `TypeError` from inside a shared
+ * package, at whatever unrelated call site happened to trigger a confirm.
+ * Failing with a named error that says which platform is missing which
+ * capability is strictly better than that, and better than the other
+ * tempting option — quietly returning `false` — because a delete confirm
+ * that silently answers "no" looks like a broken button, while one that
+ * silently answers "yes" deletes something nobody confirmed.
+ *
+ * The real fix is `dialog/index.gnome.ts` on `Adw.AlertDialog`, resolved by
+ * the `.gnome.*` extensions the GNOME vite config registers. Until then this
+ * throws, loudly, on GNOME.
+ */
+function browserDialog<Name extends "alert" | "confirm" | "prompt">(
+  name: Name,
+  api: string,
+): NonNullable<Window[Name]> {
+  const fn = typeof window === "undefined" ? undefined : window[name];
+  if (typeof fn !== "function") {
+    throw new Error(
+      `@multiplatform.one/desktop: dialog.${api} needs window.${name}, which this platform does not have. ` +
+        `The dialog defaults are the browser's modal globals and are web-only; GNOME needs an Adw.AlertDialog ` +
+        `backend in dialog/index.gnome.ts.`,
+    );
+  }
+  return fn.bind(window) as NonNullable<Window[Name]>;
+}
+
 export const dialog: DialogApi = {
   async open(_options?: OpenDialogOptions): Promise<string | string[] | null> {
-    // Browser file input could be used here, but returning null for simplicity
+    // No browser equivalent that returns a path; an <input type="file"> hands
+    // back a File, not a filename the fs API could then open.
     return null;
   },
   async save(_options?: SaveDialogOptions): Promise<string | null> {
-    // Browser download could be used here, but returning null for simplicity
     return null;
   },
   async message(message: string, options?: MessageDialogOptions): Promise<void> {
-    window.alert(options?.title ? `${options.title}\n\n${message}` : message);
+    browserDialog("alert", "message")(options?.title ? `${options.title}\n\n${message}` : message);
   },
   async ask(message: string, options?: ConfirmDialogOptions): Promise<boolean> {
-    return window.confirm(options?.title ? `${options.title}\n\n${message}` : message);
+    return browserDialog(
+      "confirm",
+      "ask",
+    )(options?.title ? `${options.title}\n\n${message}` : message);
   },
   async confirm(message: string, options?: ConfirmDialogOptions): Promise<boolean> {
-    return window.confirm(options?.title ? `${options.title}\n\n${message}` : message);
+    return browserDialog(
+      "confirm",
+      "confirm",
+    )(options?.title ? `${options.title}\n\n${message}` : message);
   },
   async prompt(message: string, defaultValue = ""): Promise<string | null> {
-    return window.prompt(message, defaultValue);
+    return browserDialog("prompt", "prompt")(message, defaultValue);
   },
 };

package/src/updater/index.ts

@@ -1,10 +1,12 @@
 /**
  * Auto-updater API for desktop applications
  *
- * This module provides a platform-agnostic interface for checking and installing
- * application updates. The actual implementation differs by platform:
- * - Tauri: Uses tauri-plugin-updater
- * - Web/Mobile: No-op (updates handled by app stores or service workers)
+ * A platform-agnostic interface for checking and installing application
+ * updates. The Tauri target implements it via tauri-plugin-updater (the
+ * `.tauri` file next door). Everywhere else `isSupported()` returning false
+ * is the honest answer — web and mobile get updates from the service worker
+ * or the app store, and the GNOME target is installed by the system package
+ * manager.
  */
 
 export interface UpdateInfo {

package/types/dialog/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dialog/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACrE,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1D,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3E,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACxE;AAGD,eAAO,MAAM,MAAM,EAAE,SAqBpB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dialog/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACrE,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1D,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3E,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACxE;AAoCD,eAAO,MAAM,MAAM,EAAE,SA2BpB,CAAC"}

package/types/updater/index.d.ts

@@ -1,10 +1,12 @@
 /**
  * Auto-updater API for desktop applications
  *
- * This module provides a platform-agnostic interface for checking and installing
- * application updates. The actual implementation differs by platform:
- * - Tauri: Uses tauri-plugin-updater
- * - Web/Mobile: No-op (updates handled by app stores or service workers)
+ * A platform-agnostic interface for checking and installing application
+ * updates. The Tauri target implements it via tauri-plugin-updater (the
+ * `.tauri` file next door). Everywhere else `isSupported()` returning false
+ * is the honest answer — web and mobile get updates from the service worker
+ * or the app store, and the GNOME target is installed by the system package
+ * manager.
  */
 export interface UpdateInfo {
     version: string;

package/types/updater/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/updater/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAE9C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9E;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;CACxB;AAGD,eAAO,MAAM,OAAO,EAAE,UAYrB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/updater/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAE9C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9E;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;CACxB;AAGD,eAAO,MAAM,OAAO,EAAE,UAYrB,CAAC"}