@cosmicdrift/kumiko-renderer-web 0.79.2 → 0.79.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-renderer-web",
-  "version": "0.79.2",
+  "version": "0.79.3",
   "description": "Web-platform bindings for @cosmicdrift/kumiko-renderer. HTML default-primitives, browser history-based navigation, EventSource-backed live events, and a one-call createKumikoApp that mounts the whole stack via react-dom.",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -16,9 +16,9 @@
     "./styles.css": "./src/styles.css"
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-dispatcher-live": "0.79.2",
-    "@cosmicdrift/kumiko-headless": "0.79.2",
-    "@cosmicdrift/kumiko-renderer": "0.79.2",
+    "@cosmicdrift/kumiko-dispatcher-live": "0.79.3",
+    "@cosmicdrift/kumiko-headless": "0.79.3",
+    "@cosmicdrift/kumiko-renderer": "0.79.3",
     "@radix-ui/react-dialog": "^1.1.15",
     "@radix-ui/react-dropdown-menu": "^2.1.16",
     "@radix-ui/react-label": "^2.1.8",

package/src/__tests__/download.test.ts

@@ -0,0 +1,52 @@
+import { describe, expect, spyOn, test } from "bun:test";
+import type { Dispatcher, DispatcherError } from "@cosmicdrift/kumiko-headless";
+import { postWithDownload } from "../lib/download";
+
+function dispatcherReturning(result: unknown): Dispatcher {
+  return { query: async () => result } as unknown as Dispatcher; // @cast-boundary test-stub
+}
+
+describe("postWithDownload", () => {
+  test("success: navigates to the returned signed URL, returns null", async () => {
+    const assign = spyOn(window.location, "assign").mockImplementation(() => {});
+    const url = "https://store.example/export.zip?sig=abc";
+    const err = await postWithDownload(
+      dispatcherReturning({ isSuccess: true, data: { url } }),
+      "f:query:download-by-job",
+      { jobId: "j1" },
+    );
+    expect(err).toBeNull();
+    expect(assign).toHaveBeenCalledWith(url);
+    assign.mockRestore();
+  });
+
+  test("query failure: returns the dispatcher error, no navigation", async () => {
+    const assign = spyOn(window.location, "assign").mockImplementation(() => {});
+    const error: DispatcherError = {
+      code: "not_found",
+      httpStatus: 404,
+      i18nKey: "userDataRights.errors.download.notFound",
+      message: "nope",
+    };
+    const err = await postWithDownload(
+      dispatcherReturning({ isSuccess: false, error }),
+      "f:query:download-by-job",
+      { jobId: "j1" },
+    );
+    expect(err).toEqual(error);
+    expect(assign).not.toHaveBeenCalled();
+    assign.mockRestore();
+  });
+
+  test("success but no url: returns synthetic error, no navigation", async () => {
+    const assign = spyOn(window.location, "assign").mockImplementation(() => {});
+    const err = await postWithDownload(
+      dispatcherReturning({ isSuccess: true, data: {} }),
+      "f:query:download-by-job",
+      { jobId: "j1" },
+    );
+    expect(err?.code).toBe("download_url_missing");
+    expect(assign).not.toHaveBeenCalled();
+    assign.mockRestore();
+  });
+});

package/src/index.ts

@@ -122,6 +122,7 @@ export { filterByAccess, resolveDefaultId, WorkspaceShell } from "./layout/works
 export type { WorkspaceSwitcherProps } from "./layout/workspace-switcher";
 export { WorkspaceSwitcher } from "./layout/workspace-switcher";
 export { cn } from "./lib/cn";
+export { postWithDownload } from "./lib/download";
 export { BareFormProvider, defaultPrimitives } from "./primitives";
 export type { ActionMenuProps, MenuItemDef } from "./primitives/action-menu";
 export { ActionMenu } from "./primitives/action-menu";

package/src/lib/download.ts

@@ -0,0 +1,29 @@
+import type { Dispatcher, DispatcherError } from "@cosmicdrift/kumiko-headless";
+
+// Dispatch a query/handler whose result carries `{ url }` (a signed,
+// short-lived storage URL with `content-disposition: attachment`), then
+// navigate the browser to it so the file downloads. The query rides the
+// live dispatcher, so it carries the `X-CSRF-Token` header automatically —
+// unlike a plain `<a href>` navigation, which sends only cookies and trips
+// the CSRF double-submit check on any server-side re-dispatch.
+//
+// Web-only (uses `window`). Returns the dispatcher error on failure (so the
+// caller can surface its i18nKey), or null on success.
+export async function postWithDownload(
+  dispatcher: Dispatcher,
+  type: string,
+  payload: unknown,
+): Promise<DispatcherError | null> {
+  const res = await dispatcher.query<{ url?: string }>(type, payload);
+  if (!res.isSuccess) return res.error;
+  if (!res.data?.url) {
+    return {
+      code: "download_url_missing",
+      httpStatus: 502,
+      i18nKey: "errors.download.urlMissing",
+      message: "download query returned no url",
+    };
+  }
+  window.location.assign(res.data.url);
+  return null;
+}