skybridge 0.0.0-dev.faf07e2 → 0.0.0-dev.faf20cc

package/dist/{src/web → web}/hooks/use-call-tool.test.js

@@ -1,17 +1,27 @@
 import { act, renderHook, waitFor } from "@testing-library/react";
-import { afterEach, beforeEach, describe, expect, it, vi, expectTypeOf, } from "vitest";
+import { afterEach, beforeEach, describe, expect, expectTypeOf, 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 { useCallTool } from "./use-call-tool.js";
 describe("useCallTool - onSuccess callback", () => {
-    let OpenaiMock;
+    let callToolMock;
     beforeEach(() => {
-        OpenaiMock = {
-            callTool: vi.fn(),
-        };
-        vi.stubGlobal("openai", OpenaiMock);
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+        vi.stubGlobal("parent", { postMessage: vi.fn() });
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("openai", { callTool: vi.fn() });
+        callToolMock = vi.spyOn(getAdaptor(), "callTool");
     });
     afterEach(() => {
         vi.unstubAllGlobals();
         vi.resetAllMocks();
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
     });
     const toolName = "test-tool";
     const args = { input: "test input" };
@@ -19,21 +29,40 @@ describe("useCallTool - onSuccess callback", () => {
         content: [{ type: "text", text: "test result" }],
         structuredContent: { result: "test" },
         isError: false,
-        result: "test result",
         meta: {},
     };
     const error = new Error("test error");
-    it("should call window.openai.callTool with correct arguments", async () => {
+    it("should normalize _meta to meta when SDK returns _meta instead of meta", async () => {
+        const rawSdkResponse = {
+            content: [{ type: "text", text: "result" }],
+            structuredContent: { value: 1 },
+            isError: false,
+            meta: { secret: "only visible to widget" },
+        };
+        callToolMock.mockResolvedValueOnce(rawSdkResponse);
+        const { result } = renderHook(() => useCallTool(toolName));
+        await act(async () => {
+            result.current.callTool(args);
+        });
+        await waitFor(() => {
+            expect(result.current.data).toMatchObject({
+                meta: { secret: "only visible to widget" },
+            });
+        });
+    });
+    it("should call adaptor.callTool with correct arguments", async () => {
         const { result } = renderHook(() => useCallTool(toolName));
         await act(async () => {
             result.current.callTool(args);
         });
-        expect(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);
+        expect(callToolMock).toHaveBeenCalledWith(toolName, args, {
+            timeout: undefined,
+        });
     });
     it("should call onSuccess callback with correct data and toolArgs on successful execution", async () => {
         const onSuccess = vi.fn();
         const onError = vi.fn();
-        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        callToolMock.mockResolvedValueOnce(data);
         const { result } = renderHook(() => useCallTool(toolName));
         act(() => {
             result.current.callTool(args, {
@@ -49,7 +78,7 @@ describe("useCallTool - onSuccess callback", () => {
     it("should call onError callback with error and toolArgs on failed execution", async () => {
         const onSuccess = vi.fn();
         const onError = vi.fn();
-        OpenaiMock.callTool.mockRejectedValueOnce(error);
+        callToolMock.mockRejectedValueOnce(error);
         const { result } = renderHook(() => useCallTool(toolName));
         act(() => {
             result.current.callTool(args, {
@@ -66,7 +95,7 @@ describe("useCallTool - onSuccess callback", () => {
         const onSuccess = vi.fn();
         const onError = vi.fn();
         const onSettled = vi.fn();
-        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        callToolMock.mockResolvedValueOnce(data);
         const { result } = renderHook(() => useCallTool(toolName));
         act(() => {
             result.current.callTool(args, {
@@ -85,7 +114,7 @@ describe("useCallTool - onSuccess callback", () => {
         const onSuccess = vi.fn();
         const onError = vi.fn();
         const onSettled = vi.fn();
-        OpenaiMock.callTool.mockRejectedValueOnce(error);
+        callToolMock.mockRejectedValueOnce(error);
         const { result } = renderHook(() => useCallTool(toolName));
         act(() => {
             result.current.callTool(args, {
@@ -100,18 +129,60 @@ describe("useCallTool - onSuccess callback", () => {
             expect(onSuccess).not.toHaveBeenCalled();
         });
     });
+    it("should always return last call started state", async () => {
+        const { result } = renderHook(() => useCallTool(toolName));
+        const firstCallData = {
+            ...data,
+            structuredContent: { result: "first call result" },
+        };
+        const secondCallData = {
+            ...data,
+            structuredContent: { result: "second call result" },
+        };
+        const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } = Promise.withResolvers();
+        const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } = Promise.withResolvers();
+        callToolMock
+            .mockImplementationOnce(() => firstCallToolPromise)
+            .mockImplementationOnce(() => secondCallToolPromise);
+        await act(() => {
+            result.current.callTool(args);
+            result.current.callTool(args);
+            resolveFirstCallTool(firstCallData);
+            return firstCallToolPromise;
+        });
+        expect(result.current.status).toEqual("pending");
+        expect(result.current.data).toEqual(undefined);
+        resolveSecondCallTool(secondCallData);
+        await waitFor(() => {
+            expect(result.current.status).toEqual("success");
+            expect(result.current.data).toEqual(secondCallData);
+        });
+    });
+    it("should keep callTool and callToolAsync stable across renders", () => {
+        const { result, rerender } = renderHook(() => useCallTool(toolName));
+        const { callTool, callToolAsync } = result.current;
+        rerender();
+        expect(result.current.callTool).toBe(callTool);
+        expect(result.current.callToolAsync).toBe(callToolAsync);
+    });
 });
 describe("useCallTool - TypeScript typing", () => {
-    let OpenaiMock;
+    let callToolMock;
     beforeEach(() => {
-        OpenaiMock = {
-            callTool: vi.fn(),
-        };
-        vi.stubGlobal("openai", OpenaiMock);
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
+        vi.stubGlobal("parent", { postMessage: vi.fn() });
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("openai", { callTool: vi.fn() });
+        callToolMock = vi.spyOn(getAdaptor(), "callTool");
     });
     afterEach(() => {
         vi.unstubAllGlobals();
         vi.resetAllMocks();
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        AppsSdkBridge.resetInstance();
     });
     it("should have correct return types when ToolArgs is null and ToolResponse is specified", async () => {
         const { result } = renderHook(() => useCallTool("test-tool"));
@@ -119,14 +190,15 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "test" }],
             structuredContent: { result: "test" },
             isError: false,
-            result: "test",
             meta: { id: 123 },
         };
-        OpenaiMock.callTool.mockResolvedValueOnce(data);
+        callToolMock.mockResolvedValueOnce(data);
         await act(async () => {
             result.current.callTool();
         });
-        expect(OpenaiMock.callTool).toHaveBeenCalledWith("test-tool", null);
+        expect(callToolMock).toHaveBeenCalledWith("test-tool", null, {
+            timeout: undefined,
+        });
         expectTypeOf(result.current.data);
     });
     it("should correctly type callToolAsync return value", async () => {
@@ -136,18 +208,14 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "answer" }],
             structuredContent: { answer: "test answer" },
             isError: false,
-            result: "answer",
             meta: {},
         };
-        OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
-        let promise;
-        let resolvedValue;
-        await act(async () => {
-            promise = result.current.callToolAsync(testArgs);
-            expectTypeOf(promise);
-            resolvedValue = await promise;
+        callToolMock.mockResolvedValueOnce(mockResponse);
+        const returnedValue = await act(async () => {
+            return result.current.callToolAsync(testArgs);
         });
-        expect(resolvedValue).toEqual(mockResponse);
+        expectTypeOf(returnedValue);
+        expect(returnedValue).toEqual(mockResponse);
     });
     it("should correctly type callToolAsync when ToolArgs is null", async () => {
         const { result } = renderHook(() => useCallTool("test-tool"));
@@ -155,17 +223,14 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "data" }],
             structuredContent: { data: "test data" },
             isError: false,
-            result: "data",
+            meta: {},
         };
-        OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
-        let promise;
-        let resolvedValue;
-        await act(async () => {
-            promise = result.current.callToolAsync();
-            expectTypeOf(promise);
-            resolvedValue = await promise;
+        callToolMock.mockResolvedValueOnce(mockResponse);
+        const returnedValue = await act(async () => {
+            return result.current.callToolAsync();
         });
-        expect(resolvedValue).toEqual(mockResponse);
+        expectTypeOf(returnedValue);
+        expect(returnedValue).toEqual(mockResponse);
     });
 });
 //# sourceMappingURL=use-call-tool.test.js.map

package/dist/web/hooks/use-call-tool.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAChB,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;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,YAAkB,CAAC;IAEvB,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,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,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/C,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,UAAU,CAAoB,CAAC;IACvE,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,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAqB;QAC7B,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QACzD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QACrC,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,EAAE;KACT,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,cAAc,GAAG;YACrB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;YAC/B,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE;SAC3C,CAAC;QACF,YAAY,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACxC,IAAI,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QACF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,EAAE;YACxD,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,YAAY,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QACpG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,YAAY,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,GAAG,CAAC,GAAG,EAAE;YACP,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC5B,SAAS;gBACT,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/D,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAA2B,QAAQ,CAAC,CAChD,CAAC;QAEF,MAAM,aAAa,GAAG;YACpB,GAAG,IAAI;YACP,iBAAiB,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;SACnD,CAAC;QACF,MAAM,cAAc,GAAG;YACrB,GAAG,IAAI;YACP,iBAAiB,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE;SACpD,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,EAAE,GACpE,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,MAAM,EAAE,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,qBAAqB,EAAE,GACtE,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,YAAY;aACT,sBAAsB,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC;aAClD,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;QAEvD,MAAM,GAAG,CAAC,GAAG,EAAE;YACb,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,oBAAoB,CAAC,aAAa,CAAC,CAAC;YACpC,OAAO,oBAAoB,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAEtC,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAEnD,QAAQ,EAAE,CAAC;QAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,YAAkB,CAAC;IAEvB,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,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,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/C,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,UAAU,CAAoB,CAAC;IACvE,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,sFAAsF,EAAE,KAAK,IAAI,EAAE;QAMpG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QACF,MAAM,IAAI,GAAiB;YACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YACrC,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE;SAClB,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEzC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,EAAE;YAC3D,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;QACH,YAAY,CAA0B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAMhE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAyB,WAAW,CAAC,CACjD,CAAC;QAEF,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,YAAY,GAAiB;YACjC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;YAC5C,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACzC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QACH,YAAY,CAAsB,aAAa,CAAC,CAAC;QACjD,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAKzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CACjC,WAAW,CAAqB,WAAW,CAAC,CAC7C,CAAC;QAEF,MAAM,YAAY,GAAiB;YACjC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,iBAAiB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,YAAY,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACzC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;QACH,YAAY,CAAsB,aAAa,CAAC,CAAC;QACjD,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport {\n  afterEach,\n  beforeEach,\n  describe,\n  expect,\n  expectTypeOf,\n  it,\n  type Mock,\n  vi,\n} 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 type { CallToolResponse } from \"../bridges/types.js\";\nimport { useCallTool } from \"./use-call-tool.js\";\n\ndescribe(\"useCallTool - onSuccess callback\", () => {\n  let callToolMock: Mock;\n\n  beforeEach(() => {\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n    vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"openai\", { callTool: vi.fn() });\n    callToolMock = vi.spyOn(getAdaptor(), \"callTool\") as unknown as Mock;\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n  });\n\n  const toolName = \"test-tool\";\n  const args = { input: \"test input\" };\n  const data: CallToolResponse = {\n    content: [{ type: \"text\" as const, text: \"test result\" }],\n    structuredContent: { result: \"test\" },\n    isError: false,\n    meta: {},\n  };\n  const error = new Error(\"test error\");\n\n  it(\"should normalize _meta to meta when SDK returns _meta instead of meta\", async () => {\n    const rawSdkResponse = {\n      content: [{ type: \"text\" as const, text: \"result\" }],\n      structuredContent: { value: 1 },\n      isError: false,\n      meta: { secret: \"only visible to widget\" },\n    };\n    callToolMock.mockResolvedValueOnce(rawSdkResponse);\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    await act(async () => {\n      result.current.callTool(args);\n    });\n\n    await waitFor(() => {\n      expect(result.current.data).toMatchObject({\n        meta: { secret: \"only visible to widget\" },\n      });\n    });\n  });\n\n  it(\"should call adaptor.callTool with correct arguments\", async () => {\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n    await act(async () => {\n      result.current.callTool(args);\n    });\n    expect(callToolMock).toHaveBeenCalledWith(toolName, args, {\n      timeout: undefined,\n    });\n  });\n\n  it(\"should call onSuccess callback with correct data and toolArgs on successful execution\", async () => {\n    const onSuccess = vi.fn();\n    const onError = vi.fn();\n    callToolMock.mockResolvedValueOnce(data);\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    act(() => {\n      result.current.callTool(args, {\n        onSuccess,\n        onError,\n      });\n    });\n\n    await waitFor(() => {\n      expect(onSuccess).toHaveBeenCalledWith(data, args);\n      expect(onError).not.toHaveBeenCalled();\n    });\n  });\n\n  it(\"should call onError callback with error and toolArgs on failed execution\", async () => {\n    const onSuccess = vi.fn();\n    const onError = vi.fn();\n    callToolMock.mockRejectedValueOnce(error);\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    act(() => {\n      result.current.callTool(args, {\n        onSuccess,\n        onError,\n      });\n    });\n\n    await waitFor(() => {\n      expect(onSuccess).not.toHaveBeenCalled();\n      expect(onError).toHaveBeenCalledWith(error, args);\n    });\n  });\n\n  it(\"should call onSettled callback with data and undefined error on successful execution\", async () => {\n    const onSuccess = vi.fn();\n    const onError = vi.fn();\n    const onSettled = vi.fn();\n    callToolMock.mockResolvedValueOnce(data);\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    act(() => {\n      result.current.callTool(args, {\n        onSuccess,\n        onError,\n        onSettled,\n      });\n    });\n\n    await waitFor(() => {\n      expect(onSuccess).toHaveBeenCalledWith(data, args);\n      expect(onSettled).toHaveBeenCalledWith(data, undefined, args);\n      expect(onError).not.toHaveBeenCalled();\n    });\n  });\n\n  it(\"should call onSettled callback with undefined data and error on failed execution\", async () => {\n    const onSuccess = vi.fn();\n    const onError = vi.fn();\n    const onSettled = vi.fn();\n    callToolMock.mockRejectedValueOnce(error);\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    act(() => {\n      result.current.callTool(args, {\n        onSuccess,\n        onError,\n        onSettled,\n      });\n    });\n\n    await waitFor(() => {\n      expect(onError).toHaveBeenCalledWith(error, args);\n      expect(onSettled).toHaveBeenCalledWith(undefined, error, args);\n      expect(onSuccess).not.toHaveBeenCalled();\n    });\n  });\n\n  it(\"should always return last call started state\", async () => {\n    const { result } = renderHook(() =>\n      useCallTool<typeof args, typeof data>(toolName),\n    );\n\n    const firstCallData = {\n      ...data,\n      structuredContent: { result: \"first call result\" },\n    };\n    const secondCallData = {\n      ...data,\n      structuredContent: { result: \"second call result\" },\n    };\n    const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } =\n      Promise.withResolvers();\n    const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } =\n      Promise.withResolvers();\n    callToolMock\n      .mockImplementationOnce(() => firstCallToolPromise)\n      .mockImplementationOnce(() => secondCallToolPromise);\n\n    await act(() => {\n      result.current.callTool(args);\n      result.current.callTool(args);\n      resolveFirstCallTool(firstCallData);\n      return firstCallToolPromise;\n    });\n\n    expect(result.current.status).toEqual(\"pending\");\n    expect(result.current.data).toEqual(undefined);\n    resolveSecondCallTool(secondCallData);\n\n    await waitFor(() => {\n      expect(result.current.status).toEqual(\"success\");\n      expect(result.current.data).toEqual(secondCallData);\n    });\n  });\n\n  it(\"should keep callTool and callToolAsync stable across renders\", () => {\n    const { result, rerender } = renderHook(() => useCallTool(toolName));\n    const { callTool, callToolAsync } = result.current;\n\n    rerender();\n\n    expect(result.current.callTool).toBe(callTool);\n    expect(result.current.callToolAsync).toBe(callToolAsync);\n  });\n});\n\ndescribe(\"useCallTool - TypeScript typing\", () => {\n  let callToolMock: Mock;\n\n  beforeEach(() => {\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n    vi.stubGlobal(\"parent\", { postMessage: vi.fn() });\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"openai\", { callTool: vi.fn() });\n    callToolMock = vi.spyOn(getAdaptor(), \"callTool\") as unknown as Mock;\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    AppsSdkBridge.resetInstance();\n  });\n\n  it(\"should have correct return types when ToolArgs is null and ToolResponse is specified\", async () => {\n    type TestResponse = CallToolResponse & {\n      structuredContent: { result: string };\n      meta: { id: number };\n    };\n\n    const { result } = renderHook(() =>\n      useCallTool<null, TestResponse>(\"test-tool\"),\n    );\n    const data: TestResponse = {\n      content: [{ type: \"text\" as const, text: \"test\" }],\n      structuredContent: { result: \"test\" },\n      isError: false,\n      meta: { id: 123 },\n    };\n\n    callToolMock.mockResolvedValueOnce(data);\n\n    await act(async () => {\n      result.current.callTool();\n    });\n\n    expect(callToolMock).toHaveBeenCalledWith(\"test-tool\", null, {\n      timeout: undefined,\n    });\n    expectTypeOf<typeof data | undefined>(result.current.data);\n  });\n\n  it(\"should correctly type callToolAsync return value\", async () => {\n    type TestArgs = { query: string };\n    type TestResponse = CallToolResponse & {\n      structuredContent: { answer: string };\n    };\n\n    const { result } = renderHook(() =>\n      useCallTool<TestArgs, TestResponse>(\"test-tool\"),\n    );\n\n    const testArgs: TestArgs = { query: \"test\" };\n    const mockResponse: TestResponse = {\n      content: [{ type: \"text\" as const, text: \"answer\" }],\n      structuredContent: { answer: \"test answer\" },\n      isError: false,\n      meta: {},\n    };\n\n    callToolMock.mockResolvedValueOnce(mockResponse);\n\n    const returnedValue = await act(async () => {\n      return result.current.callToolAsync(testArgs);\n    });\n    expectTypeOf<typeof mockResponse>(returnedValue);\n    expect(returnedValue).toEqual(mockResponse);\n  });\n\n  it(\"should correctly type callToolAsync when ToolArgs is null\", async () => {\n    type TestResponse = CallToolResponse & {\n      structuredContent: { data: string };\n    };\n\n    const { result } = renderHook(() =>\n      useCallTool<null, TestResponse>(\"test-tool\"),\n    );\n\n    const mockResponse: TestResponse = {\n      content: [{ type: \"text\" as const, text: \"data\" }],\n      structuredContent: { data: \"test data\" },\n      isError: false,\n      meta: {},\n    };\n\n    callToolMock.mockResolvedValueOnce(mockResponse);\n\n    const returnedValue = await act(async () => {\n      return result.current.callToolAsync();\n    });\n    expectTypeOf<typeof mockResponse>(returnedValue);\n    expect(returnedValue).toEqual(mockResponse);\n  });\n});\n"]}

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

@@ -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 {};