skybridge 0.0.0-dev.e1b8fe1 → 0.0.0-dev.e1ca873

package/dist/web/hooks/use-deep-link.js

@@ -0,0 +1,60 @@
+import { useMcpAppContext } from "../bridges/index.js";
+function toUrl(deepLink) {
+    if (typeof deepLink !== "object" || deepLink === null) {
+        return undefined;
+    }
+    if ("url" in deepLink) {
+        return deepLink.url;
+    }
+    if ("path" in deepLink &&
+        Array.isArray(deepLink.path) &&
+        deepLink.path.every((segment) => typeof segment === "string") &&
+        "query" in deepLink &&
+        Array.isArray(deepLink.query) &&
+        deepLink.query.every((pair) => Array.isArray(pair) &&
+            pair.length === 2 &&
+            pair.every((part) => typeof part === "string"))) {
+        try {
+            const search = new URLSearchParams(deepLink.query).toString();
+            const path = deepLink.path.map(encodeURIComponent).join("/");
+            return `/${path}${search ? `?${search}` : ""}`;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    return undefined;
+}
+/**
+ * App-relative URL (path and query, e.g. `"/parts?tag=bolt"`) that ChatGPT
+ * opened the view on through a deep link. Updates when the user follows
+ * another deep link while the view is open. `undefined` when the view was not
+ * opened through a deep link, on hosts other than ChatGPT, or when the host
+ * sends a URL that isn't app-relative (it must start with a single `/`) or
+ * that contains a fragment.
+ *
+ * Deep links target global entrypoints: set `openai.entrypoints` to include
+ * `{ type: "global" }` on the tool.
+ *
+ * @example
+ * ```tsx
+ * const deepLink = useDeepLink();
+ * useEffect(() => {
+ *   if (deepLink) navigate(deepLink);
+ * }, [deepLink, navigate]);
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-deep-link
+ */
+export function useDeepLink() {
+    const url = toUrl(useMcpAppContext("openai/deepLink"));
+    if (typeof url !== "string" ||
+        !url.startsWith("/") ||
+        url.startsWith("//") ||
+        url.startsWith("/\\") ||
+        url.includes("#")) {
+        return undefined;
+    }
+    return url;
+}
+//# sourceMappingURL=use-deep-link.js.map

package/dist/web/hooks/use-deep-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-deep-link.js","sourceRoot":"","sources":["../../../src/web/hooks/use-deep-link.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,SAAS,KAAK,CAAC,QAAiB;IAC9B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,IAAI,QAAQ,EAAE,CAAC;QACtB,OAAO,QAAQ,CAAC,GAAG,CAAC;IACtB,CAAC;IACD,IACE,MAAM,IAAI,QAAQ;QAClB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC;QAC7D,OAAO,IAAI,QAAQ;QACnB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,KAAK,CAClB,CAAC,IAAI,EAAE,EAAE,CACP,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YACnB,IAAI,CAAC,MAAM,KAAK,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CACjD,EACD,CAAC;QACD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,GAAG,GAAG,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACvD,IACE,OAAO,GAAG,KAAK,QAAQ;QACvB,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;QACpB,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;QACpB,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC;QACrB,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EACjB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { useMcpAppContext } from \"../bridges/index.js\";\n\nfunction toUrl(deepLink: unknown): unknown {\n  if (typeof deepLink !== \"object\" || deepLink === null) {\n    return undefined;\n  }\n  if (\"url\" in deepLink) {\n    return deepLink.url;\n  }\n  if (\n    \"path\" in deepLink &&\n    Array.isArray(deepLink.path) &&\n    deepLink.path.every((segment) => typeof segment === \"string\") &&\n    \"query\" in deepLink &&\n    Array.isArray(deepLink.query) &&\n    deepLink.query.every(\n      (pair) =>\n        Array.isArray(pair) &&\n        pair.length === 2 &&\n        pair.every((part) => typeof part === \"string\"),\n    )\n  ) {\n    try {\n      const search = new URLSearchParams(deepLink.query).toString();\n      const path = deepLink.path.map(encodeURIComponent).join(\"/\");\n      return `/${path}${search ? `?${search}` : \"\"}`;\n    } catch {\n      return undefined;\n    }\n  }\n  return undefined;\n}\n\n/**\n * App-relative URL (path and query, e.g. `\"/parts?tag=bolt\"`) that ChatGPT\n * opened the view on through a deep link. Updates when the user follows\n * another deep link while the view is open. `undefined` when the view was not\n * opened through a deep link, on hosts other than ChatGPT, or when the host\n * sends a URL that isn't app-relative (it must start with a single `/`) or\n * that contains a fragment.\n *\n * Deep links target global entrypoints: set `openai.entrypoints` to include\n * `{ type: \"global\" }` on the tool.\n *\n * @example\n * ```tsx\n * const deepLink = useDeepLink();\n * useEffect(() => {\n *   if (deepLink) navigate(deepLink);\n * }, [deepLink, navigate]);\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-deep-link\n */\nexport function useDeepLink(): string | undefined {\n  const url = toUrl(useMcpAppContext(\"openai/deepLink\"));\n  if (\n    typeof url !== \"string\" ||\n    !url.startsWith(\"/\") ||\n    url.startsWith(\"//\") ||\n    url.startsWith(\"/\\\\\") ||\n    url.includes(\"#\")\n  ) {\n    return undefined;\n  }\n  return url;\n}\n"]}

package/dist/web/hooks/use-display-mode.d.ts

@@ -0,0 +1,24 @@
+import type { RequestDisplayMode } from "../bridges/types.js";
+/**
+ * Read and change the view's display mode (`"inline"`, `"pip"`, `"fullscreen"`).
+ *
+ * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the
+ * host to switch modes — the host returns the mode it actually applied, which
+ * may differ from the request. The reported value also updates when the host
+ * changes the mode on its own (e.g. user expands the widget).
+ *
+ * `"modal"` is reachable via {@link useRequestModal}, not this hook. To react
+ * to layout changes that come with display-mode switches (e.g. `maxHeight`),
+ * pair with {@link useViewport}.
+ *
+ * @example
+ * ```tsx
+ * const [mode, setMode] = useDisplayMode();
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
+ */
+export declare function useDisplayMode(): readonly [import("../index.js").DisplayMode, (mode: RequestDisplayMode) => Promise<{
+    mode: RequestDisplayMode;
+}>];

package/dist/web/hooks/use-display-mode.js

@@ -0,0 +1,29 @@
+import { useCallback } from "react";
+import { getAdaptor, useHostContext } from "../bridges/index.js";
+/**
+ * Read and change the view's display mode (`"inline"`, `"pip"`, `"fullscreen"`).
+ *
+ * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the
+ * host to switch modes — the host returns the mode it actually applied, which
+ * may differ from the request. The reported value also updates when the host
+ * changes the mode on its own (e.g. user expands the widget).
+ *
+ * `"modal"` is reachable via {@link useRequestModal}, not this hook. To react
+ * to layout changes that come with display-mode switches (e.g. `maxHeight`),
+ * pair with {@link useViewport}.
+ *
+ * @example
+ * ```tsx
+ * const [mode, setMode] = useDisplayMode();
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
+ */
+export function useDisplayMode() {
+    const displayMode = useHostContext("displayMode");
+    const adaptor = getAdaptor();
+    const setDisplayMode = useCallback((mode) => adaptor.requestDisplayMode(mode), [adaptor]);
+    return [displayMode, setDisplayMode];
+}
+//# sourceMappingURL=use-display-mode.js.map

package/dist/web/hooks/use-display-mode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-display-mode.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGjE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,cAAc,GAAG,WAAW,CAChC,CAAC,IAAwB,EAAE,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAC9D,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,CAAC,WAAW,EAAE,cAAc,CAAU,CAAC;AAChD,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor, useHostContext } from \"../bridges/index.js\";\nimport type { RequestDisplayMode } from \"../bridges/types.js\";\n\n/**\n * Read and change the view's display mode (`\"inline\"`, `\"pip\"`, `\"fullscreen\"`).\n *\n * Returns a tuple `[displayMode, setDisplayMode]`. `setDisplayMode` asks the\n * host to switch modes — the host returns the mode it actually applied, which\n * may differ from the request. The reported value also updates when the host\n * changes the mode on its own (e.g. user expands the widget).\n *\n * `\"modal\"` is reachable via {@link useRequestModal}, not this hook. To react\n * to layout changes that come with display-mode switches (e.g. `maxHeight`),\n * pair with {@link useViewport}.\n *\n * @example\n * ```tsx\n * const [mode, setMode] = useDisplayMode();\n * <button onClick={() => setMode(\"fullscreen\")}>Expand</button>\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-display-mode\n */\nexport function useDisplayMode() {\n  const displayMode = useHostContext(\"displayMode\");\n  const adaptor = getAdaptor();\n  const setDisplayMode = useCallback(\n    (mode: RequestDisplayMode) => adaptor.requestDisplayMode(mode),\n    [adaptor],\n  );\n\n  return [displayMode, setDisplayMode] as const;\n}\n"]}

package/dist/web/hooks/use-display-mode.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/web/hooks/use-display-mode.test-d.js

@@ -0,0 +1,8 @@
+import { expectTypeOf, test } from "vitest";
+test("setDisplayMode only accepts requestable display modes", () => {
+    expectTypeOf().toEqualTypeOf();
+    // @ts-expect-error "modal" is a host state, not a valid request mode
+    const _invalidMode = "modal";
+    void _invalidMode;
+});
+//# sourceMappingURL=use-display-mode.test-d.js.map

package/dist/web/hooks/use-display-mode.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-display-mode.test-d.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI5C,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IAGjE,YAAY,EAET,CAAC,aAAa,EAAsB,CAAC;IAExC,qEAAqE;IACrE,MAAM,YAAY,GAAkC,OAAO,CAAC;IAC5D,KAAK,YAAY,CAAC;AACpB,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type { RequestDisplayMode } from \"../bridges/types.js\";\nimport type { useDisplayMode } from \"./use-display-mode.js\";\n\ntest(\"setDisplayMode only accepts requestable display modes\", () => {\n  type SetDisplayMode = ReturnType<typeof useDisplayMode>[1];\n\n  expectTypeOf<\n    Parameters<SetDisplayMode>[0]\n  >().toEqualTypeOf<RequestDisplayMode>();\n\n  // @ts-expect-error \"modal\" is a host state, not a valid request mode\n  const _invalidMode: Parameters<SetDisplayMode>[0] = \"modal\";\n  void _invalidMode;\n});\n"]}

package/dist/web/hooks/use-display-mode.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/web/hooks/use-display-mode.test.js

@@ -0,0 +1,77 @@
+import { act, fireEvent, renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { AppsSdkBridge } from "../bridges/apps-sdk/bridge.js";
+import { getAdaptor } from "../bridges/get-adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
+import { useDisplayMode } from "./use-display-mode.js";
+describe("useDisplayMode", () => {
+    beforeEach(() => {
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("openai", { view: { mode: "inline" } });
+        vi.stubGlobal("ResizeObserver", MockResizeObserver);
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        vi.resetAllMocks();
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+    });
+    it("should return the current display mode from MCP host context", async () => {
+        vi.stubGlobal("parent", {
+            postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
+        });
+        const { result } = renderHook(() => useDisplayMode());
+        await waitFor(() => {
+            expect(result.current[0]).toBe("inline");
+        });
+    });
+    it("should update display mode on host-context-changed notification", async () => {
+        vi.stubGlobal("parent", {
+            postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
+        });
+        const { result } = renderHook(() => useDisplayMode());
+        await waitFor(() => {
+            expect(result.current[0]).toBe("inline");
+        });
+        act(() => {
+            fireEvent(window, new MessageEvent("message", {
+                source: window.parent,
+                data: {
+                    jsonrpc: "2.0",
+                    method: "ui/notifications/host-context-changed",
+                    params: { displayMode: "fullscreen" },
+                },
+            }));
+        });
+        await waitFor(() => {
+            expect(result.current[0]).toBe("fullscreen");
+        });
+    });
+    it("should call requestDisplayMode on the adaptor when setDisplayMode is called", async () => {
+        vi.stubGlobal("parent", {
+            postMessage: getMcpAppHostPostMessageMock({ displayMode: "inline" }),
+        });
+        const { result } = renderHook(() => useDisplayMode());
+        await waitFor(() => expect(result.current[0]).toBe("inline"));
+        // Patch mcp.getApp to avoid real protocol request
+        const adaptor = getAdaptor();
+        const fakeApp = {
+            requestDisplayMode: vi.fn().mockResolvedValue({ mode: "fullscreen" }),
+        };
+        // biome-ignore lint/suspicious/noExplicitAny: test seam
+        adaptor.mcp.getApp = vi.fn().mockResolvedValue(fakeApp);
+        await act(async () => {
+            await result.current[1]("fullscreen");
+        });
+        expect(fakeApp.requestDisplayMode).toHaveBeenCalledWith({
+            mode: "fullscreen",
+        });
+    });
+});
+//# sourceMappingURL=use-display-mode.test.js.map

package/dist/web/hooks/use-display-mode.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-display-mode.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC/B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACtD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,EAAE;YACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAAC,SAAS,EAAE;gBAC1B,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,uCAAuC;oBAC/C,MAAM,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE;iBACtC;aACF,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC3F,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;SACrE,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE9D,kDAAkD;QAClD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG;YACd,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;SACtE,CAAC;QACF,wDAAwD;QACvD,OAAe,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEjE,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC;YACtD,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, fireEvent, renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { AppsSdkBridge } from \"../bridges/apps-sdk/bridge.js\";\nimport { getAdaptor } from \"../bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport {\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useDisplayMode } from \"./use-display-mode.js\";\n\ndescribe(\"useDisplayMode\", () => {\n  beforeEach(() => {\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"openai\", { view: { mode: \"inline\" } });\n    vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n  });\n\n  it(\"should return the current display mode from MCP host context\", async () => {\n    vi.stubGlobal(\"parent\", {\n      postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n    });\n\n    const { result } = renderHook(() => useDisplayMode());\n\n    await waitFor(() => {\n      expect(result.current[0]).toBe(\"inline\");\n    });\n  });\n\n  it(\"should update display mode on host-context-changed notification\", async () => {\n    vi.stubGlobal(\"parent\", {\n      postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n    });\n\n    const { result } = renderHook(() => useDisplayMode());\n\n    await waitFor(() => {\n      expect(result.current[0]).toBe(\"inline\");\n    });\n\n    act(() => {\n      fireEvent(\n        window,\n        new MessageEvent(\"message\", {\n          source: window.parent,\n          data: {\n            jsonrpc: \"2.0\",\n            method: \"ui/notifications/host-context-changed\",\n            params: { displayMode: \"fullscreen\" },\n          },\n        }),\n      );\n    });\n\n    await waitFor(() => {\n      expect(result.current[0]).toBe(\"fullscreen\");\n    });\n  });\n\n  it(\"should call requestDisplayMode on the adaptor when setDisplayMode is called\", async () => {\n    vi.stubGlobal(\"parent\", {\n      postMessage: getMcpAppHostPostMessageMock({ displayMode: \"inline\" }),\n    });\n\n    const { result } = renderHook(() => useDisplayMode());\n\n    await waitFor(() => expect(result.current[0]).toBe(\"inline\"));\n\n    // Patch mcp.getApp to avoid real protocol request\n    const adaptor = getAdaptor();\n    const fakeApp = {\n      requestDisplayMode: vi.fn().mockResolvedValue({ mode: \"fullscreen\" }),\n    };\n    // biome-ignore lint/suspicious/noExplicitAny: test seam\n    (adaptor as any).mcp.getApp = vi.fn().mockResolvedValue(fakeApp);\n\n    await act(async () => {\n      await result.current[1](\"fullscreen\");\n    });\n\n    expect(fakeApp.requestDisplayMode).toHaveBeenCalledWith({\n      mode: \"fullscreen\",\n    });\n  });\n});\n"]}

package/dist/web/hooks/use-download.d.ts

@@ -0,0 +1,3 @@
+import type { DownloadParams, DownloadResult } from "../bridges/types.js";
+export type DownloadFn = (params: DownloadParams) => Promise<DownloadResult>;
+export declare function useDownload(): DownloadFn;

package/dist/web/hooks/use-download.js

@@ -0,0 +1,7 @@
+import { useCallback } from "react";
+import { getAdaptor } from "../bridges/index.js";
+export function useDownload() {
+    const adaptor = getAdaptor();
+    return useCallback((params) => adaptor.download(params), [adaptor]);
+}
+//# sourceMappingURL=use-download.js.map

package/dist/web/hooks/use-download.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-download.js","sourceRoot":"","sources":["../../../src/web/hooks/use-download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD,MAAM,UAAU,WAAW;IACzB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO,WAAW,CAChB,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EACpC,CAAC,OAAO,CAAC,CACV,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback } from \"react\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport type { DownloadParams, DownloadResult } from \"../bridges/types.js\";\n\nexport type DownloadFn = (params: DownloadParams) => Promise<DownloadResult>;\n\nexport function useDownload(): DownloadFn {\n  const adaptor = getAdaptor();\n  return useCallback<DownloadFn>(\n    (params) => adaptor.download(params),\n    [adaptor],\n  );\n}\n"]}

package/dist/web/hooks/use-download.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/web/hooks/use-download.test.js

@@ -0,0 +1,103 @@
+import { renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
+import { useDownload } from "./use-download.js";
+const params = {
+    contents: [
+        {
+            type: "resource",
+            resource: {
+                uri: "file:///export.json",
+                mimeType: "application/json",
+                text: '{"hello":"world"}',
+            },
+        },
+    ],
+};
+describe("useDownload", () => {
+    describe("apps-sdk host", () => {
+        beforeEach(() => {
+            vi.stubGlobal("openai", {});
+            vi.stubGlobal("skybridge", {});
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+            vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
+        });
+        afterEach(() => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+        });
+        it("returns { isError: true } and logs an error", async () => {
+            const errorSpy = vi.spyOn(console, "error").mockImplementation(() => { });
+            const { result } = renderHook(() => useDownload());
+            const res = await result.current(params);
+            expect(res).toEqual({ isError: true });
+            expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
+        });
+    });
+    describe("mcp-app host without downloadFile capability", () => {
+        beforeEach(() => {
+            vi.stubGlobal("openai", undefined);
+            vi.stubGlobal("skybridge", {});
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+            vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
+        });
+        afterEach(async () => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+        });
+        it("returns { isError: true } and logs an error", async () => {
+            const errorSpy = vi.spyOn(console, "error").mockImplementation(() => { });
+            const { result } = renderHook(() => useDownload());
+            const res = await result.current(params);
+            expect(res).toEqual({ isError: true });
+            expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
+        });
+    });
+    describe("mcp-app host with downloadFile capability", () => {
+        let postMessageMock;
+        beforeEach(() => {
+            vi.stubGlobal("openai", undefined);
+            vi.stubGlobal("skybridge", {});
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+            postMessageMock = getMcpAppHostPostMessageMock({}, { hostCapabilities: { downloadFile: {} } });
+            vi.stubGlobal("parent", { postMessage: postMessageMock });
+        });
+        afterEach(async () => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+        });
+        it("sends ui/download-file with the provided contents", async () => {
+            const { result } = renderHook(() => useDownload());
+            const res = await result.current(params);
+            expect(res).toEqual({});
+            await waitFor(() => {
+                expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
+                    jsonrpc: "2.0",
+                    method: "ui/download-file",
+                    params,
+                }), "*");
+            });
+        });
+        it("returns { isError: true } when the host denies the request", async () => {
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+            postMessageMock = getMcpAppHostPostMessageMock({}, {
+                hostCapabilities: { downloadFile: {} },
+                downloadFileResult: { isError: true },
+            });
+            vi.stubGlobal("parent", { postMessage: postMessageMock });
+            const { result } = renderHook(() => useDownload());
+            const res = await result.current(params);
+            expect(res).toEqual({ isError: true });
+        });
+    });
+});
+//# sourceMappingURL=use-download.test.js.map

package/dist/web/hooks/use-download.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-download.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-download.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,MAAM,GAAmB;IAC7B,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE;gBACR,GAAG,EAAE,qBAAqB;gBAC1B,QAAQ,EAAE,kBAAkB;gBAC5B,IAAI,EAAE,mBAAmB;aAC1B;SACF;KACF;CACF,CAAC;AAEF,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC5B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAC7D,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC5D,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAC7D,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACzD,IAAI,eAAgE,CAAC;QAErE,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;YACpD,eAAe,GAAG,4BAA4B,CAC5C,EAAE,EACF,EAAE,gBAAgB,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,CAC3C,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACxB,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAC1C,MAAM,CAAC,gBAAgB,CAAC;oBACtB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,kBAAkB;oBAC1B,MAAM;iBACP,CAAC,EACF,GAAG,CACJ,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,eAAe,GAAG,4BAA4B,CAC5C,EAAE,EACF;gBACE,gBAAgB,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;gBACtC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;aACtC,CACF,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAE1D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport type { DownloadParams } from \"../bridges/types.js\";\nimport {\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useDownload } from \"./use-download.js\";\n\nconst params: DownloadParams = {\n  contents: [\n    {\n      type: \"resource\",\n      resource: {\n        uri: \"file:///export.json\",\n        mimeType: \"application/json\",\n        text: '{\"hello\":\"world\"}',\n      },\n    },\n  ],\n};\n\ndescribe(\"useDownload\", () => {\n  describe(\"apps-sdk host\", () => {\n    beforeEach(() => {\n      vi.stubGlobal(\"openai\", {});\n      vi.stubGlobal(\"skybridge\", {});\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n      vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n    });\n\n    afterEach(() => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n    });\n\n    it(\"returns { isError: true } and logs an error\", async () => {\n      const errorSpy = vi.spyOn(console, \"error\").mockImplementation(() => {});\n      const { result } = renderHook(() => useDownload());\n\n      const res = await result.current(params);\n\n      expect(res).toEqual({ isError: true });\n      expect(errorSpy).toHaveBeenCalledWith(\n        expect.stringContaining(\"does not support ui/download-file\"),\n      );\n    });\n  });\n\n  describe(\"mcp-app host without downloadFile capability\", () => {\n    beforeEach(() => {\n      vi.stubGlobal(\"openai\", undefined);\n      vi.stubGlobal(\"skybridge\", {});\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n      vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n    });\n\n    afterEach(async () => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n    });\n\n    it(\"returns { isError: true } and logs an error\", async () => {\n      const errorSpy = vi.spyOn(console, \"error\").mockImplementation(() => {});\n      const { result } = renderHook(() => useDownload());\n\n      const res = await result.current(params);\n\n      expect(res).toEqual({ isError: true });\n      expect(errorSpy).toHaveBeenCalledWith(\n        expect.stringContaining(\"does not support ui/download-file\"),\n      );\n    });\n  });\n\n  describe(\"mcp-app host with downloadFile capability\", () => {\n    let postMessageMock: ReturnType<typeof getMcpAppHostPostMessageMock>;\n\n    beforeEach(() => {\n      vi.stubGlobal(\"openai\", undefined);\n      vi.stubGlobal(\"skybridge\", {});\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n      postMessageMock = getMcpAppHostPostMessageMock(\n        {},\n        { hostCapabilities: { downloadFile: {} } },\n      );\n      vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n    });\n\n    afterEach(async () => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n    });\n\n    it(\"sends ui/download-file with the provided contents\", async () => {\n      const { result } = renderHook(() => useDownload());\n\n      const res = await result.current(params);\n\n      expect(res).toEqual({});\n      await waitFor(() => {\n        expect(postMessageMock).toHaveBeenCalledWith(\n          expect.objectContaining({\n            jsonrpc: \"2.0\",\n            method: \"ui/download-file\",\n            params,\n          }),\n          \"*\",\n        );\n      });\n    });\n\n    it(\"returns { isError: true } when the host denies the request\", async () => {\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n      postMessageMock = getMcpAppHostPostMessageMock(\n        {},\n        {\n          hostCapabilities: { downloadFile: {} },\n          downloadFileResult: { isError: true },\n        },\n      );\n      vi.stubGlobal(\"parent\", { postMessage: postMessageMock });\n\n      const { result } = renderHook(() => useDownload());\n\n      const res = await result.current(params);\n\n      expect(res).toEqual({ isError: true });\n    });\n  });\n});\n"]}

package/dist/web/hooks/use-files.d.ts

@@ -0,0 +1,39 @@
+/**
+ * File operations bound to the current host: `upload` a `File`, resolve a
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
+ * native file picker.
+ *
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
+ * picker; it throws if the capability is unavailable.
+ *
+ * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).
+ * To pass an uploaded file to a tool whose input uses {@link FileRef}, first
+ * call `getDownloadUrl` and then build the ref yourself — field names differ
+ * (camelCase on the client, snake_case in the schema) and `download_url` is
+ * required.
+ *
+ * @example
+ * ```tsx
+ * const { upload, getDownloadUrl } = useFiles();
+ * const meta = await upload(file);
+ * const { downloadUrl } = await getDownloadUrl(meta);
+ * callTool({
+ *   document: {
+ *     file_id: meta.fileId,
+ *     download_url: downloadUrl,
+ *     file_name: meta.fileName,
+ *     mime_type: meta.mimeType,
+ *   },
+ * });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-files
+ */
+export declare function useFiles(): {
+    upload: (file: File, options?: import("../index.js").UploadFileOptions) => Promise<import("../index.js").FileMetadata>;
+    getDownloadUrl: (file: import("../index.js").FileMetadata) => Promise<{
+        downloadUrl: string;
+    }>;
+    selectFiles: () => Promise<import("../index.js").FileMetadata[]>;
+};

package/dist/web/hooks/use-files.js

@@ -0,0 +1,42 @@
+import { getAdaptor } from "../bridges/index.js";
+/**
+ * File operations bound to the current host: `upload` a `File`, resolve a
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
+ * native file picker.
+ *
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
+ * picker; it throws if the capability is unavailable.
+ *
+ * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).
+ * To pass an uploaded file to a tool whose input uses {@link FileRef}, first
+ * call `getDownloadUrl` and then build the ref yourself — field names differ
+ * (camelCase on the client, snake_case in the schema) and `download_url` is
+ * required.
+ *
+ * @example
+ * ```tsx
+ * const { upload, getDownloadUrl } = useFiles();
+ * const meta = await upload(file);
+ * const { downloadUrl } = await getDownloadUrl(meta);
+ * callTool({
+ *   document: {
+ *     file_id: meta.fileId,
+ *     download_url: downloadUrl,
+ *     file_name: meta.fileName,
+ *     mime_type: meta.mimeType,
+ *   },
+ * });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-files
+ */
+export function useFiles() {
+    const adaptor = getAdaptor();
+    return {
+        upload: adaptor.uploadFile,
+        getDownloadUrl: adaptor.getFileDownloadUrl,
+        selectFiles: adaptor.selectFiles,
+    };
+}
+//# sourceMappingURL=use-files.js.map

package/dist/web/hooks/use-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,UAAU;QAC1B,cAAc,EAAE,OAAO,CAAC,kBAAkB;QAC1C,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;AACJ,CAAC","sourcesContent":["import { getAdaptor } from \"../bridges/index.js\";\n\n/**\n * File operations bound to the current host: `upload` a `File`, resolve a\n * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's\n * native file picker.\n *\n * Currently Apps-SDK-only — calling any of these from MCP Apps throws.\n * `selectFiles` additionally requires a ChatGPT host version that exposes the\n * picker; it throws if the capability is unavailable.\n *\n * `upload` returns `FileMetadata` (`fileId`, optional `fileName`, `mimeType`).\n * To pass an uploaded file to a tool whose input uses {@link FileRef}, first\n * call `getDownloadUrl` and then build the ref yourself — field names differ\n * (camelCase on the client, snake_case in the schema) and `download_url` is\n * required.\n *\n * @example\n * ```tsx\n * const { upload, getDownloadUrl } = useFiles();\n * const meta = await upload(file);\n * const { downloadUrl } = await getDownloadUrl(meta);\n * callTool({\n *   document: {\n *     file_id: meta.fileId,\n *     download_url: downloadUrl,\n *     file_name: meta.fileName,\n *     mime_type: meta.mimeType,\n *   },\n * });\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-files\n */\nexport function useFiles() {\n  const adaptor = getAdaptor();\n  return {\n    upload: adaptor.uploadFile,\n    getDownloadUrl: adaptor.getFileDownloadUrl,\n    selectFiles: adaptor.selectFiles,\n  };\n}\n"]}

package/dist/web/hooks/use-files.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/web/hooks/use-files.test.js

@@ -0,0 +1,62 @@
+import { renderHook } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { AppsSdkBridge } from "../bridges/apps-sdk/bridge.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { useFiles } from "./use-files.js";
+describe("useFiles", () => {
+    const OpenaiMock = {
+        uploadFile: vi.fn().mockResolvedValue({
+            fileId: `sediment://file_abc123`,
+        }),
+        getFileDownloadUrl: vi.fn(),
+        widgetState: null,
+        setWidgetState: vi.fn(),
+    };
+    beforeEach(() => {
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("openai", OpenaiMock);
+        vi.stubGlobal("parent", { postMessage: vi.fn() });
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        vi.clearAllMocks();
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+    });
+    const dummyFile = new File([], "test.txt");
+    it("should upload a file to ChatGPT", () => {
+        const { result } = renderHook(() => useFiles());
+        result.current.upload(dummyFile);
+        expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, undefined);
+    });
+    it("should upload a file with library option", () => {
+        const { result } = renderHook(() => useFiles());
+        result.current.upload(dummyFile, { library: true });
+        expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, {
+            library: true,
+        });
+    });
+    it("should select files from ChatGPT", async () => {
+        const selectedFiles = [
+            { fileId: "file_1", fileName: "doc.pdf", mimeType: "application/pdf" },
+        ];
+        OpenaiMock.selectFiles = vi.fn().mockResolvedValue(selectedFiles);
+        const { result } = renderHook(() => useFiles());
+        const files = await result.current.selectFiles();
+        expect(OpenaiMock.selectFiles).toHaveBeenCalled();
+        expect(files).toEqual(selectedFiles);
+        delete OpenaiMock.selectFiles;
+    });
+    it("should download a file from ChatGPT", () => {
+        const fileId = "123";
+        const { result } = renderHook(() => useFiles());
+        result.current.getDownloadUrl({ fileId });
+        expect(OpenaiMock.getFileDownloadUrl).toHaveBeenCalledWith({ fileId });
+    });
+});
+//# sourceMappingURL=use-files.test.js.map

package/dist/web/hooks/use-files.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-files.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,MAAM,UAAU,GAA4B;QAC1C,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACpC,MAAM,EAAE,wBAAwB;SACjC,CAAC;QACF,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE;QAC3B,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,EAAE,CAAC,EAAE,EAAE;KACxB,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAC9B,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC/B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAE3C,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,aAAa,GAAG;YACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE;SACvE,CAAC;QACF,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAElE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAErC,OAAO,UAAU,CAAC,WAAW,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { AppsSdkBridge } from \"../bridges/apps-sdk/bridge.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport { useFiles } from \"./use-files.js\";\n\ndescribe(\"useFiles\", () => {\n  const OpenaiMock: Record<string, unknown> = {\n    uploadFile: vi.fn().mockResolvedValue({\n      fileId: `sediment://file_abc123`,\n    }),\n    getFileDownloadUrl: vi.fn(),\n    widgetState: null,\n    setWidgetState: vi.fn(),\n  };\n\n  beforeEach(() => {\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"openai\", OpenaiMock);\n    vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.clearAllMocks();\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n  });\n\n  const dummyFile = new File([], \"test.txt\");\n\n  it(\"should upload a file to ChatGPT\", () => {\n    const { result } = renderHook(() => useFiles());\n\n    result.current.upload(dummyFile);\n    expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, undefined);\n  });\n\n  it(\"should upload a file with library option\", () => {\n    const { result } = renderHook(() => useFiles());\n\n    result.current.upload(dummyFile, { library: true });\n    expect(OpenaiMock.uploadFile).toHaveBeenCalledWith(dummyFile, {\n      library: true,\n    });\n  });\n\n  it(\"should select files from ChatGPT\", async () => {\n    const selectedFiles = [\n      { fileId: \"file_1\", fileName: \"doc.pdf\", mimeType: \"application/pdf\" },\n    ];\n    OpenaiMock.selectFiles = vi.fn().mockResolvedValue(selectedFiles);\n\n    const { result } = renderHook(() => useFiles());\n\n    const files = await result.current.selectFiles();\n    expect(OpenaiMock.selectFiles).toHaveBeenCalled();\n    expect(files).toEqual(selectedFiles);\n\n    delete OpenaiMock.selectFiles;\n  });\n\n  it(\"should download a file from ChatGPT\", () => {\n    const fileId = \"123\";\n    const { result } = renderHook(() => useFiles());\n\n    result.current.getDownloadUrl({ fileId });\n    expect(OpenaiMock.getFileDownloadUrl).toHaveBeenCalledWith({ fileId });\n  });\n});\n"]}

package/dist/web/hooks/use-host.d.ts

@@ -0,0 +1,44 @@
+import type { McpUiHostCapabilities } from "@modelcontextprotocol/ext-apps";
+/**
+ * Known host applications, as normalized slugs. Unrecognized hosts surface
+ * their raw `hostInfo.name` string instead.
+ */
+export type Host = "chatgpt" | "claude" | "cursor" | "goose" | "mistral-vibe" | "alpic";
+/**
+ * OpenAI MCP extensions the host advertises. Each flag is `true` only when the
+ * host sends a truthy `hostCapabilities.experimental["openai/<name>"]`, so every flag is
+ * `false` before the handshake and on hosts other than ChatGPT.
+ */
+export type OpenAIHostCapabilities = {
+    /** Read, subscribe to and write the file opened through a file entrypoint. */
+    resource: boolean;
+    /** Titles, thumbnails and background content in `ui/update-model-context`. */
+    modelContext: boolean;
+    /** `ui/message` targets and titled items. */
+    message: boolean;
+    /** Open a local file with `openai/files/open`. */
+    files: boolean;
+};
+export type HostInfo = {
+    name: Host | (string & {}) | undefined;
+    version: string | undefined;
+    /** The host's MCP Apps capabilities, `undefined` until the handshake. */
+    capabilities: McpUiHostCapabilities | undefined;
+    /** OpenAI MCP extensions the host supports. */
+    openai: OpenAIHostCapabilities;
+};
+/**
+ * Identity and capabilities of the host application rendering the view, from
+ * the MCP Apps `ui/initialize` handshake. `name` is normalized to a
+ * {@link Host} slug when recognized, otherwise the raw string; `name`,
+ * `version` and `capabilities` are `undefined` until the handshake resolves
+ * (the view renders first and re-renders once it lands).
+ *
+ * @example
+ * ```tsx
+ * const { name, openai } = useHost();
+ * if (name === "claude") return <ClaudeLayout />;
+ * if (openai.files) return <OpenFileButton />;
+ * ```
+ */
+export declare function useHost(): HostInfo;