skybridge 0.0.0-dev.7d48f61 → 0.0.0-dev.7d4c70e

package/dist/web/generate-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-helpers.js","sourceRoot":"","sources":["../../src/web/generate-helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAIL,WAAW,GACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,UAAU,eAAe;IAI7B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAc,EAId,EAAE;YACF,OAAO,WAAW,CAAC,IAAI,CAGtB,CAAC;QACJ,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,OAAO,WAAW,EAIjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  InferTools,\n  ToolInput,\n  ToolOutput,\n  ToolResponseMetadata,\n} from \"../server/index.js\";\nimport type { CallToolResponse } from \"./bridges/types.js\";\nimport {\n  type CallToolAsyncFn,\n  type CallToolFn,\n  type CallToolState,\n  useCallTool,\n} from \"./hooks/use-call-tool.js\";\nimport { type ToolState, useToolInfo } from \"./hooks/use-tool-info.js\";\nimport type { Objectify, Prettify } from \"./types.js\";\n\ntype TypedCallToolResponse<TOutput> = CallToolResponse & {\n  structuredContent: TOutput;\n};\n\ntype TypedCallToolReturn<TInput, TOutput> = Prettify<\n  CallToolState<TypedCallToolResponse<TOutput>> & {\n    callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;\n    callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;\n  }\n>;\n\ntype TypedToolInfoReturn<TInput, TOutput, TResponseMetadata> = ToolState<\n  Objectify<TInput>,\n  Objectify<TOutput>,\n  Objectify<TResponseMetadata>\n>;\n\n/**\n * Creates typed versions of skybridge hooks with full type inference\n * for tool names, inputs, and outputs.\n *\n * This is the recommended way to use skybridge hooks in your views.\n * Set this up once in a dedicated file and export the typed hooks for use across your app.\n *\n * @typeParam ServerType - The type of your McpServer instance (use `typeof server`).\n *                         Must be a server instance created with method chaining.\n *                         TypeScript will validate that tools can be inferred from this type.\n *\n * @example\n * ```typescript\n * // src/server.ts\n * const server = new McpServer({ name: \"my-app\", version: \"1.0\" }, {})\n *   .registerTool({\n *     name: \"search-trip\",\n *     inputSchema: { destination: z.string() },\n *     outputSchema: { results: z.array(z.string()) },\n *     view: { component: \"search-trip\", description: \"Search trips\" },\n *   }, async ({ destination }) => {\n *     return { content: [{ type: \"text\", text: `Found trips to ${destination}` }] };\n *   });\n *\n * export type AppType = typeof server;\n * ```\n *\n * @example\n * ```typescript\n * // src/helpers.ts (one-time setup)\n * import type { AppType } from \"./server\";\n * import { generateHelpers } from \"skybridge/web\";\n *\n * export const { useCallTool, useToolInfo } = generateHelpers<AppType>();\n * ```\n *\n * @example\n * ```typescript\n * // src/views/search.tsx (usage)\n * import { useCallTool, useToolInfo } from \"../helpers\";\n *\n * export function SearchView() {\n *   const { callTool, data } = useCallTool(\"search-trip\");\n *   //                                      ^ autocomplete for tool names\n *   callTool({ destination: \"Spain\" });\n *   //         ^ autocomplete for input fields\n *\n *   const toolInfo = useToolInfo<\"search-trip\">();\n *   //                              ^ autocomplete for view names\n *   // toolInfo.input is typed based on view input schema\n *   // toolInfo.output.structuredContent is typed based on view output schema\n * }\n * ```\n */\nexport function generateHelpers<ServerType = never>() {\n  type Tools = InferTools<ServerType>;\n  type ToolNames = keyof Tools & string;\n\n  return {\n    /**\n     * Typed version of `useCallTool` that provides autocomplete for tool names\n     * and type inference for inputs and outputs.\n     *\n     * @param name - The name of the tool to call. Autocompletes based on your server's tool registry.\n     * @returns A hook with typed `callTool` function and `data` property.\n     *\n     * @example\n     * ```typescript\n     * const { callTool, data, isPending } = useCallTool(\"search-trip\");\n     * // TypeScript knows callTool expects { destination: string }\n     * callTool({ destination: \"Spain\" });\n     *\n     * // data.structuredContent is typed based on your outputSchema\n     * if (data) {\n     *   console.log(data.structuredContent.results);\n     * }\n     * ```\n     */\n    useCallTool: <ToolName extends ToolNames>(\n      name: ToolName,\n    ): TypedCallToolReturn<\n      ToolInput<ServerType, ToolName>,\n      ToolOutput<ServerType, ToolName>\n    > => {\n      return useCallTool(name) as TypedCallToolReturn<\n        ToolInput<ServerType, ToolName>,\n        ToolOutput<ServerType, ToolName>\n      >;\n    },\n\n    /**\n     * Typed version of `useToolInfo` that provides autocomplete for tool names\n     * and type inference for inputs, outputs, and responseMetadata.\n     *\n     * @typeParam K - The name of the tool. Autocompletes based on your server's tool registry.\n     * @returns A discriminated union with `status: \"pending\" | \"success\"` that narrows correctly.\n     *\n     * @example\n     * ```typescript\n     * const toolInfo = useToolInfo<\"search-trip\">();\n     * // toolInfo.input is typed as { destination: string; ... }\n     * // toolInfo.output is typed as { results: Array<...>; ... }\n     * // toolInfo.responseMetadata is typed based on _meta in callback return\n     * // toolInfo.status narrows correctly: \"pending\" | \"success\"\n     *\n     * if (toolInfo.isPending) {\n     *   // TypeScript knows output and responseMetadata are undefined here\n     *   console.log(toolInfo.input.destination);\n     * }\n     *\n     * if (toolInfo.isSuccess) {\n     *   // TypeScript knows output and responseMetadata are defined here\n     *   console.log(toolInfo.output.results);\n     *   console.log(toolInfo.responseMetadata);\n     * }\n     * ```\n     */\n    useToolInfo: <ToolName extends ToolNames>(): TypedToolInfoReturn<\n      ToolInput<ServerType, ToolName>,\n      ToolOutput<ServerType, ToolName>,\n      ToolResponseMetadata<ServerType, ToolName>\n    > => {\n      return useToolInfo() as TypedToolInfoReturn<\n        ToolInput<ServerType, ToolName>,\n        ToolOutput<ServerType, ToolName>,\n        ToolResponseMetadata<ServerType, ToolName>\n      >;\n    },\n  };\n}\n"]}
+{"version":3,"file":"generate-helpers.js","sourceRoot":"","sources":["../../src/web/generate-helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAIL,WAAW,GACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,UAAU,eAAe;IAI7B,OAAO;QACL;;;;;;;;;;;;;;;;;;WAkBG;QACH,WAAW,EAAE,CACX,IAAc,EAId,EAAE;YACF,OAAO,WAAW,CAAC,IAAI,CAGtB,CAAC;QACJ,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,WAAW,EAAE,GAIX,EAAE;YACF,OAAO,WAAW,EAIjB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  InferTools,\n  ToolInput,\n  ToolOutput,\n  ToolResponseMetadata,\n} from \"../server/index.js\";\nimport type { CallToolResponse } from \"./bridges/types.js\";\nimport {\n  type CallToolAsyncFn,\n  type CallToolFn,\n  type CallToolState,\n  useCallTool,\n} from \"./hooks/use-call-tool.js\";\nimport { type ToolState, useToolInfo } from \"./hooks/use-tool-info.js\";\nimport type { Objectify, Prettify } from \"./types.js\";\n\ntype TypedCallToolResponse<TOutput> = CallToolResponse & {\n  structuredContent: TOutput;\n};\n\ntype TypedCallToolReturn<TInput, TOutput> = Prettify<\n  CallToolState<TypedCallToolResponse<TOutput>> & {\n    callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;\n    callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;\n  }\n>;\n\ntype TypedToolInfoReturn<TInput, TOutput, TResponseMetadata> = ToolState<\n  Objectify<TInput>,\n  Objectify<TOutput>,\n  Objectify<TResponseMetadata>\n>;\n\n/**\n * Creates typed versions of skybridge hooks with full type inference\n * for tool names, inputs, and outputs.\n *\n * This is the recommended way to use skybridge hooks in your views.\n * Set this up once in a dedicated file and export the typed hooks for use across your app.\n *\n * @typeParam ServerType - The type of your McpServer instance (use `typeof server`).\n *                         Must be a server instance created with method chaining.\n *                         TypeScript will validate that tools can be inferred from this type.\n *\n * @example\n * ```typescript\n * // src/server.ts\n * const server = new McpServer({ name: \"my-app\", version: \"1.0\" }, {})\n *   .registerTool({\n *     name: \"search-trip\",\n *     inputSchema: { destination: z.string() },\n *     outputSchema: { results: z.array(z.string()) },\n *     view: { component: \"search-trip\", description: \"Search trips\" },\n *   }, async ({ destination }) => {\n *     return { content: [{ type: \"text\", text: `Found trips to ${destination}` }] };\n *   });\n *\n * export type AppType = typeof server;\n * ```\n *\n * @example\n * ```typescript\n * // src/helpers.ts (one-time setup)\n * import type { AppType } from \"./server\";\n * import { generateHelpers } from \"skybridge/web\";\n *\n * export const { useCallTool, useToolInfo } = generateHelpers<AppType>();\n * ```\n *\n * @example\n * ```typescript\n * // src/views/search.tsx (usage)\n * import { useCallTool, useToolInfo } from \"../helpers\";\n *\n * export function SearchView() {\n *   const { callTool, data } = useCallTool(\"search-trip\");\n *   //                                      ^ autocomplete for tool names\n *   callTool({ destination: \"Spain\" });\n *   //         ^ autocomplete for input fields\n *\n *   const toolInfo = useToolInfo<\"search-trip\">();\n *   //                              ^ autocomplete for view names\n *   // toolInfo.input is typed based on view input schema\n *   // toolInfo.output.structuredContent is typed based on view output schema\n * }\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/generate-helpers\n */\nexport function generateHelpers<ServerType = never>() {\n  type Tools = InferTools<ServerType>;\n  type ToolNames = keyof Tools & string;\n\n  return {\n    /**\n     * Typed version of `useCallTool` that provides autocomplete for tool names\n     * and type inference for inputs and outputs.\n     *\n     * @param name - The name of the tool to call. Autocompletes based on your server's tool registry.\n     * @returns A hook with typed `callTool` function and `data` property.\n     *\n     * @example\n     * ```typescript\n     * const { callTool, data, isPending } = useCallTool(\"search-trip\");\n     * // TypeScript knows callTool expects { destination: string }\n     * callTool({ destination: \"Spain\" });\n     *\n     * // data.structuredContent is typed based on your outputSchema\n     * if (data) {\n     *   console.log(data.structuredContent.results);\n     * }\n     * ```\n     */\n    useCallTool: <ToolName extends ToolNames>(\n      name: ToolName,\n    ): TypedCallToolReturn<\n      ToolInput<ServerType, ToolName>,\n      ToolOutput<ServerType, ToolName>\n    > => {\n      return useCallTool(name) as TypedCallToolReturn<\n        ToolInput<ServerType, ToolName>,\n        ToolOutput<ServerType, ToolName>\n      >;\n    },\n\n    /**\n     * Typed version of `useToolInfo` that provides autocomplete for tool names\n     * and type inference for inputs, outputs, and responseMetadata.\n     *\n     * @typeParam K - The name of the tool. Autocompletes based on your server's tool registry.\n     * @returns A discriminated union with `status: \"pending\" | \"success\"` that narrows correctly.\n     *\n     * @example\n     * ```typescript\n     * const toolInfo = useToolInfo<\"search-trip\">();\n     * // toolInfo.input is typed as { destination: string; ... }\n     * // toolInfo.output is typed as { results: Array<...>; ... }\n     * // toolInfo.responseMetadata is typed based on _meta in callback return\n     * // toolInfo.status narrows correctly: \"pending\" | \"success\"\n     *\n     * if (toolInfo.isPending) {\n     *   // TypeScript knows output and responseMetadata are undefined here\n     *   console.log(toolInfo.input.destination);\n     * }\n     *\n     * if (toolInfo.isSuccess) {\n     *   // TypeScript knows output and responseMetadata are defined here\n     *   console.log(toolInfo.output.results);\n     *   console.log(toolInfo.responseMetadata);\n     * }\n     * ```\n     */\n    useToolInfo: <ToolName extends ToolNames>(): TypedToolInfoReturn<\n      ToolInput<ServerType, ToolName>,\n      ToolOutput<ServerType, ToolName>,\n      ToolResponseMetadata<ServerType, ToolName>\n    > => {\n      return useToolInfo() as TypedToolInfoReturn<\n        ToolInput<ServerType, ToolName>,\n        ToolOutput<ServerType, ToolName>,\n        ToolResponseMetadata<ServerType, ToolName>\n      >;\n    },\n  };\n}\n"]}

package/dist/web/generate-helpers.test-d.js

@@ -154,11 +154,13 @@ test("generateHelpers provides autocomplete for tool names in useToolInfo (views
 test("useToolInfo infers input and output types", () => {
     const { useToolInfo } = generateHelpers();
     const toolInfo = useToolInfo();
-    // Input is only available when not in idle state
-    if (!(toolInfo.status === "idle")) {
+    // Input is optional in pending — host may not have delivered args yet
+    if (toolInfo.status === "pending") {
         expectTypeOf(toolInfo.input).toExtend();
     }
     if (toolInfo.status === "success") {
+        // Input is optional in success — the host may not have surfaced args yet
+        expectTypeOf(toolInfo.input).toExtend();
         expectTypeOf(toolInfo.output).toExtend();
         expectTypeOf(toolInfo.output.results).toBeArray();
         expectTypeOf(toolInfo.output.totalCount).toBeNumber();

package/dist/web/generate-helpers.test-d.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-helpers.test-d.js","sourceRoot":"","sources":["../../src/web/generate-helpers.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQ5C,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;AAGlC,MAAM,eAAe,GAAG,yBAAyB,EAAE,CAAC;AAGpD,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAS,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACpD,YAAY,EAAS,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACzD,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACxD,YAAY,EAAS,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;IAC7D,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAGlF,YAAY,EAAS,CAAC,aAAa,EAUhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IAGrE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;IAIL,YAAY,EAAkB,CAAC,aAAa,EAGxC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,GAAG,EAAE;IAGzF,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;IAML,YAAY,EAAmB,CAAC,aAAa,EAGzC,CAAC;IAGL,YAAY,EAAiB,CAAC,aAAa,EAA0B,CAAC;AACxE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;IAGhF,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;IAIL,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IACvF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/B,WAAW,CAAC,sBAAsB,CAAC,CAAC;IACpC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAEvC,6DAA6D;IAC7D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE;IACjF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAEjE,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,+CAA+C;IAC/C,QAAQ,EAAE,CAAC;IAEX,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,mBAAmB;IACnB,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACxE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CACN,EAAE,WAAW,EAAE,OAAO,EAAE,EACxB;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC5B,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;YACnE,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;IAEH,QAAQ,CACN,EAAE,EACF;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,cAAc,GAAG,YAAY,EAAE,CAAC;IACtC,YAAY,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAE5C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAOzC,CAAC;QAEL,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACzD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC/D,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4FAA4F,EAAE,GAAG,EAAE;IACtG,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,EAAiB,CAAC;IAC7B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAqB,CAAC;IACjC,WAAW,EAA0B,CAAC;IACtC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAwB,CAAC;IACpC,WAAW,EAAwB,CAAC;IACpC,WAAW,EAA6B,CAAC;IAEzC,6DAA6D;IAC7D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACrD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAiB,CAAC;IAE9C,iDAAiD;IACjD,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;IACN,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAEnC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAClD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACxD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAElE,YAAY,EAAY,CAAC,aAAa,EAIlC,CAAC;IAGL,YAAY,EAAY,CAAC,aAAa,EAGlC,CAAC;IAGL,YAAY,EAAc,CAAC,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACzE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAwB,CAAC;IAErD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAIvE,YAAY,EAAa,CAAC,aAAa,EAGnC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAuB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC/D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;IAC7D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IAMvF,YAAY,EAAqB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAChE,YAAY,EAAoC,CAAC,UAAU,EAAE,CAAC;IAC9D,YAAY,EAAgC,CAAC,UAAU,EAAE,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC7D,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,eAAe,EAAuB,CAAC;IAE5E,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC/C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3D,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,EAAoB,CAAC;IACjD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QACjE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type {\n  InferTools,\n  ToolInput,\n  ToolNames,\n  ToolOutput,\n  ToolResponseMetadata,\n} from \"../server/index.js\";\nimport { createInterfaceTestServer, createTestServer } from \"../test/utils.js\";\nimport { generateHelpers } from \"./generate-helpers.js\";\n\nconst server = createTestServer();\ntype TestServer = typeof server;\n\nconst interfaceServer = createInterfaceTestServer();\ntype InterfaceTestServer = typeof interfaceServer;\n\ntest(\"InferTools extracts the tool registry type (views + registerTool)\", () => {\n  type Tools = InferTools<TestServer>;\n\n  expectTypeOf<Tools>().toHaveProperty(\"search-trip\");\n  expectTypeOf<Tools>().toHaveProperty(\"get-trip-details\");\n  expectTypeOf<Tools>().toHaveProperty(\"no-input-view\");\n  expectTypeOf<Tools>().toHaveProperty(\"calculate-price\");\n  expectTypeOf<Tools>().toHaveProperty(\"inferred-output-view\");\n  expectTypeOf<Tools>().toHaveProperty(\"inferred-tool\");\n  expectTypeOf<Tools>().toHaveProperty(\"view-with-metadata\");\n  expectTypeOf<Tools>().toHaveProperty(\"tool-with-metadata\");\n  expectTypeOf<Tools>().toHaveProperty(\"view-with-mixed-returns\");\n});\n\ntest(\"ToolNames returns a union of tool name literals (views + registerTool)\", () => {\n  type Names = ToolNames<TestServer>;\n\n  expectTypeOf<Names>().toEqualTypeOf<\n    | \"search-trip\"\n    | \"get-trip-details\"\n    | \"no-input-view\"\n    | \"calculate-price\"\n    | \"inferred-output-view\"\n    | \"inferred-tool\"\n    | \"view-with-metadata\"\n    | \"tool-with-metadata\"\n    | \"view-with-mixed-returns\"\n  >();\n});\n\ntest(\"ToolInput extracts the correct input type from Zod schema\", () => {\n  type SearchInput = ToolInput<TestServer, \"search-trip\">;\n\n  expectTypeOf<SearchInput>().toEqualTypeOf<{\n    destination: string;\n    departureDate?: string | undefined;\n    maxPrice?: number | undefined;\n  }>();\n\n  type DetailsInput = ToolInput<TestServer, \"get-trip-details\">;\n\n  expectTypeOf<DetailsInput>().toEqualTypeOf<{\n    tripId: string;\n  }>();\n\n  type CalculateInput = ToolInput<TestServer, \"calculate-price\">;\n\n  expectTypeOf<CalculateInput>().toEqualTypeOf<{\n    tripId: string;\n    passengers: number;\n  }>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback's structuredContent\", () => {\n  type SearchOutput = ToolOutput<TestServer, \"search-trip\">;\n\n  expectTypeOf<SearchOutput>().toEqualTypeOf<{\n    results: Array<{\n      id: string;\n      name: string;\n      price: number;\n    }>;\n    totalCount: number;\n  }>();\n\n  type DetailsOutput = ToolOutput<TestServer, \"get-trip-details\">;\n\n  expectTypeOf<DetailsOutput>().toEqualTypeOf<{\n    name: string;\n    description: string;\n    images: string[];\n  }>();\n\n  // Note: outputSchema has totalPrice: z.string(), but callback returns number\n  // Type is inferred from callback, so totalPrice is number\n  type CalculateOutput = ToolOutput<TestServer, \"calculate-price\">;\n\n  expectTypeOf<CalculateOutput>().toEqualTypeOf<{\n    totalPrice: number;\n    currency: string;\n  }>();\n\n  type NoInputOutput = ToolOutput<TestServer, \"no-input-view\">;\n  expectTypeOf<NoInputOutput>().toEqualTypeOf<Record<never, unknown>>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback (inferred)\", () => {\n  type InferredViewOutput = ToolOutput<TestServer, \"inferred-output-view\">;\n\n  expectTypeOf<InferredViewOutput>().toEqualTypeOf<{\n    inferredResults: { id: string; score: number }[];\n    inferredCount: number;\n  }>();\n\n  type InferredToolOutput = ToolOutput<TestServer, \"inferred-tool\">;\n\n  expectTypeOf<InferredToolOutput>().toEqualTypeOf<{\n    itemDetails: { name: string; available: boolean };\n    fetchedAt: string;\n  }>();\n});\n\ntest(\"generateHelpers provides autocomplete for tool names (views + registerTool)\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  useCallTool(\"search-trip\");\n  useCallTool(\"get-trip-details\");\n  useCallTool(\"no-input-view\");\n  useCallTool(\"calculate-price\");\n  useCallTool(\"inferred-output-view\");\n  useCallTool(\"inferred-tool\");\n  useCallTool(\"view-with-metadata\");\n  useCallTool(\"tool-with-metadata\");\n  useCallTool(\"view-with-mixed-returns\");\n\n  // @ts-expect-error - \"invalid-name\" is not a valid tool name\n  useCallTool(\"invalid-name\");\n});\n\ntest(\"useCallTool returns correctly typed callTool function\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  callTool({ destination: \"Spain\" });\n  callTool({ destination: \"France\", departureDate: \"2024-06-01\" });\n  callTool({ destination: \"Italy\", maxPrice: 1000 });\n\n  const { callTool: calculateTool } = useCallTool(\"calculate-price\");\n  calculateTool({ tripId: \"123\", passengers: 2 });\n});\n\ntest(\"callTool can be called without args for tools with no required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool, callToolAsync } = useCallTool(\"no-input-view\");\n\n  callTool();\n\n  callTool({});\n\n  callToolAsync();\n  callToolAsync({});\n});\n\ntest(\"callTool requires args for tools with required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  // @ts-expect-error - \"destination\" is required\n  callTool();\n\n  // @ts-expect-error - \"destination\" is required\n  callTool({});\n\n  // This should work\n  callTool({ destination: \"Spain\" });\n});\n\ntest(\"callTool supports sideEffects for tools with required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  callTool(\n    { destination: \"Spain\" },\n    {\n      onSuccess: (response, args) => {\n        expectTypeOf(response.structuredContent.results).toBeArray();\n        expectTypeOf(args.destination).toBeString();\n      },\n      onError: (error, args) => {\n        expectTypeOf(error).toBeUnknown();\n        expectTypeOf(args.destination).toBeString();\n      },\n      onSettled: (response, error, args) => {\n        if (response) {\n          expectTypeOf(response.structuredContent.totalCount).toBeNumber();\n        }\n        expectTypeOf(error).toBeUnknown();\n        expectTypeOf(args.destination).toBeString();\n      },\n    },\n  );\n});\n\ntest(\"callTool supports sideEffects for tools with no required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"no-input-view\");\n\n  callTool({\n    onSuccess: (response) => {\n      expectTypeOf(response).toHaveProperty(\"structuredContent\");\n    },\n  });\n\n  callTool(\n    {},\n    {\n      onSuccess: (response) => {\n        expectTypeOf(response).toHaveProperty(\"structuredContent\");\n      },\n    },\n  );\n});\n\ntest(\"callToolAsync returns correctly typed promise\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  const { callToolAsync: searchAsync } = useCallTool(\"search-trip\");\n  const searchPromise = searchAsync({ destination: \"Spain\" });\n  expectTypeOf(searchPromise).resolves.toHaveProperty(\"structuredContent\");\n\n  const { callToolAsync: noInputAsync } = useCallTool(\"no-input-view\");\n  const noInputPromise = noInputAsync();\n  expectTypeOf(noInputPromise).resolves.toHaveProperty(\"structuredContent\");\n});\n\ntest(\"useCallTool returns correctly typed data\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { data } = useCallTool(\"search-trip\");\n\n  if (data) {\n    expectTypeOf(data.structuredContent).toExtend<{\n      results: Array<{\n        id: string;\n        name: string;\n        price: number;\n      }>;\n      totalCount: number;\n    }>();\n\n    expectTypeOf(data.structuredContent.results).toBeArray();\n    expectTypeOf(data.structuredContent.totalCount).toBeNumber();\n  }\n});\n\ntest(\"useCallTool returns correctly typed data for callback-inferred outputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  const { data: viewData } = useCallTool(\"inferred-output-view\");\n  if (viewData) {\n    expectTypeOf(viewData.structuredContent).toExtend<{\n      inferredResults: { id: string; score: number }[];\n      inferredCount: number;\n    }>();\n  }\n\n  const { data: toolData } = useCallTool(\"inferred-tool\");\n  if (toolData) {\n    expectTypeOf(toolData.structuredContent).toExtend<{\n      itemDetails: { name: string; available: boolean };\n      fetchedAt: string;\n    }>();\n  }\n});\n\ntest(\"generateHelpers provides autocomplete for tool names in useToolInfo (views + registerTool)\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n\n  useToolInfo<\"search-trip\">();\n  useToolInfo<\"get-trip-details\">();\n  useToolInfo<\"no-input-view\">();\n  useToolInfo<\"calculate-price\">();\n  useToolInfo<\"inferred-output-view\">();\n  useToolInfo<\"inferred-tool\">();\n  useToolInfo<\"view-with-metadata\">();\n  useToolInfo<\"tool-with-metadata\">();\n  useToolInfo<\"view-with-mixed-returns\">();\n\n  // @ts-expect-error - \"invalid-name\" is not a valid tool name\n  useToolInfo<\"invalid-name\">();\n});\n\ntest(\"useToolInfo infers input and output types\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n  const toolInfo = useToolInfo<\"search-trip\">();\n\n  // Input is only available when not in idle state\n  if (!(toolInfo.status === \"idle\")) {\n    expectTypeOf(toolInfo.input).toExtend<\n      ToolInput<TestServer, \"search-trip\">\n    >();\n  }\n\n  if (toolInfo.status === \"success\") {\n    expectTypeOf(toolInfo.output).toExtend<\n      ToolOutput<TestServer, \"search-trip\">\n    >();\n    expectTypeOf(toolInfo.output.results).toBeArray();\n    expectTypeOf(toolInfo.output.totalCount).toBeNumber();\n  }\n});\n\ntest(\"ToolResponseMetadata extracts _meta type from callback\", () => {\n  type ViewMeta = ToolResponseMetadata<TestServer, \"view-with-metadata\">;\n  expectTypeOf<ViewMeta>().toEqualTypeOf<{\n    requestId: string;\n    timestamp: number;\n    cached: boolean;\n  }>();\n\n  type ToolMeta = ToolResponseMetadata<TestServer, \"tool-with-metadata\">;\n  expectTypeOf<ToolMeta>().toEqualTypeOf<{\n    executionTime: number;\n    source: string;\n  }>();\n\n  type SearchMeta = ToolResponseMetadata<TestServer, \"search-trip\">;\n  expectTypeOf<SearchMeta>().toBeUnknown();\n});\n\ntest(\"useToolInfo infers responseMetadata type from generateHelpers\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n  const toolInfo = useToolInfo<\"view-with-metadata\">();\n\n  if (toolInfo.isSuccess) {\n    expectTypeOf(toolInfo.responseMetadata.requestId).toBeString();\n    expectTypeOf(toolInfo.responseMetadata.timestamp).toBeNumber();\n    expectTypeOf(toolInfo.responseMetadata.cached).toBeBoolean();\n  }\n});\n\ntest(\"ToolResponseMetadata extracts _meta from mixed return paths\", () => {\n  // View has multiple return paths: some with _meta, some without\n  // ExtractMeta should still infer the _meta type from branches that have it\n  type MixedMeta = ToolResponseMetadata<TestServer, \"view-with-mixed-returns\">;\n  expectTypeOf<MixedMeta>().toEqualTypeOf<{\n    processedAt: number;\n    region: string;\n  }>();\n});\n\ntest(\"ToolOutput extracts correct type when using interface declaration\", () => {\n  type InterfaceViewOutput = ToolOutput<InterfaceTestServer, \"interface-view\">;\n\n  expectTypeOf<InterfaceViewOutput>().toHaveProperty(\"itemName\");\n  expectTypeOf<InterfaceViewOutput[\"itemName\"]>().toBeString();\n  expectTypeOf<InterfaceViewOutput[\"quantity\"]>().toBeNumber();\n});\n\ntest(\"ToolResponseMetadata extracts correct type when using interface declaration\", () => {\n  type InterfaceViewMeta = ToolResponseMetadata<\n    InterfaceTestServer,\n    \"interface-view\"\n  >;\n\n  expectTypeOf<InterfaceViewMeta>().toHaveProperty(\"processedBy\");\n  expectTypeOf<InterfaceViewMeta[\"processedBy\"]>().toBeString();\n  expectTypeOf<InterfaceViewMeta[\"version\"]>().toBeNumber();\n});\n\ntest(\"generateHelpers works with interface-typed server\", () => {\n  const { useCallTool, useToolInfo } = generateHelpers<InterfaceTestServer>();\n\n  const { data } = useCallTool(\"interface-view\");\n  if (data) {\n    expectTypeOf(data.structuredContent.itemName).toBeString();\n    expectTypeOf(data.structuredContent.quantity).toBeNumber();\n  }\n\n  const toolInfo = useToolInfo<\"interface-view\">();\n  if (toolInfo.isSuccess) {\n    expectTypeOf(toolInfo.output.itemName).toBeString();\n    expectTypeOf(toolInfo.output.quantity).toBeNumber();\n    expectTypeOf(toolInfo.responseMetadata.processedBy).toBeString();\n    expectTypeOf(toolInfo.responseMetadata.version).toBeNumber();\n  }\n});\n"]}
+{"version":3,"file":"generate-helpers.test-d.js","sourceRoot":"","sources":["../../src/web/generate-helpers.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQ5C,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;AAGlC,MAAM,eAAe,GAAG,yBAAyB,EAAE,CAAC;AAGpD,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAS,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACpD,YAAY,EAAS,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACzD,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACxD,YAAY,EAAS,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;IAC7D,YAAY,EAAS,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACtD,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC3D,YAAY,EAAS,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAGlF,YAAY,EAAS,CAAC,aAAa,EAUhC,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IAGrE,YAAY,EAAe,CAAC,aAAa,EAIrC,CAAC;IAIL,YAAY,EAAgB,CAAC,aAAa,EAEtC,CAAC;IAIL,YAAY,EAAkB,CAAC,aAAa,EAGxC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,GAAG,EAAE;IAGzF,YAAY,EAAgB,CAAC,aAAa,EAOtC,CAAC;IAIL,YAAY,EAAiB,CAAC,aAAa,EAIvC,CAAC;IAML,YAAY,EAAmB,CAAC,aAAa,EAGzC,CAAC;IAGL,YAAY,EAAiB,CAAC,aAAa,EAA0B,CAAC;AACxE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;IAGhF,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;IAIL,YAAY,EAAsB,CAAC,aAAa,EAG5C,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IACvF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3B,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAChC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC/B,WAAW,CAAC,sBAAsB,CAAC,CAAC;IACpC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7B,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAClC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAEvC,6DAA6D;IAC7D,WAAW,CAAC,cAAc,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE;IACjF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAEjE,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,+CAA+C;IAC/C,QAAQ,EAAE,CAAC;IAEX,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEb,mBAAmB;IACnB,QAAQ,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACxE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAEhD,QAAQ,CACN,EAAE,WAAW,EAAE,OAAO,EAAE,EACxB;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC5B,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;YACnE,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IAElD,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;IAEH,QAAQ,CACN,EAAE,EACF;QACE,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACtB,YAAY,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7D,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,WAAW,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,cAAc,GAAG,YAAY,EAAE,CAAC;IACtC,YAAY,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAE5C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAOzC,CAAC;QAEL,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACzD,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;IAClF,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC/D,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAG7C,CAAC;IACP,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4FAA4F,EAAE,GAAG,EAAE;IACtG,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IAEtD,WAAW,EAAiB,CAAC;IAC7B,WAAW,EAAsB,CAAC;IAClC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAqB,CAAC;IACjC,WAAW,EAA0B,CAAC;IACtC,WAAW,EAAmB,CAAC;IAC/B,WAAW,EAAwB,CAAC;IACpC,WAAW,EAAwB,CAAC;IACpC,WAAW,EAA6B,CAAC;IAEzC,6DAA6D;IAC7D,WAAW,EAAkB,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACrD,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAiB,CAAC;IAE9C,sEAAsE;IACtE,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;IACN,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,yEAAyE;QACzE,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAElC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAEnC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QAClD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACxD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAElE,YAAY,EAAY,CAAC,aAAa,EAIlC,CAAC;IAGL,YAAY,EAAY,CAAC,aAAa,EAGlC,CAAC;IAGL,YAAY,EAAc,CAAC,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACzE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAc,CAAC;IACtD,MAAM,QAAQ,GAAG,WAAW,EAAwB,CAAC;IAErD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC;QAC/D,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;IAIvE,YAAY,EAAa,CAAC,aAAa,EAGnC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;IAG7E,YAAY,EAAuB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC/D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;IAC7D,YAAY,EAAmC,CAAC,UAAU,EAAE,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;IAMvF,YAAY,EAAqB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAChE,YAAY,EAAoC,CAAC,UAAU,EAAE,CAAC;IAC9D,YAAY,EAAgC,CAAC,UAAU,EAAE,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC7D,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,eAAe,EAAuB,CAAC;IAE5E,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC/C,IAAI,IAAI,EAAE,CAAC;QACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3D,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,EAAoB,CAAC;IACjD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,CAAC;QACjE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type {\n  InferTools,\n  ToolInput,\n  ToolNames,\n  ToolOutput,\n  ToolResponseMetadata,\n} from \"../server/index.js\";\nimport { createInterfaceTestServer, createTestServer } from \"../test/utils.js\";\nimport { generateHelpers } from \"./generate-helpers.js\";\n\nconst server = createTestServer();\ntype TestServer = typeof server;\n\nconst interfaceServer = createInterfaceTestServer();\ntype InterfaceTestServer = typeof interfaceServer;\n\ntest(\"InferTools extracts the tool registry type (views + registerTool)\", () => {\n  type Tools = InferTools<TestServer>;\n\n  expectTypeOf<Tools>().toHaveProperty(\"search-trip\");\n  expectTypeOf<Tools>().toHaveProperty(\"get-trip-details\");\n  expectTypeOf<Tools>().toHaveProperty(\"no-input-view\");\n  expectTypeOf<Tools>().toHaveProperty(\"calculate-price\");\n  expectTypeOf<Tools>().toHaveProperty(\"inferred-output-view\");\n  expectTypeOf<Tools>().toHaveProperty(\"inferred-tool\");\n  expectTypeOf<Tools>().toHaveProperty(\"view-with-metadata\");\n  expectTypeOf<Tools>().toHaveProperty(\"tool-with-metadata\");\n  expectTypeOf<Tools>().toHaveProperty(\"view-with-mixed-returns\");\n});\n\ntest(\"ToolNames returns a union of tool name literals (views + registerTool)\", () => {\n  type Names = ToolNames<TestServer>;\n\n  expectTypeOf<Names>().toEqualTypeOf<\n    | \"search-trip\"\n    | \"get-trip-details\"\n    | \"no-input-view\"\n    | \"calculate-price\"\n    | \"inferred-output-view\"\n    | \"inferred-tool\"\n    | \"view-with-metadata\"\n    | \"tool-with-metadata\"\n    | \"view-with-mixed-returns\"\n  >();\n});\n\ntest(\"ToolInput extracts the correct input type from Zod schema\", () => {\n  type SearchInput = ToolInput<TestServer, \"search-trip\">;\n\n  expectTypeOf<SearchInput>().toEqualTypeOf<{\n    destination: string;\n    departureDate?: string | undefined;\n    maxPrice?: number | undefined;\n  }>();\n\n  type DetailsInput = ToolInput<TestServer, \"get-trip-details\">;\n\n  expectTypeOf<DetailsInput>().toEqualTypeOf<{\n    tripId: string;\n  }>();\n\n  type CalculateInput = ToolInput<TestServer, \"calculate-price\">;\n\n  expectTypeOf<CalculateInput>().toEqualTypeOf<{\n    tripId: string;\n    passengers: number;\n  }>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback's structuredContent\", () => {\n  type SearchOutput = ToolOutput<TestServer, \"search-trip\">;\n\n  expectTypeOf<SearchOutput>().toEqualTypeOf<{\n    results: Array<{\n      id: string;\n      name: string;\n      price: number;\n    }>;\n    totalCount: number;\n  }>();\n\n  type DetailsOutput = ToolOutput<TestServer, \"get-trip-details\">;\n\n  expectTypeOf<DetailsOutput>().toEqualTypeOf<{\n    name: string;\n    description: string;\n    images: string[];\n  }>();\n\n  // Note: outputSchema has totalPrice: z.string(), but callback returns number\n  // Type is inferred from callback, so totalPrice is number\n  type CalculateOutput = ToolOutput<TestServer, \"calculate-price\">;\n\n  expectTypeOf<CalculateOutput>().toEqualTypeOf<{\n    totalPrice: number;\n    currency: string;\n  }>();\n\n  type NoInputOutput = ToolOutput<TestServer, \"no-input-view\">;\n  expectTypeOf<NoInputOutput>().toEqualTypeOf<Record<never, unknown>>();\n});\n\ntest(\"ToolOutput extracts the correct output type from callback (inferred)\", () => {\n  type InferredViewOutput = ToolOutput<TestServer, \"inferred-output-view\">;\n\n  expectTypeOf<InferredViewOutput>().toEqualTypeOf<{\n    inferredResults: { id: string; score: number }[];\n    inferredCount: number;\n  }>();\n\n  type InferredToolOutput = ToolOutput<TestServer, \"inferred-tool\">;\n\n  expectTypeOf<InferredToolOutput>().toEqualTypeOf<{\n    itemDetails: { name: string; available: boolean };\n    fetchedAt: string;\n  }>();\n});\n\ntest(\"generateHelpers provides autocomplete for tool names (views + registerTool)\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  useCallTool(\"search-trip\");\n  useCallTool(\"get-trip-details\");\n  useCallTool(\"no-input-view\");\n  useCallTool(\"calculate-price\");\n  useCallTool(\"inferred-output-view\");\n  useCallTool(\"inferred-tool\");\n  useCallTool(\"view-with-metadata\");\n  useCallTool(\"tool-with-metadata\");\n  useCallTool(\"view-with-mixed-returns\");\n\n  // @ts-expect-error - \"invalid-name\" is not a valid tool name\n  useCallTool(\"invalid-name\");\n});\n\ntest(\"useCallTool returns correctly typed callTool function\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  callTool({ destination: \"Spain\" });\n  callTool({ destination: \"France\", departureDate: \"2024-06-01\" });\n  callTool({ destination: \"Italy\", maxPrice: 1000 });\n\n  const { callTool: calculateTool } = useCallTool(\"calculate-price\");\n  calculateTool({ tripId: \"123\", passengers: 2 });\n});\n\ntest(\"callTool can be called without args for tools with no required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool, callToolAsync } = useCallTool(\"no-input-view\");\n\n  callTool();\n\n  callTool({});\n\n  callToolAsync();\n  callToolAsync({});\n});\n\ntest(\"callTool requires args for tools with required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  // @ts-expect-error - \"destination\" is required\n  callTool();\n\n  // @ts-expect-error - \"destination\" is required\n  callTool({});\n\n  // This should work\n  callTool({ destination: \"Spain\" });\n});\n\ntest(\"callTool supports sideEffects for tools with required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"search-trip\");\n\n  callTool(\n    { destination: \"Spain\" },\n    {\n      onSuccess: (response, args) => {\n        expectTypeOf(response.structuredContent.results).toBeArray();\n        expectTypeOf(args.destination).toBeString();\n      },\n      onError: (error, args) => {\n        expectTypeOf(error).toBeUnknown();\n        expectTypeOf(args.destination).toBeString();\n      },\n      onSettled: (response, error, args) => {\n        if (response) {\n          expectTypeOf(response.structuredContent.totalCount).toBeNumber();\n        }\n        expectTypeOf(error).toBeUnknown();\n        expectTypeOf(args.destination).toBeString();\n      },\n    },\n  );\n});\n\ntest(\"callTool supports sideEffects for tools with no required inputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { callTool } = useCallTool(\"no-input-view\");\n\n  callTool({\n    onSuccess: (response) => {\n      expectTypeOf(response).toHaveProperty(\"structuredContent\");\n    },\n  });\n\n  callTool(\n    {},\n    {\n      onSuccess: (response) => {\n        expectTypeOf(response).toHaveProperty(\"structuredContent\");\n      },\n    },\n  );\n});\n\ntest(\"callToolAsync returns correctly typed promise\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  const { callToolAsync: searchAsync } = useCallTool(\"search-trip\");\n  const searchPromise = searchAsync({ destination: \"Spain\" });\n  expectTypeOf(searchPromise).resolves.toHaveProperty(\"structuredContent\");\n\n  const { callToolAsync: noInputAsync } = useCallTool(\"no-input-view\");\n  const noInputPromise = noInputAsync();\n  expectTypeOf(noInputPromise).resolves.toHaveProperty(\"structuredContent\");\n});\n\ntest(\"useCallTool returns correctly typed data\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n  const { data } = useCallTool(\"search-trip\");\n\n  if (data) {\n    expectTypeOf(data.structuredContent).toExtend<{\n      results: Array<{\n        id: string;\n        name: string;\n        price: number;\n      }>;\n      totalCount: number;\n    }>();\n\n    expectTypeOf(data.structuredContent.results).toBeArray();\n    expectTypeOf(data.structuredContent.totalCount).toBeNumber();\n  }\n});\n\ntest(\"useCallTool returns correctly typed data for callback-inferred outputs\", () => {\n  const { useCallTool } = generateHelpers<TestServer>();\n\n  const { data: viewData } = useCallTool(\"inferred-output-view\");\n  if (viewData) {\n    expectTypeOf(viewData.structuredContent).toExtend<{\n      inferredResults: { id: string; score: number }[];\n      inferredCount: number;\n    }>();\n  }\n\n  const { data: toolData } = useCallTool(\"inferred-tool\");\n  if (toolData) {\n    expectTypeOf(toolData.structuredContent).toExtend<{\n      itemDetails: { name: string; available: boolean };\n      fetchedAt: string;\n    }>();\n  }\n});\n\ntest(\"generateHelpers provides autocomplete for tool names in useToolInfo (views + registerTool)\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n\n  useToolInfo<\"search-trip\">();\n  useToolInfo<\"get-trip-details\">();\n  useToolInfo<\"no-input-view\">();\n  useToolInfo<\"calculate-price\">();\n  useToolInfo<\"inferred-output-view\">();\n  useToolInfo<\"inferred-tool\">();\n  useToolInfo<\"view-with-metadata\">();\n  useToolInfo<\"tool-with-metadata\">();\n  useToolInfo<\"view-with-mixed-returns\">();\n\n  // @ts-expect-error - \"invalid-name\" is not a valid tool name\n  useToolInfo<\"invalid-name\">();\n});\n\ntest(\"useToolInfo infers input and output types\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n  const toolInfo = useToolInfo<\"search-trip\">();\n\n  // Input is optional in pending — host may not have delivered args yet\n  if (toolInfo.status === \"pending\") {\n    expectTypeOf(toolInfo.input).toExtend<\n      ToolInput<TestServer, \"search-trip\"> | undefined\n    >();\n  }\n\n  if (toolInfo.status === \"success\") {\n    // Input is optional in success — the host may not have surfaced args yet\n    expectTypeOf(toolInfo.input).toExtend<\n      ToolInput<TestServer, \"search-trip\"> | undefined\n    >();\n    expectTypeOf(toolInfo.output).toExtend<\n      ToolOutput<TestServer, \"search-trip\">\n    >();\n    expectTypeOf(toolInfo.output.results).toBeArray();\n    expectTypeOf(toolInfo.output.totalCount).toBeNumber();\n  }\n});\n\ntest(\"ToolResponseMetadata extracts _meta type from callback\", () => {\n  type ViewMeta = ToolResponseMetadata<TestServer, \"view-with-metadata\">;\n  expectTypeOf<ViewMeta>().toEqualTypeOf<{\n    requestId: string;\n    timestamp: number;\n    cached: boolean;\n  }>();\n\n  type ToolMeta = ToolResponseMetadata<TestServer, \"tool-with-metadata\">;\n  expectTypeOf<ToolMeta>().toEqualTypeOf<{\n    executionTime: number;\n    source: string;\n  }>();\n\n  type SearchMeta = ToolResponseMetadata<TestServer, \"search-trip\">;\n  expectTypeOf<SearchMeta>().toBeUnknown();\n});\n\ntest(\"useToolInfo infers responseMetadata type from generateHelpers\", () => {\n  const { useToolInfo } = generateHelpers<TestServer>();\n  const toolInfo = useToolInfo<\"view-with-metadata\">();\n\n  if (toolInfo.isSuccess) {\n    expectTypeOf(toolInfo.responseMetadata.requestId).toBeString();\n    expectTypeOf(toolInfo.responseMetadata.timestamp).toBeNumber();\n    expectTypeOf(toolInfo.responseMetadata.cached).toBeBoolean();\n  }\n});\n\ntest(\"ToolResponseMetadata extracts _meta from mixed return paths\", () => {\n  // View has multiple return paths: some with _meta, some without\n  // ExtractMeta should still infer the _meta type from branches that have it\n  type MixedMeta = ToolResponseMetadata<TestServer, \"view-with-mixed-returns\">;\n  expectTypeOf<MixedMeta>().toEqualTypeOf<{\n    processedAt: number;\n    region: string;\n  }>();\n});\n\ntest(\"ToolOutput extracts correct type when using interface declaration\", () => {\n  type InterfaceViewOutput = ToolOutput<InterfaceTestServer, \"interface-view\">;\n\n  expectTypeOf<InterfaceViewOutput>().toHaveProperty(\"itemName\");\n  expectTypeOf<InterfaceViewOutput[\"itemName\"]>().toBeString();\n  expectTypeOf<InterfaceViewOutput[\"quantity\"]>().toBeNumber();\n});\n\ntest(\"ToolResponseMetadata extracts correct type when using interface declaration\", () => {\n  type InterfaceViewMeta = ToolResponseMetadata<\n    InterfaceTestServer,\n    \"interface-view\"\n  >;\n\n  expectTypeOf<InterfaceViewMeta>().toHaveProperty(\"processedBy\");\n  expectTypeOf<InterfaceViewMeta[\"processedBy\"]>().toBeString();\n  expectTypeOf<InterfaceViewMeta[\"version\"]>().toBeNumber();\n});\n\ntest(\"generateHelpers works with interface-typed server\", () => {\n  const { useCallTool, useToolInfo } = generateHelpers<InterfaceTestServer>();\n\n  const { data } = useCallTool(\"interface-view\");\n  if (data) {\n    expectTypeOf(data.structuredContent.itemName).toBeString();\n    expectTypeOf(data.structuredContent.quantity).toBeNumber();\n  }\n\n  const toolInfo = useToolInfo<\"interface-view\">();\n  if (toolInfo.isSuccess) {\n    expectTypeOf(toolInfo.output.itemName).toBeString();\n    expectTypeOf(toolInfo.output.quantity).toBeNumber();\n    expectTypeOf(toolInfo.responseMetadata.processedBy).toBeString();\n    expectTypeOf(toolInfo.responseMetadata.version).toBeNumber();\n  }\n});\n"]}

package/dist/web/hooks/index.d.ts

@@ -1,8 +1,10 @@
 export { type CallToolAsyncFn, type CallToolFn, type CallToolState, type SideEffects, useCallTool, } from "./use-call-tool.js";
 export { useDisplayMode } from "./use-display-mode.js";
+export { type DownloadFn, useDownload } from "./use-download.js";
 export { useFiles } from "./use-files.js";
 export { type LayoutState, useLayout } from "./use-layout.js";
 export { type OpenExternalFn, useOpenExternal } from "./use-open-external.js";
+export { useRegisterViewTool } from "./use-register-view-tool.js";
 export { type RequestCloseFn, useRequestClose } from "./use-request-close.js";
 export { useRequestModal } from "./use-request-modal.js";
 export { type RequestSizeFn, useRequestSize } from "./use-request-size.js";

package/dist/web/hooks/index.js

@@ -1,8 +1,10 @@
 export { useCallTool, } from "./use-call-tool.js";
 export { useDisplayMode } from "./use-display-mode.js";
+export { useDownload } from "./use-download.js";
 export { useFiles } from "./use-files.js";
 export { useLayout } from "./use-layout.js";
 export { useOpenExternal } from "./use-open-external.js";
+export { useRegisterViewTool } from "./use-register-view-tool.js";
 export { useRequestClose } from "./use-request-close.js";
 export { useRequestModal } from "./use-request-modal.js";
 export { useRequestSize } from "./use-request-size.js";

package/dist/web/hooks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAoB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAsB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAkB,OAAO,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export {\n  type CallToolAsyncFn,\n  type CallToolFn,\n  type CallToolState,\n  type SideEffects,\n  useCallTool,\n} from \"./use-call-tool.js\";\nexport { useDisplayMode } from \"./use-display-mode.js\";\nexport { useFiles } from \"./use-files.js\";\nexport { type LayoutState, useLayout } from \"./use-layout.js\";\nexport { type OpenExternalFn, useOpenExternal } from \"./use-open-external.js\";\nexport { type RequestCloseFn, useRequestClose } from \"./use-request-close.js\";\nexport { useRequestModal } from \"./use-request-modal.js\";\nexport { type RequestSizeFn, useRequestSize } from \"./use-request-size.js\";\nexport { useSendFollowUpMessage } from \"./use-send-follow-up-message.js\";\nexport { useSetOpenInAppUrl } from \"./use-set-open-in-app-url.js\";\nexport { useToolInfo } from \"./use-tool-info.js\";\nexport { type UserState, useUser } from \"./use-user.js\";\nexport { useViewState } from \"./use-view-state.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/web/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAoB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAsB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAkB,OAAO,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export {\n  type CallToolAsyncFn,\n  type CallToolFn,\n  type CallToolState,\n  type SideEffects,\n  useCallTool,\n} from \"./use-call-tool.js\";\nexport { useDisplayMode } from \"./use-display-mode.js\";\nexport { type DownloadFn, useDownload } from \"./use-download.js\";\nexport { useFiles } from \"./use-files.js\";\nexport { type LayoutState, useLayout } from \"./use-layout.js\";\nexport { type OpenExternalFn, useOpenExternal } from \"./use-open-external.js\";\nexport { useRegisterViewTool } from \"./use-register-view-tool.js\";\nexport { type RequestCloseFn, useRequestClose } from \"./use-request-close.js\";\nexport { useRequestModal } from \"./use-request-modal.js\";\nexport { type RequestSizeFn, useRequestSize } from \"./use-request-size.js\";\nexport { useSendFollowUpMessage } from \"./use-send-follow-up-message.js\";\nexport { useSetOpenInAppUrl } from \"./use-set-open-in-app-url.js\";\nexport { useToolInfo } from \"./use-tool-info.js\";\nexport { type UserState, useUser } from \"./use-user.js\";\nexport { useViewState } from \"./use-view-state.js\";\n"]}

package/dist/web/hooks/test/utils.d.ts

@@ -1,10 +1,14 @@
-import type { McpUiHostContext, McpUiToolResultNotification } from "@modelcontextprotocol/ext-apps";
+import type { McpUiDownloadFileResult, McpUiHostCapabilities, McpUiHostContext, McpUiToolResultNotification } from "@modelcontextprotocol/ext-apps";
 export declare class MockResizeObserver {
     observe(): void;
     unobserve(): void;
     disconnect(): void;
 }
-export declare const getMcpAppHostPostMessageMock: (initialContext?: McpUiHostContext) => import("vitest").Mock<(message: {
+export type McpAppHostMockOptions = {
+    hostCapabilities?: McpUiHostCapabilities;
+    downloadFileResult?: McpUiDownloadFileResult;
+};
+export declare const getMcpAppHostPostMessageMock: (initialContext?: McpUiHostContext, options?: McpAppHostMockOptions) => import("vitest").Mock<(message: {
     method: string;
     id: number;
 }) => void>;

package/dist/web/hooks/test/utils.js

@@ -7,13 +7,13 @@ export class MockResizeObserver {
     disconnect() { }
 }
 const DEFAULT_CONTEXT = {};
-export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT) => vi.fn((message) => {
+export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT, options = {}) => vi.fn((message) => {
     switch (message.method) {
         case "ui/initialize": {
             const result = {
                 protocolVersion: "2025-06-18",
                 hostInfo: { name: "test-host", version: "1.0.0" },
-                hostCapabilities: {},
+                hostCapabilities: options.hostCapabilities ?? {},
                 hostContext: initialContext,
             };
             act(() => fireEvent(window, new MessageEvent("message", {
@@ -37,6 +37,17 @@ export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT) =
             })));
             break;
         }
+        case "ui/download-file": {
+            act(() => fireEvent(window, new MessageEvent("message", {
+                source: window.parent,
+                data: {
+                    jsonrpc: "2.0",
+                    id: message.id,
+                    result: options.downloadFileResult ?? {},
+                },
+            })));
+            break;
+        }
     }
 });
 export const fireToolInputNotification = (args) => {

package/dist/web/hooks/test/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/web/hooks/test/utils.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,MAAM,OAAO,kBAAkB;IAC7B,OAAO,KAAU,CAAC;IAClB,SAAS,KAAU,CAAC;IACpB,UAAU,KAAU,CAAC;CACtB;AAED,MAAM,eAAe,GAAqB,EAAE,CAAC;AAE7C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,iBAAmC,eAAe,EAClD,EAAE,CACF,EAAE,CAAC,EAAE,CAAC,CAAC,OAAuC,EAAE,EAAE;IAChD,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,MAAM,GAA0B;gBACpC,eAAe,EAAE,YAAY;gBAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE;gBACjD,gBAAgB,EAAE,EAAE;gBACpB,WAAW,EAAE,cAAc;aAC5B,CAAC;YACF,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAIb,SAAS,EAAE;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM;iBACP;aACF,CAAC,CACH,CACF,CAAC;YACF,MAAM;QACR,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;gBACE,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,EAAE;iBACX;aACF,CACF,CACF,CACF,CAAC;YACF,MAAM;QACR,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAA6B,EAAE,EAAE;IACzE,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,6BAA6B;YACrC,MAAM,EAAE;gBACN,SAAS,EAAE,IAAI;aAChB;SACF;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAI1C,EAAE,EAAE;IACH,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,8BAA8B;YACtC,MAAM;SACP;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type {\n  McpUiHostContext,\n  McpUiInitializeResult,\n  McpUiToolInputNotification,\n  McpUiToolResultNotification,\n} from \"@modelcontextprotocol/ext-apps\";\nimport { fireEvent } from \"@testing-library/react\";\nimport { act } from \"react\";\nimport { vi } from \"vitest\";\n\nexport class MockResizeObserver {\n  observe(): void {}\n  unobserve(): void {}\n  disconnect(): void {}\n}\n\nconst DEFAULT_CONTEXT: McpUiHostContext = {};\n\nexport const getMcpAppHostPostMessageMock = (\n  initialContext: McpUiHostContext = DEFAULT_CONTEXT,\n) =>\n  vi.fn((message: { method: string; id: number }) => {\n    switch (message.method) {\n      case \"ui/initialize\": {\n        const result: McpUiInitializeResult = {\n          protocolVersion: \"2025-06-18\",\n          hostInfo: { name: \"test-host\", version: \"1.0.0\" },\n          hostCapabilities: {},\n          hostContext: initialContext,\n        };\n        act(() =>\n          fireEvent(\n            window,\n            new MessageEvent<{\n              jsonrpc: \"2.0\";\n              id: number;\n              result: McpUiInitializeResult;\n            }>(\"message\", {\n              source: window.parent,\n              data: {\n                jsonrpc: \"2.0\",\n                id: message.id,\n                result,\n              },\n            }),\n          ),\n        );\n        break;\n      }\n      case \"ui/update-model-context\": {\n        act(() =>\n          fireEvent(\n            window,\n            new MessageEvent<{ jsonrpc: \"2.0\"; id: number; result: unknown }>(\n              \"message\",\n              {\n                source: window.parent,\n                data: {\n                  jsonrpc: \"2.0\",\n                  id: message.id,\n                  result: {},\n                },\n              },\n            ),\n          ),\n        );\n        break;\n      }\n    }\n  });\n\nexport const fireToolInputNotification = (args: Record<string, unknown>) => {\n  fireEvent(\n    window,\n    new MessageEvent<McpUiToolInputNotification & { jsonrpc: \"2.0\" }>(\n      \"message\",\n      {\n        source: window.parent,\n        data: {\n          jsonrpc: \"2.0\",\n          method: \"ui/notifications/tool-input\",\n          params: {\n            arguments: args,\n          },\n        },\n      },\n    ),\n  );\n};\n\nexport const fireToolResultNotification = (params: {\n  content: McpUiToolResultNotification[\"params\"][\"content\"];\n  structuredContent: Record<string, unknown>;\n  _meta?: Record<string, unknown>;\n}) => {\n  fireEvent(\n    window,\n    new MessageEvent<McpUiToolResultNotification & { jsonrpc: \"2.0\" }>(\n      \"message\",\n      {\n        source: window.parent,\n        data: {\n          jsonrpc: \"2.0\",\n          method: \"ui/notifications/tool-result\",\n          params,\n        },\n      },\n    ),\n  );\n};\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/web/hooks/test/utils.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,MAAM,OAAO,kBAAkB;IAC7B,OAAO,KAAU,CAAC;IAClB,SAAS,KAAU,CAAC;IACpB,UAAU,KAAU,CAAC;CACtB;AAED,MAAM,eAAe,GAAqB,EAAE,CAAC;AAO7C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,iBAAmC,eAAe,EAClD,UAAiC,EAAE,EACnC,EAAE,CACF,EAAE,CAAC,EAAE,CAAC,CAAC,OAAuC,EAAE,EAAE;IAChD,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,MAAM,GAA0B;gBACpC,eAAe,EAAE,YAAY;gBAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE;gBACjD,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,EAAE;gBAChD,WAAW,EAAE,cAAc;aAC5B,CAAC;YACF,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAIb,SAAS,EAAE;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM;iBACP;aACF,CAAC,CACH,CACF,CAAC;YACF,MAAM;QACR,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;gBACE,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,EAAE;iBACX;aACF,CACF,CACF,CACF,CAAC;YACF,MAAM;QACR,CAAC;QACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,GAAG,CAAC,GAAG,EAAE,CACP,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CAIb,SAAS,EAAE;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE;oBACJ,OAAO,EAAE,KAAK;oBACd,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,MAAM,EAAE,OAAO,CAAC,kBAAkB,IAAI,EAAE;iBACzC;aACF,CAAC,CACH,CACF,CAAC;YACF,MAAM;QACR,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAA6B,EAAE,EAAE;IACzE,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,6BAA6B;YACrC,MAAM,EAAE;gBACN,SAAS,EAAE,IAAI;aAChB;SACF;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAI1C,EAAE,EAAE;IACH,SAAS,CACP,MAAM,EACN,IAAI,YAAY,CACd,SAAS,EACT;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,8BAA8B;YACtC,MAAM;SACP;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type {\n  McpUiDownloadFileResult,\n  McpUiHostCapabilities,\n  McpUiHostContext,\n  McpUiInitializeResult,\n  McpUiToolInputNotification,\n  McpUiToolResultNotification,\n} from \"@modelcontextprotocol/ext-apps\";\nimport { fireEvent } from \"@testing-library/react\";\nimport { act } from \"react\";\nimport { vi } from \"vitest\";\n\nexport class MockResizeObserver {\n  observe(): void {}\n  unobserve(): void {}\n  disconnect(): void {}\n}\n\nconst DEFAULT_CONTEXT: McpUiHostContext = {};\n\nexport type McpAppHostMockOptions = {\n  hostCapabilities?: McpUiHostCapabilities;\n  downloadFileResult?: McpUiDownloadFileResult;\n};\n\nexport const getMcpAppHostPostMessageMock = (\n  initialContext: McpUiHostContext = DEFAULT_CONTEXT,\n  options: McpAppHostMockOptions = {},\n) =>\n  vi.fn((message: { method: string; id: number }) => {\n    switch (message.method) {\n      case \"ui/initialize\": {\n        const result: McpUiInitializeResult = {\n          protocolVersion: \"2025-06-18\",\n          hostInfo: { name: \"test-host\", version: \"1.0.0\" },\n          hostCapabilities: options.hostCapabilities ?? {},\n          hostContext: initialContext,\n        };\n        act(() =>\n          fireEvent(\n            window,\n            new MessageEvent<{\n              jsonrpc: \"2.0\";\n              id: number;\n              result: McpUiInitializeResult;\n            }>(\"message\", {\n              source: window.parent,\n              data: {\n                jsonrpc: \"2.0\",\n                id: message.id,\n                result,\n              },\n            }),\n          ),\n        );\n        break;\n      }\n      case \"ui/update-model-context\": {\n        act(() =>\n          fireEvent(\n            window,\n            new MessageEvent<{ jsonrpc: \"2.0\"; id: number; result: unknown }>(\n              \"message\",\n              {\n                source: window.parent,\n                data: {\n                  jsonrpc: \"2.0\",\n                  id: message.id,\n                  result: {},\n                },\n              },\n            ),\n          ),\n        );\n        break;\n      }\n      case \"ui/download-file\": {\n        act(() =>\n          fireEvent(\n            window,\n            new MessageEvent<{\n              jsonrpc: \"2.0\";\n              id: number;\n              result: McpUiDownloadFileResult;\n            }>(\"message\", {\n              source: window.parent,\n              data: {\n                jsonrpc: \"2.0\",\n                id: message.id,\n                result: options.downloadFileResult ?? {},\n              },\n            }),\n          ),\n        );\n        break;\n      }\n    }\n  });\n\nexport const fireToolInputNotification = (args: Record<string, unknown>) => {\n  fireEvent(\n    window,\n    new MessageEvent<McpUiToolInputNotification & { jsonrpc: \"2.0\" }>(\n      \"message\",\n      {\n        source: window.parent,\n        data: {\n          jsonrpc: \"2.0\",\n          method: \"ui/notifications/tool-input\",\n          params: {\n            arguments: args,\n          },\n        },\n      },\n    ),\n  );\n};\n\nexport const fireToolResultNotification = (params: {\n  content: McpUiToolResultNotification[\"params\"][\"content\"];\n  structuredContent: Record<string, unknown>;\n  _meta?: Record<string, unknown>;\n}) => {\n  fireEvent(\n    window,\n    new MessageEvent<McpUiToolResultNotification & { jsonrpc: \"2.0\" }>(\n      \"message\",\n      {\n        source: window.parent,\n        data: {\n          jsonrpc: \"2.0\",\n          method: \"ui/notifications/tool-result\",\n          params,\n        },\n      },\n    ),\n  );\n};\n"]}

package/dist/web/hooks/use-call-tool.d.ts

@@ -36,13 +36,26 @@ type CallToolErrorState = {
     data: undefined;
     error: unknown;
 };
+/**
+ * State of a {@link useCallTool} invocation, discriminated by `status`.
+ * Use `isIdle` / `isPending` / `isSuccess` / `isError` for ergonomic conditional rendering.
+ */
 export type CallToolState<TData extends CallToolResponse = CallToolResponse> = CallToolIdleState | CallToolPendingState | CallToolSuccessState<TData> | CallToolErrorState;
+/**
+ * Optional callbacks fired around a {@link useCallTool} call.
+ * `onSettled` runs after success or error.
+ */
 export type SideEffects<ToolArgs, ToolResponse> = {
     onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;
     onError?: (error: unknown, toolArgs: ToolArgs) => void;
     onSettled?: (data: ToolResponse | undefined, error: unknown | undefined, toolArgs: ToolArgs) => void;
 };
 type IsArgsOptional<T> = [T] extends [null] ? true : HasRequiredKeys<T> extends false ? true : false;
+/**
+ * Fire-and-forget call function returned by {@link useCallTool}. Tracks state
+ * on the hook and supports optional {@link SideEffects} callbacks. Args are
+ * optional when the tool accepts none.
+ */
 export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
     (): void;
     (sideEffects: SideEffects<TArgs, TResponse>): void;
@@ -52,11 +65,43 @@ export type CallToolFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ?
     (args: TArgs): void;
     (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;
 };
+/**
+ * Promise-returning call function returned by {@link useCallTool}. Rejects
+ * if the tool errors; use `try/catch` for error handling.
+ */
 export type CallToolAsyncFn<TArgs, TResponse> = IsArgsOptional<TArgs> extends true ? {
     (): Promise<TResponse>;
     (args: TArgs): Promise<TResponse>;
 } : (args: TArgs) => Promise<TResponse>;
 type ToolResponseSignature = Pick<CallToolResponse, "structuredContent" | "meta">;
+/**
+ * Call a server tool from a view and track its execution state.
+ *
+ * Returns the current {@link CallToolState} plus two callers: `callTool`
+ * (fire-and-forget, with optional {@link SideEffects}) and `callToolAsync`
+ * (promise-returning). If the same instance is invoked again while a call is
+ * in flight, the older response is dropped from the rendered state (but any
+ * `onSuccess` / `onError` / `onSettled` callbacks attached to it still fire).
+ *
+ * Pair with {@link useToolInfo} to read the result of the tool invocation
+ * that produced the current view. For end-to-end type safety across tool
+ * inputs and outputs, prefer the typed helpers produced by {@link generateHelpers}
+ * over calling this hook directly.
+ *
+ * @typeParam ToolArgs - Shape of the tool's input args (`null` for no-arg tools).
+ * @typeParam ToolResponse - Shape of the tool's `structuredContent` / `meta`.
+ *
+ * @example
+ * ```tsx
+ * const { callTool, isPending, data } = useCallTool<{ query: string }>("search");
+ *
+ * <button onClick={() => callTool({ query: "skybridge" }, {
+ *   onSuccess: (res) => console.log(res.structuredContent),
+ * })} />
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-call-tool
+ */
 export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = Record<string, never>>(name: string) => {
     callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
     callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;

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

@@ -1,5 +1,33 @@
 import { useRef, useState } from "react";
 import { getAdaptor, } from "../bridges/index.js";
+/**
+ * Call a server tool from a view and track its execution state.
+ *
+ * Returns the current {@link CallToolState} plus two callers: `callTool`
+ * (fire-and-forget, with optional {@link SideEffects}) and `callToolAsync`
+ * (promise-returning). If the same instance is invoked again while a call is
+ * in flight, the older response is dropped from the rendered state (but any
+ * `onSuccess` / `onError` / `onSettled` callbacks attached to it still fire).
+ *
+ * Pair with {@link useToolInfo} to read the result of the tool invocation
+ * that produced the current view. For end-to-end type safety across tool
+ * inputs and outputs, prefer the typed helpers produced by {@link generateHelpers}
+ * over calling this hook directly.
+ *
+ * @typeParam ToolArgs - Shape of the tool's input args (`null` for no-arg tools).
+ * @typeParam ToolResponse - Shape of the tool's `structuredContent` / `meta`.
+ *
+ * @example
+ * ```tsx
+ * const { callTool, isPending, data } = useCallTool<{ query: string }>("search");
+ *
+ * <button onClick={() => callTool({ query: "skybridge" }, {
+ *   onSuccess: (res) => console.log(res.structuredContent),
+ * })} />
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-call-tool
+ */
 export const useCallTool = (name) => {
     const [{ status, data, error }, setCallToolState] = useState({ status: "idle", data: undefined, error: undefined });
     const callIdRef = useRef(0);

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

@@ -1 +1 @@
-{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAGL,UAAU,GACX,MAAM,qBAAqB,CAAC;AA2F7B,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IAGF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAE7B,MAAM,OAAO,GAAG,KAAK,EACnB,QAAkB,EACiB,EAAE;QACrC,MAAM,MAAM,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;QACnC,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAE3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CACjC,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,IAAI,MAAM,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;gBACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAClE,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;gBACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAChE,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAC,QAAmB,EAAE,EAAE;QAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,CAAwD,CAAC;IAE1D,MAAM,QAAQ,GAAG,CAAC,CAChB,QAAqE,EACrE,WAA6D,EAC7D,EAAE;QACF,IAAI,QAAkB,CAAC;QACvB,IACE,QAAQ;YACR,OAAO,QAAQ,KAAK,QAAQ;YAC5B,CAAC,WAAW,IAAI,QAAQ;gBACtB,SAAS,IAAI,QAAQ;gBACrB,WAAW,IAAI,QAAQ,CAAC,EAC1B,CAAC;YACD,QAAQ,GAAG,IAAgB,CAAC,CAAC,uBAAuB;YACpD,WAAW,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QACpE,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC;aACd,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACzC,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,WAAW,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACxC,WAAW,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC,CAAmD,CAAC;IAErD,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACe,CAAC;IAE7C,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { useRef, useState } from \"react\";\n\nimport {\n  type CallToolArgs,\n  type CallToolResponse,\n  getAdaptor,\n} from \"../bridges/index.js\";\nimport type { HasRequiredKeys } from \"../types.js\";\n\ntype CallToolIdleState = {\n  status: \"idle\";\n  isIdle: true;\n  isPending: false;\n  isSuccess: false;\n  isError: false;\n  data: undefined;\n  error: undefined;\n};\n\ntype CallToolPendingState = {\n  status: \"pending\";\n  isIdle: false;\n  isPending: true;\n  isSuccess: false;\n  isError: false;\n  data: undefined;\n  error: undefined;\n};\n\ntype CallToolSuccessState<TData extends CallToolResponse = CallToolResponse> = {\n  status: \"success\";\n  isIdle: false;\n  isPending: false;\n  isSuccess: true;\n  isError: false;\n  data: TData;\n  error: undefined;\n};\n\ntype CallToolErrorState = {\n  status: \"error\";\n  isIdle: false;\n  isPending: false;\n  isSuccess: false;\n  isError: true;\n  data: undefined;\n  error: unknown;\n};\n\nexport type CallToolState<TData extends CallToolResponse = CallToolResponse> =\n  | CallToolIdleState\n  | CallToolPendingState\n  | CallToolSuccessState<TData>\n  | CallToolErrorState;\n\nexport type SideEffects<ToolArgs, ToolResponse> = {\n  onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;\n  onError?: (error: unknown, toolArgs: ToolArgs) => void;\n  onSettled?: (\n    data: ToolResponse | undefined,\n    error: unknown | undefined,\n    toolArgs: ToolArgs,\n  ) => void;\n};\n\ntype IsArgsOptional<T> = [T] extends [null]\n  ? true\n  : HasRequiredKeys<T> extends false\n    ? true\n    : false;\n\nexport type CallToolFn<TArgs, TResponse> =\n  IsArgsOptional<TArgs> extends true\n    ? {\n        (): void;\n        (sideEffects: SideEffects<TArgs, TResponse>): void;\n        (args: TArgs): void;\n        (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;\n      }\n    : {\n        (args: TArgs): void;\n        (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;\n      };\n\nexport type CallToolAsyncFn<TArgs, TResponse> =\n  IsArgsOptional<TArgs> extends true\n    ? {\n        (): Promise<TResponse>;\n        (args: TArgs): Promise<TResponse>;\n      }\n    : (args: TArgs) => Promise<TResponse>;\n\ntype ToolResponseSignature = Pick<\n  CallToolResponse,\n  \"structuredContent\" | \"meta\"\n>;\n\nexport const useCallTool = <\n  ToolArgs extends CallToolArgs = null,\n  ToolResponse extends Partial<ToolResponseSignature> = Record<string, never>,\n>(\n  name: string,\n) => {\n  type CombinedCallToolResponse = CallToolResponse & ToolResponse;\n\n  const [{ status, data, error }, setCallToolState] = useState<\n    Omit<\n      CallToolState<CombinedCallToolResponse>,\n      \"isIdle\" | \"isPending\" | \"isSuccess\" | \"isError\"\n    >\n  >({ status: \"idle\", data: undefined, error: undefined });\n\n  const callIdRef = useRef(0);\n  const adaptor = getAdaptor();\n\n  const execute = async (\n    toolArgs: ToolArgs,\n  ): Promise<CombinedCallToolResponse> => {\n    const callId = ++callIdRef.current;\n    setCallToolState({ status: \"pending\", data: undefined, error: undefined });\n\n    try {\n      const data = await adaptor.callTool<ToolArgs, CombinedCallToolResponse>(\n        name,\n        toolArgs,\n      );\n      if (callId === callIdRef.current) {\n        setCallToolState({ status: \"success\", data, error: undefined });\n      }\n\n      return data;\n    } catch (error) {\n      if (callId === callIdRef.current) {\n        setCallToolState({ status: \"error\", data: undefined, error });\n      }\n      throw error;\n    }\n  };\n\n  const callToolAsync = ((toolArgs?: ToolArgs) => {\n    if (toolArgs === undefined) {\n      return execute(null as ToolArgs);\n    }\n    return execute(toolArgs);\n  }) as CallToolAsyncFn<ToolArgs, CombinedCallToolResponse>;\n\n  const callTool = ((\n    firstArg?: ToolArgs | SideEffects<ToolArgs, CombinedCallToolResponse>,\n    sideEffects?: SideEffects<ToolArgs, CombinedCallToolResponse>,\n  ) => {\n    let toolArgs: ToolArgs;\n    if (\n      firstArg &&\n      typeof firstArg === \"object\" &&\n      (\"onSuccess\" in firstArg ||\n        \"onError\" in firstArg ||\n        \"onSettled\" in firstArg)\n    ) {\n      toolArgs = null as ToolArgs; // no toolArgs provided\n      sideEffects = firstArg;\n    } else {\n      toolArgs = (firstArg === undefined ? null : firstArg) as ToolArgs;\n    }\n\n    execute(toolArgs)\n      .then((data) => {\n        sideEffects?.onSuccess?.(data, toolArgs);\n        sideEffects?.onSettled?.(data, undefined, toolArgs);\n      })\n      .catch((error) => {\n        sideEffects?.onError?.(error, toolArgs);\n        sideEffects?.onSettled?.(undefined, error, toolArgs);\n      });\n  }) as CallToolFn<ToolArgs, CombinedCallToolResponse>;\n\n  const callToolState = {\n    status,\n    data,\n    error,\n    isIdle: status === \"idle\",\n    isPending: status === \"pending\",\n    isSuccess: status === \"success\",\n    isError: status === \"error\",\n  } as CallToolState<CombinedCallToolResponse>;\n\n  return {\n    ...callToolState,\n    callTool,\n    callToolAsync,\n  };\n};\n"]}
+{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAGL,UAAU,GACX,MAAM,qBAAqB,CAAC;AA4G7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,EAAE;IAGF,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAK1D,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAEzD,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAE7B,MAAM,OAAO,GAAG,KAAK,EACnB,QAAkB,EACiB,EAAE;QACrC,MAAM,MAAM,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;QACnC,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAE3E,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CACjC,IAAI,EACJ,QAAQ,CACT,CAAC;YACF,IAAI,MAAM,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;gBACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAClE,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;gBACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAChE,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAC,QAAmB,EAAE,EAAE;QAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,CAAwD,CAAC;IAE1D,MAAM,QAAQ,GAAG,CAAC,CAChB,QAAqE,EACrE,WAA6D,EAC7D,EAAE;QACF,IAAI,QAAkB,CAAC;QACvB,IACE,QAAQ;YACR,OAAO,QAAQ,KAAK,QAAQ;YAC5B,CAAC,WAAW,IAAI,QAAQ;gBACtB,SAAS,IAAI,QAAQ;gBACrB,WAAW,IAAI,QAAQ,CAAC,EAC1B,CAAC;YACD,QAAQ,GAAG,IAAgB,CAAC,CAAC,uBAAuB;YACpD,WAAW,GAAG,QAAQ,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QACpE,CAAC;QAED,OAAO,CAAC,QAAQ,CAAC;aACd,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACzC,WAAW,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,WAAW,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACxC,WAAW,EAAE,SAAS,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC,CAAmD,CAAC;IAErD,MAAM,aAAa,GAAG;QACpB,MAAM;QACN,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,SAAS,EAAE,MAAM,KAAK,SAAS;QAC/B,OAAO,EAAE,MAAM,KAAK,OAAO;KACe,CAAC;IAE7C,OAAO;QACL,GAAG,aAAa;QAChB,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { useRef, useState } from \"react\";\n\nimport {\n  type CallToolArgs,\n  type CallToolResponse,\n  getAdaptor,\n} from \"../bridges/index.js\";\nimport type { HasRequiredKeys } from \"../types.js\";\n\ntype CallToolIdleState = {\n  status: \"idle\";\n  isIdle: true;\n  isPending: false;\n  isSuccess: false;\n  isError: false;\n  data: undefined;\n  error: undefined;\n};\n\ntype CallToolPendingState = {\n  status: \"pending\";\n  isIdle: false;\n  isPending: true;\n  isSuccess: false;\n  isError: false;\n  data: undefined;\n  error: undefined;\n};\n\ntype CallToolSuccessState<TData extends CallToolResponse = CallToolResponse> = {\n  status: \"success\";\n  isIdle: false;\n  isPending: false;\n  isSuccess: true;\n  isError: false;\n  data: TData;\n  error: undefined;\n};\n\ntype CallToolErrorState = {\n  status: \"error\";\n  isIdle: false;\n  isPending: false;\n  isSuccess: false;\n  isError: true;\n  data: undefined;\n  error: unknown;\n};\n\n/**\n * State of a {@link useCallTool} invocation, discriminated by `status`.\n * Use `isIdle` / `isPending` / `isSuccess` / `isError` for ergonomic conditional rendering.\n */\nexport type CallToolState<TData extends CallToolResponse = CallToolResponse> =\n  | CallToolIdleState\n  | CallToolPendingState\n  | CallToolSuccessState<TData>\n  | CallToolErrorState;\n\n/**\n * Optional callbacks fired around a {@link useCallTool} call.\n * `onSettled` runs after success or error.\n */\nexport type SideEffects<ToolArgs, ToolResponse> = {\n  onSuccess?: (data: ToolResponse, toolArgs: ToolArgs) => void;\n  onError?: (error: unknown, toolArgs: ToolArgs) => void;\n  onSettled?: (\n    data: ToolResponse | undefined,\n    error: unknown | undefined,\n    toolArgs: ToolArgs,\n  ) => void;\n};\n\ntype IsArgsOptional<T> = [T] extends [null]\n  ? true\n  : HasRequiredKeys<T> extends false\n    ? true\n    : false;\n\n/**\n * Fire-and-forget call function returned by {@link useCallTool}. Tracks state\n * on the hook and supports optional {@link SideEffects} callbacks. Args are\n * optional when the tool accepts none.\n */\nexport type CallToolFn<TArgs, TResponse> =\n  IsArgsOptional<TArgs> extends true\n    ? {\n        (): void;\n        (sideEffects: SideEffects<TArgs, TResponse>): void;\n        (args: TArgs): void;\n        (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;\n      }\n    : {\n        (args: TArgs): void;\n        (args: TArgs, sideEffects: SideEffects<TArgs, TResponse>): void;\n      };\n\n/**\n * Promise-returning call function returned by {@link useCallTool}. Rejects\n * if the tool errors; use `try/catch` for error handling.\n */\nexport type CallToolAsyncFn<TArgs, TResponse> =\n  IsArgsOptional<TArgs> extends true\n    ? {\n        (): Promise<TResponse>;\n        (args: TArgs): Promise<TResponse>;\n      }\n    : (args: TArgs) => Promise<TResponse>;\n\ntype ToolResponseSignature = Pick<\n  CallToolResponse,\n  \"structuredContent\" | \"meta\"\n>;\n\n/**\n * Call a server tool from a view and track its execution state.\n *\n * Returns the current {@link CallToolState} plus two callers: `callTool`\n * (fire-and-forget, with optional {@link SideEffects}) and `callToolAsync`\n * (promise-returning). If the same instance is invoked again while a call is\n * in flight, the older response is dropped from the rendered state (but any\n * `onSuccess` / `onError` / `onSettled` callbacks attached to it still fire).\n *\n * Pair with {@link useToolInfo} to read the result of the tool invocation\n * that produced the current view. For end-to-end type safety across tool\n * inputs and outputs, prefer the typed helpers produced by {@link generateHelpers}\n * over calling this hook directly.\n *\n * @typeParam ToolArgs - Shape of the tool's input args (`null` for no-arg tools).\n * @typeParam ToolResponse - Shape of the tool's `structuredContent` / `meta`.\n *\n * @example\n * ```tsx\n * const { callTool, isPending, data } = useCallTool<{ query: string }>(\"search\");\n *\n * <button onClick={() => callTool({ query: \"skybridge\" }, {\n *   onSuccess: (res) => console.log(res.structuredContent),\n * })} />\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-call-tool\n */\nexport const useCallTool = <\n  ToolArgs extends CallToolArgs = null,\n  ToolResponse extends Partial<ToolResponseSignature> = Record<string, never>,\n>(\n  name: string,\n) => {\n  type CombinedCallToolResponse = CallToolResponse & ToolResponse;\n\n  const [{ status, data, error }, setCallToolState] = useState<\n    Omit<\n      CallToolState<CombinedCallToolResponse>,\n      \"isIdle\" | \"isPending\" | \"isSuccess\" | \"isError\"\n    >\n  >({ status: \"idle\", data: undefined, error: undefined });\n\n  const callIdRef = useRef(0);\n  const adaptor = getAdaptor();\n\n  const execute = async (\n    toolArgs: ToolArgs,\n  ): Promise<CombinedCallToolResponse> => {\n    const callId = ++callIdRef.current;\n    setCallToolState({ status: \"pending\", data: undefined, error: undefined });\n\n    try {\n      const data = await adaptor.callTool<ToolArgs, CombinedCallToolResponse>(\n        name,\n        toolArgs,\n      );\n      if (callId === callIdRef.current) {\n        setCallToolState({ status: \"success\", data, error: undefined });\n      }\n\n      return data;\n    } catch (error) {\n      if (callId === callIdRef.current) {\n        setCallToolState({ status: \"error\", data: undefined, error });\n      }\n      throw error;\n    }\n  };\n\n  const callToolAsync = ((toolArgs?: ToolArgs) => {\n    if (toolArgs === undefined) {\n      return execute(null as ToolArgs);\n    }\n    return execute(toolArgs);\n  }) as CallToolAsyncFn<ToolArgs, CombinedCallToolResponse>;\n\n  const callTool = ((\n    firstArg?: ToolArgs | SideEffects<ToolArgs, CombinedCallToolResponse>,\n    sideEffects?: SideEffects<ToolArgs, CombinedCallToolResponse>,\n  ) => {\n    let toolArgs: ToolArgs;\n    if (\n      firstArg &&\n      typeof firstArg === \"object\" &&\n      (\"onSuccess\" in firstArg ||\n        \"onError\" in firstArg ||\n        \"onSettled\" in firstArg)\n    ) {\n      toolArgs = null as ToolArgs; // no toolArgs provided\n      sideEffects = firstArg;\n    } else {\n      toolArgs = (firstArg === undefined ? null : firstArg) as ToolArgs;\n    }\n\n    execute(toolArgs)\n      .then((data) => {\n        sideEffects?.onSuccess?.(data, toolArgs);\n        sideEffects?.onSettled?.(data, undefined, toolArgs);\n      })\n      .catch((error) => {\n        sideEffects?.onError?.(error, toolArgs);\n        sideEffects?.onSettled?.(undefined, error, toolArgs);\n      });\n  }) as CallToolFn<ToolArgs, CombinedCallToolResponse>;\n\n  const callToolState = {\n    status,\n    data,\n    error,\n    isIdle: status === \"idle\",\n    isPending: status === \"pending\",\n    isSuccess: status === \"success\",\n    isError: status === \"error\",\n  } as CallToolState<CombinedCallToolResponse>;\n\n  return {\n    ...callToolState,\n    callTool,\n    callToolAsync,\n  };\n};\n"]}

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

@@ -20,8 +20,27 @@ describe("useCallTool - onSuccess callback", () => {
         content: [{ type: "text", text: "test result" }],
         structuredContent: { result: "test" },
         isError: false,
+        meta: {},
     };
     const error = new Error("test error");
+    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" },
+        };
+        OpenaiMock.callTool.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 window.openai.callTool with correct arguments", async () => {
         const { result } = renderHook(() => useCallTool(toolName));
         await act(async () => {
@@ -101,8 +120,14 @@ describe("useCallTool - onSuccess callback", () => {
     });
     it("should always return last call started state", async () => {
         const { result } = renderHook(() => useCallTool(toolName));
-        const firstCallData = { ...data, result: "first call result" };
-        const secondCallData = { ...data, result: "second call result" };
+        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();
         OpenaiMock.callTool

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

@@ -1 +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;AAGhB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,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;KACf,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAEtC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,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,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,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,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC;QAC/D,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;QACjE,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,UAAU,CAAC,QAAQ;aAChB,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;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEhD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACpE,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,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\";\n\nimport type { CallToolResponse } from \"../bridges/types.js\";\nimport { useCallTool } from \"./use-call-tool.js\";\n\ndescribe(\"useCallTool - onSuccess callback\", () => {\n  let OpenaiMock: { callTool: Mock };\n\n  beforeEach(() => {\n    OpenaiMock = {\n      callTool: vi.fn(),\n    };\n    vi.stubGlobal(\"openai\", OpenaiMock);\n    vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\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  };\n  const error = new Error(\"test error\");\n\n  it(\"should call window.openai.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(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);\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    OpenaiMock.callTool.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    OpenaiMock.callTool.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    OpenaiMock.callTool.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    OpenaiMock.callTool.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 = { ...data, result: \"first call result\" };\n    const secondCallData = { ...data, result: \"second call result\" };\n    const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } =\n      Promise.withResolvers();\n    const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } =\n      Promise.withResolvers();\n    OpenaiMock.callTool\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\ndescribe(\"useCallTool - TypeScript typing\", () => {\n  let OpenaiMock: { callTool: Mock };\n\n  beforeEach(() => {\n    OpenaiMock = {\n      callTool: vi.fn(),\n    };\n    vi.stubGlobal(\"openai\", OpenaiMock);\n    vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\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    OpenaiMock.callTool.mockResolvedValueOnce(data);\n\n    await act(async () => {\n      result.current.callTool();\n    });\n\n    expect(OpenaiMock.callTool).toHaveBeenCalledWith(\"test-tool\", null);\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    OpenaiMock.callTool.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    OpenaiMock.callTool.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"]}
+{"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;AAGhB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,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,KAAK,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE;SAC5C,CAAC;QACF,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC1D,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,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,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,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAChD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACjD,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,UAAU,CAAC,QAAQ;aAChB,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;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,UAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEhD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACpE,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,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,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAExD,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\";\n\nimport type { CallToolResponse } from \"../bridges/types.js\";\nimport { useCallTool } from \"./use-call-tool.js\";\n\ndescribe(\"useCallTool - onSuccess callback\", () => {\n  let OpenaiMock: { callTool: Mock };\n\n  beforeEach(() => {\n    OpenaiMock = {\n      callTool: vi.fn(),\n    };\n    vi.stubGlobal(\"openai\", OpenaiMock);\n    vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\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    OpenaiMock.callTool.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 window.openai.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(OpenaiMock.callTool).toHaveBeenCalledWith(toolName, args);\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    OpenaiMock.callTool.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    OpenaiMock.callTool.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    OpenaiMock.callTool.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    OpenaiMock.callTool.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    OpenaiMock.callTool\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\ndescribe(\"useCallTool - TypeScript typing\", () => {\n  let OpenaiMock: { callTool: Mock };\n\n  beforeEach(() => {\n    OpenaiMock = {\n      callTool: vi.fn(),\n    };\n    vi.stubGlobal(\"openai\", OpenaiMock);\n    vi.stubGlobal(\"skybridge\", { hostType: \"apps-sdk\" });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n    vi.resetAllMocks();\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    OpenaiMock.callTool.mockResolvedValueOnce(data);\n\n    await act(async () => {\n      result.current.callTool();\n    });\n\n    expect(OpenaiMock.callTool).toHaveBeenCalledWith(\"test-tool\", null);\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    OpenaiMock.callTool.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    OpenaiMock.callTool.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-display-mode.d.ts

@@ -1,4 +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 useLayout}.
+ *
+ * @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

@@ -1,5 +1,25 @@
 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 useLayout}.
+ *
+ * @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();