skybridge 0.0.0-dev.97c9ddf → 0.0.0-dev.97e4bf7

package/dist/web/hooks/use-deep-link.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 declare function useDeepLink(): string | undefined;

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

@@ -0,0 +1,34 @@
+import { useMcpAppContext } from "../bridges/index.js";
+/**
+ * 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 = useMcpAppContext("openai/deepLink")?.url;
+    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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,GAAG,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC;IACrD,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\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 = useMcpAppContext(\"openai/deepLink\")?.url;\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

@@ -9,7 +9,7 @@ import type { RequestDisplayMode } from "../bridges/types.js";
  *
  * `"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 useLayout}.
+ * pair with {@link useViewport}.
  *
  * @example
  * ```tsx

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

@@ -10,7 +10,7 @@ import { getAdaptor, useHostContext } from "../bridges/index.js";
  *
  * `"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 useLayout}.
+ * pair with {@link useViewport}.
  *
  * @example
  * ```tsx

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

@@ -1 +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 useLayout}.\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"]}
+{"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.js

@@ -11,7 +11,7 @@ describe("useDisplayMode", () => {
         HostAdaptor.resetInstance();
         McpAppBridge.resetInstance();
         AppsSdkBridge.resetInstance();
-        vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+        vi.stubGlobal("skybridge", {});
         vi.stubGlobal("openai", { view: { mode: "inline" } });
         vi.stubGlobal("ResizeObserver", MockResizeObserver);
     });

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

@@ -1 +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,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,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\", { hostType: \"apps-sdk\" });\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"]}
+{"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

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

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

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

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

@@ -1 +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,MAAM,QAAQ,GAAG,WAAW,CAC1B,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EACpC,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,EAAE,QAAQ,EAAE,CAAC;AACtB,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(): { download: DownloadFn } {\n  const adaptor = getAdaptor();\n  const download = useCallback<DownloadFn>(\n    (params) => adaptor.download(params),\n    [adaptor],\n  );\n\n  return { download };\n}\n"]}
+{"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.js

@@ -20,7 +20,7 @@ describe("useDownload", () => {
     describe("apps-sdk host", () => {
         beforeEach(() => {
             vi.stubGlobal("openai", {});
-            vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+            vi.stubGlobal("skybridge", {});
             vi.stubGlobal("ResizeObserver", MockResizeObserver);
             vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
         });
@@ -33,7 +33,7 @@ describe("useDownload", () => {
         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.download(params);
+            const res = await result.current(params);
             expect(res).toEqual({ isError: true });
             expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
         });
@@ -41,7 +41,7 @@ describe("useDownload", () => {
     describe("mcp-app host without downloadFile capability", () => {
         beforeEach(() => {
             vi.stubGlobal("openai", undefined);
-            vi.stubGlobal("skybridge", { hostType: "mcp-app" });
+            vi.stubGlobal("skybridge", {});
             vi.stubGlobal("ResizeObserver", MockResizeObserver);
             vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
         });
@@ -54,7 +54,7 @@ describe("useDownload", () => {
         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.download(params);
+            const res = await result.current(params);
             expect(res).toEqual({ isError: true });
             expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining("does not support ui/download-file"));
         });
@@ -63,7 +63,7 @@ describe("useDownload", () => {
         let postMessageMock;
         beforeEach(() => {
             vi.stubGlobal("openai", undefined);
-            vi.stubGlobal("skybridge", { hostType: "mcp-app" });
+            vi.stubGlobal("skybridge", {});
             vi.stubGlobal("ResizeObserver", MockResizeObserver);
             postMessageMock = getMcpAppHostPostMessageMock({}, { hostCapabilities: { downloadFile: {} } });
             vi.stubGlobal("parent", { postMessage: postMessageMock });
@@ -76,7 +76,7 @@ describe("useDownload", () => {
         });
         it("sends ui/download-file with the provided contents", async () => {
             const { result } = renderHook(() => useDownload());
-            const res = await result.current.download(params);
+            const res = await result.current(params);
             expect(res).toEqual({});
             await waitFor(() => {
                 expect(postMessageMock).toHaveBeenCalledWith(expect.objectContaining({
@@ -95,7 +95,7 @@ describe("useDownload", () => {
             });
             vi.stubGlobal("parent", { postMessage: postMessageMock });
             const { result } = renderHook(() => useDownload());
-            const res = await result.current.download(params);
+            const res = await result.current(params);
             expect(res).toEqual({ isError: true });
         });
     });

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

@@ -1 +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,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,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,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,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,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,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,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,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,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,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,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,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,QAAQ,CAAC,MAAM,CAAC,CAAC;YAElD,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\", { hostType: \"apps-sdk\" });\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.download(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\", { hostType: \"mcp-app\" });\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.download(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\", { hostType: \"mcp-app\" });\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.download(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.download(params);\n\n      expect(res).toEqual({ isError: true });\n    });\n  });\n});\n"]}
+{"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-file-resource.d.ts

@@ -0,0 +1,37 @@
+import { type FileResource, type FileResourceContent, type FileResourceWriteResult, type ResourceRepresentation } from "../bridges/index.js";
+/** State and actions returned by {@link useFileResource}. */
+export type FileResourceState = {
+    data: FileResource | undefined;
+    isLoading: boolean;
+    error: unknown;
+    write: (content: FileResourceContent) => Promise<FileResourceWriteResult>;
+};
+/**
+ * Read a resource by URI, re-read it whenever the host reports a change, and
+ * write it back. Built for the file a ChatGPT file entrypoint opened, whose
+ * `resourceUri` arrives in the tool input as `file.resourceUri`.
+ *
+ * Reading uses the standard `resources/read`. `representation` asks ChatGPT
+ * for text or a base64 blob. `write` uses the OpenAI MCP extensions
+ * (`openai/resources/write`) and sends the current `etag` as `ifMatch`, so it
+ * resolves with `conflict` instead of overwriting a newer version, and then
+ * re-reads the latest one. When ChatGPT returned no `etag`, the write has no
+ * version check. It rejects with `NotSupportedError` when the host doesn't
+ * advertise `openai/resource`, or the resource isn't loaded or writable.
+ *
+ * Pass `undefined` or an empty string as `uri` to do nothing, for example outside a file
+ * entrypoint.
+ *
+ * @example
+ * ```tsx
+ * const { input } = useToolInfo<"open-part">();
+ * const { data, write } = useFileResource(input.file?.resourceUri, {
+ *   representation: "text",
+ * });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-file-resource
+ */
+export declare function useFileResource(uri: string | undefined, options?: {
+    representation?: ResourceRepresentation;
+}): FileResourceState;

package/dist/web/hooks/use-file-resource.js

@@ -0,0 +1,98 @@
+import { useCallback, useEffect, useRef, useState } from "react";
+import { getAdaptor, NotSupportedError, } from "../bridges/index.js";
+/**
+ * Read a resource by URI, re-read it whenever the host reports a change, and
+ * write it back. Built for the file a ChatGPT file entrypoint opened, whose
+ * `resourceUri` arrives in the tool input as `file.resourceUri`.
+ *
+ * Reading uses the standard `resources/read`. `representation` asks ChatGPT
+ * for text or a base64 blob. `write` uses the OpenAI MCP extensions
+ * (`openai/resources/write`) and sends the current `etag` as `ifMatch`, so it
+ * resolves with `conflict` instead of overwriting a newer version, and then
+ * re-reads the latest one. When ChatGPT returned no `etag`, the write has no
+ * version check. It rejects with `NotSupportedError` when the host doesn't
+ * advertise `openai/resource`, or the resource isn't loaded or writable.
+ *
+ * Pass `undefined` or an empty string as `uri` to do nothing, for example outside a file
+ * entrypoint.
+ *
+ * @example
+ * ```tsx
+ * const { input } = useToolInfo<"open-part">();
+ * const { data, write } = useFileResource(input.file?.resourceUri, {
+ *   representation: "text",
+ * });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-file-resource
+ */
+export function useFileResource(uri, options) {
+    const representation = options?.representation;
+    const [state, setState] = useState();
+    const sequence = useRef(0);
+    const current = uri && state?.uri === uri ? state : undefined;
+    const currentRef = useRef(current);
+    currentRef.current = current;
+    const read = useCallback(() => {
+        if (!uri) {
+            return;
+        }
+        const id = ++sequence.current;
+        getAdaptor()
+            .readResource(uri, representation)
+            .then((resource) => ({ resource, error: undefined }), (error) => ({ error }))
+            .then((next) => {
+            if (id === sequence.current) {
+                setState((previous) => ({
+                    ...(previous?.uri === uri && previous),
+                    uri,
+                    ...next,
+                }));
+            }
+        });
+    }, [uri, representation]);
+    useEffect(() => {
+        if (!uri) {
+            return;
+        }
+        read();
+        const stopWatching = getAdaptor().watchResource(uri, read);
+        return () => {
+            sequence.current++;
+            stopWatching();
+        };
+    }, [uri, read]);
+    const write = useCallback(async (content) => {
+        const resource = currentRef.current?.resource;
+        if (!uri || currentRef.current?.uri !== uri || !resource?.writable) {
+            throw new NotSupportedError("writeResource", "the resource is not loaded or not writable");
+        }
+        const result = await getAdaptor().writeResource(uri, content, resource.etag);
+        if (currentRef.current?.uri !== uri) {
+            return result;
+        }
+        if (result.outcome === "saved") {
+            sequence.current++;
+            setState({
+                uri,
+                resource: {
+                    ...content,
+                    mimeType: resource.mimeType,
+                    writable: true,
+                    etag: result.etag,
+                },
+            });
+        }
+        else if (result.outcome === "conflict") {
+            read();
+        }
+        return result;
+    }, [uri, read]);
+    return {
+        data: current?.resource,
+        isLoading: Boolean(uri) && current === undefined,
+        error: current?.error,
+        write,
+    };
+}
+//# sourceMappingURL=use-file-resource.js.map

package/dist/web/hooks/use-file-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-file-resource.js","sourceRoot":"","sources":["../../../src/web/hooks/use-file-resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EAIL,UAAU,EACV,iBAAiB,GAElB,MAAM,qBAAqB,CAAC;AAU7B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,eAAe,CAC7B,GAAuB,EACvB,OAAqD;IAErD,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,CAAC;IAC/C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAI9B,CAAC;IACL,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,EAAE;QAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC9B,UAAU,EAAE;aACT,YAAY,CAAC,GAAG,EAAE,cAAc,CAAC;aACjC,IAAI,CACH,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAC9C,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAChC;aACA,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,IAAI,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;gBAC5B,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACtB,GAAG,CAAC,QAAQ,EAAE,GAAG,KAAK,GAAG,IAAI,QAAQ,CAAC;oBACtC,GAAG;oBACH,GAAG,IAAI;iBACR,CAAC,CAAC,CAAC;YACN,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;IAE1B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,IAAI,EAAE,CAAC;QACP,MAAM,YAAY,GAAG,UAAU,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC3D,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnB,YAAY,EAAE,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhB,MAAM,KAAK,GAAG,WAAW,CACvB,KAAK,EAAE,OAA4B,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC9C,IAAI,CAAC,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;YACnE,MAAM,IAAI,iBAAiB,CACzB,eAAe,EACf,4CAA4C,CAC7C,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC,aAAa,CAC7C,GAAG,EACH,OAAO,EACP,QAAQ,CAAC,IAAI,CACd,CAAC;QACF,IAAI,UAAU,CAAC,OAAO,EAAE,GAAG,KAAK,GAAG,EAAE,CAAC;YACpC,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YAC/B,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnB,QAAQ,CAAC;gBACP,GAAG;gBACH,QAAQ,EAAE;oBACR,GAAG,OAAO;oBACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,QAAQ,EAAE,IAAI;oBACd,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,MAAM,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACzC,IAAI,EAAE,CAAC;QACT,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,CAAC,GAAG,EAAE,IAAI,CAAC,CACZ,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,OAAO,EAAE,QAAQ;QACvB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,SAAS;QAChD,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,KAAK;KACN,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback, useEffect, useRef, useState } from \"react\";\nimport {\n  type FileResource,\n  type FileResourceContent,\n  type FileResourceWriteResult,\n  getAdaptor,\n  NotSupportedError,\n  type ResourceRepresentation,\n} from \"../bridges/index.js\";\n\n/** State and actions returned by {@link useFileResource}. */\nexport type FileResourceState = {\n  data: FileResource | undefined;\n  isLoading: boolean;\n  error: unknown;\n  write: (content: FileResourceContent) => Promise<FileResourceWriteResult>;\n};\n\n/**\n * Read a resource by URI, re-read it whenever the host reports a change, and\n * write it back. Built for the file a ChatGPT file entrypoint opened, whose\n * `resourceUri` arrives in the tool input as `file.resourceUri`.\n *\n * Reading uses the standard `resources/read`. `representation` asks ChatGPT\n * for text or a base64 blob. `write` uses the OpenAI MCP extensions\n * (`openai/resources/write`) and sends the current `etag` as `ifMatch`, so it\n * resolves with `conflict` instead of overwriting a newer version, and then\n * re-reads the latest one. When ChatGPT returned no `etag`, the write has no\n * version check. It rejects with `NotSupportedError` when the host doesn't\n * advertise `openai/resource`, or the resource isn't loaded or writable.\n *\n * Pass `undefined` or an empty string as `uri` to do nothing, for example outside a file\n * entrypoint.\n *\n * @example\n * ```tsx\n * const { input } = useToolInfo<\"open-part\">();\n * const { data, write } = useFileResource(input.file?.resourceUri, {\n *   representation: \"text\",\n * });\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-file-resource\n */\nexport function useFileResource(\n  uri: string | undefined,\n  options?: { representation?: ResourceRepresentation },\n): FileResourceState {\n  const representation = options?.representation;\n  const [state, setState] = useState<{\n    uri: string;\n    resource?: FileResource;\n    error?: unknown;\n  }>();\n  const sequence = useRef(0);\n  const current = uri && state?.uri === uri ? state : undefined;\n  const currentRef = useRef(current);\n  currentRef.current = current;\n\n  const read = useCallback(() => {\n    if (!uri) {\n      return;\n    }\n    const id = ++sequence.current;\n    getAdaptor()\n      .readResource(uri, representation)\n      .then(\n        (resource) => ({ resource, error: undefined }),\n        (error: unknown) => ({ error }),\n      )\n      .then((next) => {\n        if (id === sequence.current) {\n          setState((previous) => ({\n            ...(previous?.uri === uri && previous),\n            uri,\n            ...next,\n          }));\n        }\n      });\n  }, [uri, representation]);\n\n  useEffect(() => {\n    if (!uri) {\n      return;\n    }\n    read();\n    const stopWatching = getAdaptor().watchResource(uri, read);\n    return () => {\n      sequence.current++;\n      stopWatching();\n    };\n  }, [uri, read]);\n\n  const write = useCallback(\n    async (content: FileResourceContent) => {\n      const resource = currentRef.current?.resource;\n      if (!uri || currentRef.current?.uri !== uri || !resource?.writable) {\n        throw new NotSupportedError(\n          \"writeResource\",\n          \"the resource is not loaded or not writable\",\n        );\n      }\n      const result = await getAdaptor().writeResource(\n        uri,\n        content,\n        resource.etag,\n      );\n      if (currentRef.current?.uri !== uri) {\n        return result;\n      }\n      if (result.outcome === \"saved\") {\n        sequence.current++;\n        setState({\n          uri,\n          resource: {\n            ...content,\n            mimeType: resource.mimeType,\n            writable: true,\n            etag: result.etag,\n          },\n        });\n      } else if (result.outcome === \"conflict\") {\n        read();\n      }\n      return result;\n    },\n    [uri, read],\n  );\n\n  return {\n    data: current?.resource,\n    isLoading: Boolean(uri) && current === undefined,\n    error: current?.error,\n    write,\n  };\n}\n"]}

package/dist/web/hooks/use-file-resource.test.d.ts

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

package/dist/web/hooks/use-file-resource.test.js

@@ -0,0 +1,65 @@
+import { act, renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { getAdaptor } from "../bridges/get-adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { useFileResource } from "./use-file-resource.js";
+describe("useFileResource", () => {
+    beforeEach(() => {
+        vi.stubGlobal("parent", { postMessage: vi.fn() });
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("openai", undefined);
+    });
+    afterEach(() => {
+        vi.unstubAllGlobals();
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+    });
+    it("reads the resource, re-reads it on update and writes with the current etag", async () => {
+        let version = 1;
+        let onUpdated = () => { };
+        const request = vi.fn(async ({ method }) => method === "openai/resources/write"
+            ? { outcome: "saved", etag: "v3" }
+            : {});
+        const app = {
+            getHostCapabilities: () => ({ experimental: { "openai/resource": {} } }),
+            readServerResource: vi.fn(async ({ uri }) => ({
+                contents: [
+                    {
+                        uri,
+                        text: `version ${version}`,
+                        _meta: {
+                            "openai/resource": { writable: true, etag: `v${version}` },
+                        },
+                    },
+                ],
+            })),
+            setNotificationHandler: (_method, handler) => {
+                onUpdated = handler;
+            },
+            request,
+        };
+        getAdaptor().mcp.getApp = () => Promise.resolve(app);
+        const { result } = renderHook(() => useFileResource("host-resource://part", { representation: "text" }));
+        await waitFor(() => expect(result.current.data).toMatchObject({
+            text: "version 1",
+            etag: "v1",
+        }));
+        await waitFor(() => expect(request).toHaveBeenCalledWith({
+            method: "resources/subscribe",
+            params: { uri: "host-resource://part" },
+        }, expect.anything()));
+        version = 2;
+        act(() => onUpdated({ params: { uri: "host-resource://part" } }));
+        await waitFor(() => expect(result.current.data).toMatchObject({ etag: "v2" }));
+        await act(async () => {
+            await result.current.write({ text: "edited" });
+        });
+        expect(request).toHaveBeenCalledWith({
+            method: "openai/resources/write",
+            params: { uri: "host-resource://part", text: "edited", ifMatch: "v2" },
+        }, expect.anything());
+        expect(result.current.data).toMatchObject({ text: "edited", etag: "v3" });
+    });
+});
+//# sourceMappingURL=use-file-resource.test.js.map

package/dist/web/hooks/use-file-resource.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-file-resource.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-file-resource.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,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,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC/B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QAC1F,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,SAAS,GACX,GAAG,EAAE,GAAE,CAAC,CAAC;QACX,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,MAAM,EAAsB,EAAE,EAAE,CAC7D,MAAM,KAAK,wBAAwB;YACjC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;YAClC,CAAC,CAAC,EAAE,CACP,CAAC;QACF,MAAM,GAAG,GAAG;YACV,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,EAAE,CAAC;YACxE,kBAAkB,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,GAAG,EAAmB,EAAE,EAAE,CAAC,CAAC;gBAC7D,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,IAAI,EAAE,WAAW,OAAO,EAAE;wBAC1B,KAAK,EAAE;4BACL,iBAAiB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,EAAE;yBAC3D;qBACF;iBACF;aACF,CAAC,CAAC;YACH,sBAAsB,EAAE,CAAC,OAAe,EAAE,OAAyB,EAAE,EAAE;gBACrE,SAAS,GAAG,OAAO,CAAC;YACtB,CAAC;YACD,OAAO;SACR,CAAC;QAEA,UAAU,EACX,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAE1C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,eAAe,CAAC,sBAAsB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CACpE,CAAC;QACF,MAAM,OAAO,CAAC,GAAG,EAAE,CACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YACxC,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,IAAI;SACX,CAAC,CACH,CAAC;QACF,MAAM,OAAO,CAAC,GAAG,EAAE,CACjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAClC;YACE,MAAM,EAAE,qBAAqB;YAC7B,MAAM,EAAE,EAAE,GAAG,EAAE,sBAAsB,EAAE;SACxC,EACD,MAAM,CAAC,QAAQ,EAAE,CAClB,CACF,CAAC;QAEF,OAAO,GAAG,CAAC,CAAC;QACZ,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,sBAAsB,EAAE,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,OAAO,CAAC,GAAG,EAAE,CACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC1D,CAAC;QAEF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAClC;YACE,MAAM,EAAE,wBAAwB;YAChC,MAAM,EAAE,EAAE,GAAG,EAAE,sBAAsB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;SACvE,EACD,MAAM,CAAC,QAAQ,EAAE,CAClB,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { getAdaptor } from \"../bridges/get-adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport { useFileResource } from \"./use-file-resource.js\";\n\ndescribe(\"useFileResource\", () => {\n  beforeEach(() => {\n    vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"openai\", undefined);\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n  });\n\n  it(\"reads the resource, re-reads it on update and writes with the current etag\", async () => {\n    let version = 1;\n    let onUpdated: (notification: { params: { uri: string } }) => void =\n      () => {};\n    const request = vi.fn(async ({ method }: { method: string }) =>\n      method === \"openai/resources/write\"\n        ? { outcome: \"saved\", etag: \"v3\" }\n        : {},\n    );\n    const app = {\n      getHostCapabilities: () => ({ experimental: { \"openai/resource\": {} } }),\n      readServerResource: vi.fn(async ({ uri }: { uri: string }) => ({\n        contents: [\n          {\n            uri,\n            text: `version ${version}`,\n            _meta: {\n              \"openai/resource\": { writable: true, etag: `v${version}` },\n            },\n          },\n        ],\n      })),\n      setNotificationHandler: (_method: string, handler: typeof onUpdated) => {\n        onUpdated = handler;\n      },\n      request,\n    };\n    (\n      getAdaptor() as unknown as { mcp: { getApp: () => Promise<object> } }\n    ).mcp.getApp = () => Promise.resolve(app);\n\n    const { result } = renderHook(() =>\n      useFileResource(\"host-resource://part\", { representation: \"text\" }),\n    );\n    await waitFor(() =>\n      expect(result.current.data).toMatchObject({\n        text: \"version 1\",\n        etag: \"v1\",\n      }),\n    );\n    await waitFor(() =>\n      expect(request).toHaveBeenCalledWith(\n        {\n          method: \"resources/subscribe\",\n          params: { uri: \"host-resource://part\" },\n        },\n        expect.anything(),\n      ),\n    );\n\n    version = 2;\n    act(() => onUpdated({ params: { uri: \"host-resource://part\" } }));\n    await waitFor(() =>\n      expect(result.current.data).toMatchObject({ etag: \"v2\" }),\n    );\n\n    await act(async () => {\n      await result.current.write({ text: \"edited\" });\n    });\n    expect(request).toHaveBeenCalledWith(\n      {\n        method: \"openai/resources/write\",\n        params: { uri: \"host-resource://part\", text: \"edited\", ifMatch: \"v2\" },\n      },\n      expect.anything(),\n    );\n    expect(result.current.data).toMatchObject({ text: \"edited\", etag: \"v3\" });\n  });\n});\n"]}

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

@@ -17,7 +17,7 @@ describe("useFiles", () => {
         HostAdaptor.resetInstance();
         McpAppBridge.resetInstance();
         AppsSdkBridge.resetInstance();
-        vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+        vi.stubGlobal("skybridge", {});
         vi.stubGlobal("openai", OpenaiMock);
         vi.stubGlobal("parent", { postMessage: vi.fn() });
     });

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

@@ -1 +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,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACrD,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\", { hostType: \"apps-sdk\" });\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"]}
+{"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. */
+    openaiCapabilities: 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, openaiCapabilities } = useHost();
+ * if (name === "claude") return <ClaudeLayout />;
+ * if (openaiCapabilities.files) return <OpenFileButton />;
+ * ```
+ */
+export declare function useHost(): HostInfo;