skybridge 0.0.0-dev.f3fc72c → 0.0.0-dev.f40afe0

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

@@ -1,37 +1,46 @@
-import { act, fireEvent, renderHook, waitFor } from "@testing-library/react";
+import { act, renderHook, waitFor } from "@testing-library/react";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { McpAppAdaptor } from "../bridges/adaptors/mcp-app-adaptor.js";
-import { McpAppBridge } from "../bridges/mcp-app-bridge.js";
-import { SET_GLOBALS_EVENT_TYPE, SetGlobalsEvent, } from "../types.js";
-import { fireToolInputNotification, fireToolResultNotification, getMcpAppHostPostMessageMock, } from "./test/utils.js";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/index.js";
+import { fireToolInputNotification, fireToolResultNotification, getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
 import { useToolInfo } from "./use-tool-info.js";
 describe("useToolInfo", () => {
     describe("apps-sdk host", () => {
-        let OpenaiMock;
         beforeEach(() => {
-            OpenaiMock = {
-                toolInput: { name: "pokemon", args: { name: "pikachu" } },
+            vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
+            vi.stubGlobal("openai", {
+                toolInput: null,
                 toolOutput: null,
                 toolResponseMetadata: null,
-            };
-            vi.stubGlobal("openai", OpenaiMock);
+            });
             vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
         });
         afterEach(() => {
+            HostAdaptor.resetInstance();
             vi.unstubAllGlobals();
             vi.resetAllMocks();
+            McpAppBridge.resetInstance();
         });
-        it("should return toolInput on initial mount window.openai", () => {
+        it("should return pending state with tool input from tool-input notification", async () => {
             const { result } = renderHook(() => useToolInfo());
-            expect(result.current).toMatchObject({
-                input: { name: "pokemon", args: { name: "pikachu" } },
-                status: "pending",
-                isIdle: false,
-                isPending: true,
-                isSuccess: false,
+            act(() => {
+                fireToolInputNotification({
+                    name: "pokemon",
+                    args: { name: "pikachu" },
+                });
+            });
+            await waitFor(() => {
+                expect(result.current).toMatchObject({
+                    input: { name: "pokemon", args: { name: "pikachu" } },
+                    status: "pending",
+                    isIdle: false,
+                    isPending: true,
+                    isSuccess: false,
+                });
             });
         });
-        it("should eventually return tool output and response metadata once tool call completes", async () => {
+        it("should return success state once tool-result notification arrives", async () => {
             const toolOutput = {
                 name: "pikachu",
                 color: "yellow",
@@ -40,16 +49,15 @@ describe("useToolInfo", () => {
             const toolResponseMetadata = { id: 12 };
             const { result } = renderHook(() => useToolInfo());
             act(() => {
-                OpenaiMock.toolOutput = toolOutput;
-                OpenaiMock.toolResponseMetadata = toolResponseMetadata;
-                fireEvent(window, new SetGlobalsEvent(SET_GLOBALS_EVENT_TYPE, {
-                    detail: {
-                        globals: {
-                            toolOutput,
-                            toolResponseMetadata,
-                        },
-                    },
-                }));
+                fireToolInputNotification({
+                    name: "pokemon",
+                    args: { name: "pikachu" },
+                });
+                fireToolResultNotification({
+                    content: [{ type: "text", text: JSON.stringify(toolOutput) }],
+                    structuredContent: toolOutput,
+                    _meta: toolResponseMetadata,
+                });
             });
             await waitFor(() => {
                 expect(result.current).toMatchObject({
@@ -67,22 +75,24 @@ describe("useToolInfo", () => {
         beforeEach(() => {
             vi.stubGlobal("parent", { postMessage: getMcpAppHostPostMessageMock() });
             vi.stubGlobal("skybridge", { hostType: "mcp-app" });
+            vi.stubGlobal("openai", undefined);
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
         });
-        afterEach(() => {
+        afterEach(async () => {
+            HostAdaptor.resetInstance();
             vi.unstubAllGlobals();
             vi.resetAllMocks();
             McpAppBridge.resetInstance();
-            McpAppAdaptor.resetInstance();
         });
-        it("should return idle state initially when tool input is not yet set", async () => {
+        it("should return pending state with undefined input before tool-input notification arrives", async () => {
             const { result } = renderHook(() => useToolInfo());
             await waitFor(() => {
                 expect(result.current).toMatchObject({
-                    status: "idle",
-                    isIdle: true,
-                    isPending: false,
+                    status: "pending",
+                    isIdle: false,
+                    isPending: true,
                     isSuccess: false,
-                    input: null,
+                    input: undefined,
                     output: null,
                     responseMetadata: null,
                 });

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-tool-info.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-tool-info.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,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,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,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,SAAS,EAAE,IAAI;gBACf,UAAU,EAAE,IAAI;gBAChB,oBAAoB,EAAE,IAAI;aAC3B,CAAC,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC;oBACxB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;iBAC1B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;oBACrD,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;iBACjB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,UAAU,GAAG;gBACjB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,kGAAkG;aACrG,CAAC;YACF,MAAM,oBAAoB,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;YACxC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC;oBACxB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;iBAC1B,CAAC,CAAC;gBACH,0BAA0B,CAAC;oBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC7D,iBAAiB,EAAE,UAAU;oBAC7B,KAAK,EAAE,oBAAoB;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,UAAU;oBAClB,gBAAgB,EAAE,oBAAoB;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACnC,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;YACvG,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,SAAS;oBAChB,MAAM,EAAE,IAAI;oBACZ,gBAAgB,EAAE,IAAI;iBACvB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,KAAK;oBAChB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEnD,GAAG,CAAC,GAAG,EAAE;gBACP,yBAAyB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBACjE,0BAA0B,CAAC;oBACzB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;oBACjD,iBAAiB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBACvD,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;oBACnC,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;oBAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;oBAC5C,gBAAgB,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,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 { McpAppBridge } from \"../bridges/mcp-app/index.js\";\nimport {\n  fireToolInputNotification,\n  fireToolResultNotification,\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useToolInfo } from \"./use-tool-info.js\";\n\ndescribe(\"useToolInfo\", () => {\n  describe(\"apps-sdk host\", () => {\n    beforeEach(() => {\n      vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n      vi.stubGlobal(\"openai\", {\n        toolInput: null,\n        toolOutput: null,\n        toolResponseMetadata: null,\n      });\n      vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    });\n\n    afterEach(() => {\n      HostAdaptor.resetInstance();\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      McpAppBridge.resetInstance();\n    });\n\n    it(\"should return pending state with tool input from tool-input notification\", async () => {\n      const { result } = renderHook(() => useToolInfo());\n\n      act(() => {\n        fireToolInputNotification({\n          name: \"pokemon\",\n          args: { name: \"pikachu\" },\n        });\n      });\n\n      await waitFor(() => {\n        expect(result.current).toMatchObject({\n          input: { name: \"pokemon\", args: { name: \"pikachu\" } },\n          status: \"pending\",\n          isIdle: false,\n          isPending: true,\n          isSuccess: false,\n        });\n      });\n    });\n\n    it(\"should return success state once tool-result notification arrives\", async () => {\n      const toolOutput = {\n        name: \"pikachu\",\n        color: \"yellow\",\n        description:\n          \"When several of these POKéMON gather, their\\felectricity could build and cause lightning storms.\",\n      };\n      const toolResponseMetadata = { id: 12 };\n      const { result } = renderHook(() => useToolInfo());\n\n      act(() => {\n        fireToolInputNotification({\n          name: \"pokemon\",\n          args: { name: \"pikachu\" },\n        });\n        fireToolResultNotification({\n          content: [{ type: \"text\", text: JSON.stringify(toolOutput) }],\n          structuredContent: toolOutput,\n          _meta: toolResponseMetadata,\n        });\n      });\n\n      await waitFor(() => {\n        expect(result.current).toMatchObject({\n          status: \"success\",\n          isIdle: false,\n          isPending: false,\n          isSuccess: true,\n          output: toolOutput,\n          responseMetadata: toolResponseMetadata,\n        });\n      });\n    });\n  });\n\n  describe(\"mcp-app host\", () => {\n    beforeEach(() => {\n      vi.stubGlobal(\"parent\", { postMessage: getMcpAppHostPostMessageMock() });\n      vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n      vi.stubGlobal(\"openai\", undefined);\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    });\n\n    afterEach(async () => {\n      HostAdaptor.resetInstance();\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      McpAppBridge.resetInstance();\n    });\n\n    it(\"should return pending state with undefined input before tool-input notification arrives\", async () => {\n      const { result } = renderHook(() => useToolInfo());\n\n      await waitFor(() => {\n        expect(result.current).toMatchObject({\n          status: \"pending\",\n          isIdle: false,\n          isPending: true,\n          isSuccess: false,\n          input: undefined,\n          output: null,\n          responseMetadata: null,\n        });\n      });\n    });\n\n    it(\"should return pending state with tool input from tool-input notification\", async () => {\n      const { result } = renderHook(() => useToolInfo());\n\n      act(() => {\n        fireToolInputNotification({ name: \"pokemon\", query: \"pikachu\" });\n      });\n\n      await waitFor(() => {\n        expect(result.current).toMatchObject({\n          status: \"pending\",\n          isIdle: false,\n          isPending: true,\n          isSuccess: false,\n          input: { name: \"pokemon\", query: \"pikachu\" },\n        });\n      });\n    });\n\n    it(\"should return success state with output from tool-result notification\", async () => {\n      const { result } = renderHook(() => useToolInfo());\n\n      act(() => {\n        fireToolInputNotification({ name: \"pokemon\", query: \"pikachu\" });\n        fireToolResultNotification({\n          content: [{ type: \"text\", text: \"Pikachu data\" }],\n          structuredContent: { name: \"pikachu\", color: \"yellow\" },\n          _meta: { requestId: \"123\" },\n        });\n      });\n\n      await waitFor(() => {\n        expect(result.current).toMatchObject({\n          status: \"success\",\n          isIdle: false,\n          isPending: false,\n          isSuccess: true,\n          input: { name: \"pokemon\", query: \"pikachu\" },\n          output: { name: \"pikachu\", color: \"yellow\" },\n          responseMetadata: { requestId: \"123\" },\n        });\n      });\n    });\n  });\n});\n"]}

package/dist/{src/web → web}/hooks/use-user.d.ts

@@ -1,4 +1,4 @@
-import type { UserAgent } from "../types.js";
+import { type UserAgent } from "../bridges/index.js";
 export type UserState = {
     locale: string;
     userAgent: UserAgent;
@@ -14,5 +14,7 @@ export type UserState = {
  * // Access device type
  * const isMobile = userAgent.device.type === "mobile";
  * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-user
  */
 export declare function useUser(): UserState;

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

@@ -0,0 +1,37 @@
+import { useHostContext } from "../bridges/index.js";
+const DEFAULT_LOCALE = "en-US";
+/**
+ * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.
+ *
+ * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. "fr_FR" → "fr-FR"),
+ * incorrect casing (e.g. "en-us" → "en-US"), and complex subtags (e.g. "zh_Hans_CN" → "zh-Hans-CN").
+ * Falls back to "en-US" if the locale is invalid.
+ */
+function normalizeLocale(locale) {
+    try {
+        return new Intl.Locale(locale.replace(/_/g, "-")).toString();
+    }
+    catch {
+        return DEFAULT_LOCALE;
+    }
+}
+/**
+ * Hook for accessing session-stable user information.
+ * These values are set once at initialization and do not change during the session.
+ *
+ * @example
+ * ```tsx
+ * const { locale, userAgent } = useUser();
+ *
+ * // Access device type
+ * const isMobile = userAgent.device.type === "mobile";
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-user
+ */
+export function useUser() {
+    const rawLocale = useHostContext("locale");
+    const userAgent = useHostContext("userAgent");
+    return { locale: normalizeLocale(rawLocale), userAgent };
+}
+//# sourceMappingURL=use-user.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-user.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrE,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,cAAc,CAAC;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAE9C,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;AAC3D,CAAC","sourcesContent":["import { type UserAgent, useHostContext } from \"../bridges/index.js\";\n\nexport type UserState = {\n  locale: string;\n  userAgent: UserAgent;\n};\n\nconst DEFAULT_LOCALE = \"en-US\";\n\n/**\n * Normalizes a locale string to canonical BCP 47 format using {@link Intl.Locale}.\n *\n * Handles underscored identifiers returned by the ChatGPT mobile app (e.g. \"fr_FR\" → \"fr-FR\"),\n * incorrect casing (e.g. \"en-us\" → \"en-US\"), and complex subtags (e.g. \"zh_Hans_CN\" → \"zh-Hans-CN\").\n * Falls back to \"en-US\" if the locale is invalid.\n */\nfunction normalizeLocale(locale: string): string {\n  try {\n    return new Intl.Locale(locale.replace(/_/g, \"-\")).toString();\n  } catch {\n    return DEFAULT_LOCALE;\n  }\n}\n\n/**\n * Hook for accessing session-stable user information.\n * These values are set once at initialization and do not change during the session.\n *\n * @example\n * ```tsx\n * const { locale, userAgent } = useUser();\n *\n * // Access device type\n * const isMobile = userAgent.device.type === \"mobile\";\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-user\n */\nexport function useUser(): UserState {\n  const rawLocale = useHostContext(\"locale\");\n  const userAgent = useHostContext(\"userAgent\");\n\n  return { locale: normalizeLocale(rawLocale), userAgent };\n}\n"]}

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

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

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

@@ -0,0 +1,168 @@
+import { renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
+import { useUser } from "./use-user.js";
+describe("useUser", () => {
+    describe("apps-sdk host type", () => {
+        beforeEach(() => {
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+            vi.stubGlobal("openai", { locale: "en-US" });
+            vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+        });
+        afterEach(() => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            McpAppBridge.resetInstance();
+            HostAdaptor.resetInstance();
+        });
+        it("should return locale and userAgent from mcp host context", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "en-US",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("en-US");
+                expect(result.current.userAgent).toEqual({
+                    device: { type: "desktop" },
+                    capabilities: { hover: true, touch: false },
+                });
+            });
+        });
+        it("should return mobile userAgent when set to mobile", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "en-US",
+                    platform: "mobile",
+                    deviceCapabilities: { hover: false, touch: true },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.userAgent.device.type).toBe("mobile");
+                expect(result.current.userAgent.capabilities.touch).toBe(true);
+            });
+        });
+        it("should return different locale when set", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "es-ES",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("es-ES");
+            });
+        });
+        it("should normalize underscore locale to BCP 47 hyphen format", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "fr_FR",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("fr-FR");
+            });
+        });
+        it("should canonicalize locale casing", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "en-us",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("en-US");
+            });
+        });
+        it("should fall back to en-US for invalid locale", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "not-a-locale-!!",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("en-US");
+            });
+        });
+    });
+    describe("mcp-app host type", () => {
+        beforeEach(() => {
+            HostAdaptor.resetInstance();
+            McpAppBridge.resetInstance();
+            vi.stubGlobal("openai", undefined);
+            vi.stubGlobal("skybridge", { hostType: "mcp-app" });
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+        });
+        afterEach(async () => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            McpAppBridge.resetInstance();
+            HostAdaptor.resetInstance();
+        });
+        it("should return locale and userAgent from mcp host context", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "fr-FR",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("fr-FR");
+                expect(result.current.userAgent).toEqual({
+                    device: { type: "desktop" },
+                    capabilities: { hover: true, touch: false },
+                });
+            });
+        });
+        it("should normalize underscore locale to BCP 47 hyphen format", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "fr_FR",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.locale).toBe("fr-FR");
+            });
+        });
+        it("should maintain userAgent referential stability when data has not changed", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    locale: "en-US",
+                    platform: "web",
+                    deviceCapabilities: { hover: true, touch: false },
+                }),
+            });
+            const { result, rerender } = renderHook(() => useUser());
+            await waitFor(() => {
+                expect(result.current.userAgent).toBeDefined();
+            });
+            const initialUserAgent = result.current.userAgent;
+            rerender();
+            expect(result.current.userAgent).toBe(initialUserAgent);
+        });
+    });
+});
+//# sourceMappingURL=use-user.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-user.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-user.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;AAC5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7C,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACrD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,QAAQ;oBAClB,kBAAkB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,iBAAiB;oBACzB,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,CAAC,aAAa,EAAE,CAAC;YAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,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;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,WAAW,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC3B,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC5C,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,MAAM,EAAE,OAAO;oBACf,QAAQ,EAAE,KAAK;oBACf,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAClD,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAEzD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;YAElD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1D,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 {\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useUser } from \"./use-user.js\";\n\ndescribe(\"useUser\", () => {\n  describe(\"apps-sdk host type\", () => {\n    beforeEach(() => {\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n      vi.stubGlobal(\"openai\", { locale: \"en-US\" });\n      vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    });\n\n    afterEach(() => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      McpAppBridge.resetInstance();\n      HostAdaptor.resetInstance();\n    });\n\n    it(\"should return locale and userAgent from mcp host context\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"en-US\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"en-US\");\n        expect(result.current.userAgent).toEqual({\n          device: { type: \"desktop\" },\n          capabilities: { hover: true, touch: false },\n        });\n      });\n    });\n\n    it(\"should return mobile userAgent when set to mobile\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"en-US\",\n          platform: \"mobile\",\n          deviceCapabilities: { hover: false, touch: true },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.userAgent.device.type).toBe(\"mobile\");\n        expect(result.current.userAgent.capabilities.touch).toBe(true);\n      });\n    });\n\n    it(\"should return different locale when set\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"es-ES\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"es-ES\");\n      });\n    });\n\n    it(\"should normalize underscore locale to BCP 47 hyphen format\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"fr_FR\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"fr-FR\");\n      });\n    });\n\n    it(\"should canonicalize locale casing\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"en-us\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"en-US\");\n      });\n    });\n\n    it(\"should fall back to en-US for invalid locale\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"not-a-locale-!!\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"en-US\");\n      });\n    });\n  });\n\n  describe(\"mcp-app host type\", () => {\n    beforeEach(() => {\n      HostAdaptor.resetInstance();\n      McpAppBridge.resetInstance();\n      vi.stubGlobal(\"openai\", undefined);\n      vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    });\n\n    afterEach(async () => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      McpAppBridge.resetInstance();\n      HostAdaptor.resetInstance();\n    });\n\n    it(\"should return locale and userAgent from mcp host context\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"fr-FR\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"fr-FR\");\n        expect(result.current.userAgent).toEqual({\n          device: { type: \"desktop\" },\n          capabilities: { hover: true, touch: false },\n        });\n      });\n    });\n\n    it(\"should normalize underscore locale to BCP 47 hyphen format\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"fr_FR\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.locale).toBe(\"fr-FR\");\n      });\n    });\n\n    it(\"should maintain userAgent referential stability when data has not changed\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          locale: \"en-US\",\n          platform: \"web\",\n          deviceCapabilities: { hover: true, touch: false },\n        }),\n      });\n      const { result, rerender } = renderHook(() => useUser());\n\n      await waitFor(() => {\n        expect(result.current.userAgent).toBeDefined();\n      });\n\n      const initialUserAgent = result.current.userAgent;\n\n      rerender();\n\n      expect(result.current.userAgent).toBe(initialUserAgent);\n    });\n  });\n});\n"]}

package/dist/web/hooks/use-view-state.d.ts

@@ -0,0 +1,25 @@
+import { type SetStateAction } from "react";
+import type { UnknownObject } from "../types.js";
+/**
+ * Persist a piece of UI state on the host, so it survives view remounts and
+ * is restored on subsequent renders of the same tool invocation.
+ *
+ * Returns a `[state, setState]` pair with the same ergonomics as
+ * `useState`. State is filtered to strip Skybridge-internal context fields
+ * (see {@link DataLLM}) before being returned to your component.
+ *
+ * Provide a `defaultState` (value or lazy initializer) to get a non-nullable
+ * tuple; omit it for `T | null`.
+ *
+ * @typeParam T - Shape of the persisted state. Must be a plain object.
+ *
+ * @example
+ * ```tsx
+ * const [filters, setFilters] = useViewState({ sort: "newest", page: 1 });
+ * setFilters((f) => ({ ...f, page: f.page + 1 }));
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-view-state
+ */
+export declare function useViewState<T extends UnknownObject>(defaultState: T | (() => T)): readonly [T, (state: SetStateAction<T>) => void];
+export declare function useViewState<T extends UnknownObject>(defaultState?: T | (() => T | null) | null): readonly [T | null, (state: SetStateAction<T | null>) => void];

package/dist/web/hooks/use-view-state.js

@@ -0,0 +1,32 @@
+import { useCallback, useEffect, useState } from "react";
+import { getAdaptor, useHostContext } from "../bridges/index.js";
+import { filterViewContext, injectViewContext } from "../helpers/state.js";
+export function useViewState(defaultState) {
+    const adaptor = getAdaptor();
+    const viewStateFromBridge = useHostContext("viewState");
+    const [viewState, _setViewState] = useState(() => {
+        if (viewStateFromBridge !== null) {
+            return filterViewContext(viewStateFromBridge);
+        }
+        return typeof defaultState === "function"
+            ? defaultState()
+            : (defaultState ?? null);
+    });
+    useEffect(() => {
+        if (viewStateFromBridge !== null) {
+            _setViewState(filterViewContext(viewStateFromBridge));
+        }
+    }, [viewStateFromBridge]);
+    const setViewState = useCallback((state) => {
+        _setViewState((prevState) => {
+            const newState = typeof state === "function" ? state(prevState) : state;
+            const stateToSet = injectViewContext(newState);
+            if (stateToSet !== null) {
+                adaptor.setViewState(stateToSet);
+            }
+            return filterViewContext(stateToSet);
+        });
+    }, [adaptor]);
+    return [viewState, setViewState];
+}
+//# sourceMappingURL=use-view-state.js.map

package/dist/web/hooks/use-view-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-view-state.js","sourceRoot":"","sources":["../../../src/web/hooks/use-view-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AA8B3E,MAAM,UAAU,YAAY,CAC1B,YAA0C;IAE1C,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,mBAAmB,GAAG,cAAc,CAAC,WAAW,CAAa,CAAC;IAEpE,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAW,GAAG,EAAE;QACzD,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,OAAO,YAAY,KAAK,UAAU;YACvC,CAAC,CAAC,YAAY,EAAE;YAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;YACjC,aAAa,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE1B,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,KAA+B,EAAE,EAAE;QAClC,aAAa,CAAC,CAAC,SAAS,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,UAAU,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAE/C,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACxB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC;YAED,OAAO,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO,CAAC,SAAS,EAAE,YAAY,CAAU,CAAC;AAC5C,CAAC","sourcesContent":["import { type SetStateAction, useCallback, useEffect, useState } from \"react\";\nimport { getAdaptor, useHostContext } from \"../bridges/index.js\";\nimport { filterViewContext, injectViewContext } from \"../helpers/state.js\";\nimport type { UnknownObject } from \"../types.js\";\n\n/**\n * Persist a piece of UI state on the host, so it survives view remounts and\n * is restored on subsequent renders of the same tool invocation.\n *\n * Returns a `[state, setState]` pair with the same ergonomics as\n * `useState`. State is filtered to strip Skybridge-internal context fields\n * (see {@link DataLLM}) before being returned to your component.\n *\n * Provide a `defaultState` (value or lazy initializer) to get a non-nullable\n * tuple; omit it for `T | null`.\n *\n * @typeParam T - Shape of the persisted state. Must be a plain object.\n *\n * @example\n * ```tsx\n * const [filters, setFilters] = useViewState({ sort: \"newest\", page: 1 });\n * setFilters((f) => ({ ...f, page: f.page + 1 }));\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-view-state\n */\nexport function useViewState<T extends UnknownObject>(\n  defaultState: T | (() => T),\n): readonly [T, (state: SetStateAction<T>) => void];\nexport function useViewState<T extends UnknownObject>(\n  defaultState?: T | (() => T | null) | null,\n): readonly [T | null, (state: SetStateAction<T | null>) => void];\nexport function useViewState<T extends UnknownObject>(\n  defaultState?: T | (() => T | null) | null,\n): readonly [T | null, (state: SetStateAction<T | null>) => void] {\n  const adaptor = getAdaptor();\n  const viewStateFromBridge = useHostContext(\"viewState\") as T | null;\n\n  const [viewState, _setViewState] = useState<T | null>(() => {\n    if (viewStateFromBridge !== null) {\n      return filterViewContext(viewStateFromBridge);\n    }\n\n    return typeof defaultState === \"function\"\n      ? defaultState()\n      : (defaultState ?? null);\n  });\n\n  useEffect(() => {\n    if (viewStateFromBridge !== null) {\n      _setViewState(filterViewContext(viewStateFromBridge));\n    }\n  }, [viewStateFromBridge]);\n\n  const setViewState = useCallback(\n    (state: SetStateAction<T | null>) => {\n      _setViewState((prevState) => {\n        const newState = typeof state === \"function\" ? state(prevState) : state;\n        const stateToSet = injectViewContext(newState);\n\n        if (stateToSet !== null) {\n          adaptor.setViewState(stateToSet);\n        }\n\n        return filterViewContext(stateToSet);\n      });\n    },\n    [adaptor],\n  );\n\n  return [viewState, setViewState] as const;\n}\n"]}

package/dist/web/hooks/use-view-state.test.d.ts

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