skybridge 0.0.0-dev.8c3e153 → 0.0.0-dev.8c5d380

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

@@ -0,0 +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;AA4G7B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;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` callbacks attached to it still fire).\n *\n * For end-to-end type safety across tool inputs and outputs, prefer the typed\n * helpers produced by {@link generateHelpers} 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-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-call-tool.test-d.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE5C,OAAO,EAGL,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAE5B,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACrE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IACnE,QAAQ,EAAE,CAAC;IACX,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAClC,aAAa,EAAE,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IAExE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,WAAW,CAAO,WAAW,CAAC,CAAC;IAEnE,uCAAuC;IACvC,QAAQ,EAAE,CAAC;IAEX,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAErD,uCAAuC;IACvC,aAAa,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;IAI5D,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CACN,EAAE,EAAE,EAAE,CAAC,EAAE,EACT;QACE,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;QACD,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,IAAI,IAAI,EAAE,CAAC;gBACT,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;YAC3D,CAAC;YACD,YAAY,CAAC,KAAK,CAAC,CAAC,aAAa,EAAuB,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACrC,CAAC;KACF,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gEAAgE,EAAE,GAAG,EAAE;IAE1E,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAE9D,QAAQ,CAAC;QACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAClB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1D,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IAOzD,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAEhD,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IACnE,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;IAEvD,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAQ,CAAC;QAClD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAQ,CAAC;QACrD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,aAAa,EAAa,CAAC;QACzD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAC9B,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAQ,CAAC;QACnD,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;IAE9D,MAAM,MAAM,GAAG,WAAW,CAAiB,WAAW,CAAC,CAAC;IAExD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAU,CAAC;IACtD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;IACzD,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAa,CAAC;QACvD,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAW,CAAC;IACvD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;IAI/D,MAAM,KAAK,GAAY,EAAa,CAAC;IAErC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAI7D,MAAM,WAAW,GAAgC;QAC/C,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YACpD,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACpC,CAAC;KACF,CAAC;IAEF,YAAY,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC","sourcesContent":["import { expectTypeOf, test } from \"vitest\";\nimport type { CallToolResponse } from \"../bridges/types.js\";\nimport {\n  type CallToolState,\n  type SideEffects,\n  useCallTool,\n} from \"./use-call-tool.js\";\n\ntest(\"callTool can be called without args when ToolArgs is null\", () => {\n  const { callTool, callToolAsync } = useCallTool<null>(\"test-tool\");\n  callTool();\n  callTool({ onSuccess: () => {} });\n  callToolAsync();\n});\n\ntest(\"callTool requires args when ToolArgs has required properties\", () => {\n  type Args = { query: string };\n  const { callTool, callToolAsync } = useCallTool<Args>(\"test-tool\");\n\n  // @ts-expect-error - query is required\n  callTool();\n\n  callTool({ query: \"test\" });\n  callTool({ query: \"test\" }, { onSuccess: () => {} });\n\n  // @ts-expect-error - query is required\n  callToolAsync();\n  callToolAsync({ query: \"test\" });\n});\n\ntest(\"callTool supports sideEffects with correct types\", () => {\n  type Args = { id: number };\n  type Response = { structuredContent: { result: string } };\n\n  const { callTool } = useCallTool<Args, Response>(\"test-tool\");\n\n  callTool(\n    { id: 1 },\n    {\n      onSuccess: (data, args) => {\n        expectTypeOf(data.structuredContent.result).toBeString();\n        expectTypeOf(args.id).toBeNumber();\n      },\n      onError: (error, args) => {\n        expectTypeOf(error).toBeUnknown();\n        expectTypeOf(args.id).toBeNumber();\n      },\n      onSettled: (data, error, args) => {\n        if (data) {\n          expectTypeOf(data.structuredContent.result).toBeString();\n        }\n        expectTypeOf(error).toEqualTypeOf<unknown | undefined>();\n        expectTypeOf(args.id).toBeNumber();\n      },\n    },\n  );\n});\n\ntest(\"callTool allows sideEffects as first arg when ToolArgs is null\", () => {\n  type Response = { structuredContent: { value: number } };\n  const { callTool } = useCallTool<null, Response>(\"test-tool\");\n\n  callTool({\n    onSuccess: (data) => {\n      expectTypeOf(data.structuredContent.value).toBeNumber();\n    },\n  });\n});\n\ntest(\"callToolAsync returns correctly typed promise\", () => {\n  type Args = { name: string };\n  type Response = {\n    structuredContent: { greeting: string };\n    meta: { id: number };\n  };\n\n  const { callToolAsync } = useCallTool<Args, Response>(\"test-tool\");\n\n  const promise = callToolAsync({ name: \"test\" });\n\n  expectTypeOf(promise).resolves.toHaveProperty(\"structuredContent\");\n  expectTypeOf(promise).resolves.toHaveProperty(\"meta\");\n});\n\ntest(\"state narrowing works correctly with status\", () => {\n  type Response = { structuredContent: { data: string } };\n  const result = useCallTool<null, Response>(\"test-tool\");\n\n  if (result.status === \"idle\") {\n    expectTypeOf(result.isIdle).toEqualTypeOf<true>();\n    expectTypeOf(result.data).toEqualTypeOf<undefined>();\n  }\n\n  if (result.status === \"pending\") {\n    expectTypeOf(result.isPending).toEqualTypeOf<true>();\n    expectTypeOf(result.data).toEqualTypeOf<undefined>();\n  }\n\n  if (result.status === \"success\") {\n    expectTypeOf(result.isSuccess).toEqualTypeOf<true>();\n    expectTypeOf(result.data).not.toEqualTypeOf<undefined>();\n    expectTypeOf(result.data.structuredContent.data).toBeString();\n  }\n\n  if (result.status === \"error\") {\n    expectTypeOf(result.isError).toEqualTypeOf<true>();\n    expectTypeOf(result.error).toBeUnknown();\n  }\n});\n\ntest(\"state narrowing works correctly with boolean flags\", () => {\n  type Response = { structuredContent: { items: string[] } };\n  const result = useCallTool<null, Response>(\"test-tool\");\n\n  if (result.isIdle) {\n    expectTypeOf(result.status).toEqualTypeOf<\"idle\">();\n  }\n\n  if (result.isPending) {\n    expectTypeOf(result.status).toEqualTypeOf<\"pending\">();\n  }\n\n  if (result.isSuccess) {\n    expectTypeOf(result.status).toEqualTypeOf<\"success\">();\n    expectTypeOf(result.data.structuredContent.items).toBeArray();\n  }\n\n  if (result.isError) {\n    expectTypeOf(result.status).toEqualTypeOf<\"error\">();\n  }\n});\n\ntest(\"CallToolState type is correctly exported and usable\", () => {\n  type Response = { structuredContent: { foo: string } };\n  type MyState = CallToolState<CallToolResponse & Response>;\n\n  const state: MyState = {} as MyState;\n\n  if (state.status === \"success\") {\n    expectTypeOf(state.data.structuredContent.foo).toBeString();\n  }\n});\n\ntest(\"SideEffects type is correctly exported and usable\", () => {\n  type Args = { x: number };\n  type Response = CallToolResponse & { structuredContent: { y: string } };\n\n  const sideEffects: SideEffects<Args, Response> = {\n    onSuccess: (data, args) => {\n      expectTypeOf(data.structuredContent.y).toBeString();\n      expectTypeOf(args.x).toBeNumber();\n    },\n  };\n\n  expectTypeOf(sideEffects).toHaveProperty(\"onSuccess\");\n});\n"]}

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

@@ -8,6 +8,7 @@ describe("useCallTool - onSuccess callback", () => {
             callTool: vi.fn(),
         };
         vi.stubGlobal("openai", OpenaiMock);
+        vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
     });
     afterEach(() => {
         vi.unstubAllGlobals();
@@ -19,10 +20,27 @@ describe("useCallTool - onSuccess callback", () => {
         content: [{ type: "text", text: "test result" }],
         structuredContent: { result: "test" },
         isError: false,
-        result: "test result",
         meta: {},
     };
     const error = new Error("test error");
+    it("should 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 () => {
@@ -100,6 +118,35 @@ describe("useCallTool - onSuccess callback", () => {
             expect(onSuccess).not.toHaveBeenCalled();
         });
     });
+    it("should always return last call started state", async () => {
+        const { result } = renderHook(() => useCallTool(toolName));
+        const firstCallData = {
+            ...data,
+            structuredContent: { result: "first call result" },
+        };
+        const secondCallData = {
+            ...data,
+            structuredContent: { result: "second call result" },
+        };
+        const { promise: firstCallToolPromise, resolve: resolveFirstCallTool } = Promise.withResolvers();
+        const { promise: secondCallToolPromise, resolve: resolveSecondCallTool } = Promise.withResolvers();
+        OpenaiMock.callTool
+            .mockImplementationOnce(() => firstCallToolPromise)
+            .mockImplementationOnce(() => secondCallToolPromise);
+        await act(() => {
+            result.current.callTool(args);
+            result.current.callTool(args);
+            resolveFirstCallTool(firstCallData);
+            return firstCallToolPromise;
+        });
+        expect(result.current.status).toEqual("pending");
+        expect(result.current.data).toEqual(undefined);
+        resolveSecondCallTool(secondCallData);
+        await waitFor(() => {
+            expect(result.current.status).toEqual("success");
+            expect(result.current.data).toEqual(secondCallData);
+        });
+    });
 });
 describe("useCallTool - TypeScript typing", () => {
     let OpenaiMock;
@@ -108,6 +155,7 @@ describe("useCallTool - TypeScript typing", () => {
             callTool: vi.fn(),
         };
         vi.stubGlobal("openai", OpenaiMock);
+        vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
     });
     afterEach(() => {
         vi.unstubAllGlobals();
@@ -119,7 +167,6 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "test" }],
             structuredContent: { result: "test" },
             isError: false,
-            result: "test",
             meta: { id: 123 },
         };
         OpenaiMock.callTool.mockResolvedValueOnce(data);
@@ -136,7 +183,6 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "answer" }],
             structuredContent: { answer: "test answer" },
             isError: false,
-            result: "answer",
             meta: {},
         };
         OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
@@ -152,7 +198,7 @@ describe("useCallTool - TypeScript typing", () => {
             content: [{ type: "text", text: "data" }],
             structuredContent: { data: "test data" },
             isError: false,
-            result: "data",
+            meta: {},
         };
         OpenaiMock.callTool.mockResolvedValueOnce(mockResponse);
         const returnedValue = await act(async () => {

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-call-tool.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;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

@@ -0,0 +1,22 @@
+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.
+ *
+ * @example
+ * ```tsx
+ * const [mode, setMode] = useDisplayMode();
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
+ */
+export declare function useDisplayMode(): readonly [import("../index.js").DisplayMode, (mode: RequestDisplayMode) => Promise<{
+    mode: RequestDisplayMode;
+}>];

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

@@ -0,0 +1,27 @@
+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.
+ *
+ * @example
+ * ```tsx
+ * const [mode, setMode] = useDisplayMode();
+ * <button onClick={() => setMode("fullscreen")}>Expand</button>
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-display-mode
+ */
+export function useDisplayMode() {
+    const displayMode = useHostContext("displayMode");
+    const adaptor = getAdaptor();
+    const setDisplayMode = useCallback((mode) => adaptor.requestDisplayMode(mode), [adaptor]);
+    return [displayMode, setDisplayMode];
+}
+//# sourceMappingURL=use-display-mode.js.map

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

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

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

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

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

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

package/dist/{src/web → web}/hooks/use-display-mode.test.js

@@ -9,6 +9,7 @@ describe("useDisplayMode", () => {
             requestDisplayMode: vi.fn().mockResolvedValue({ mode: "inline" }),
         };
         vi.stubGlobal("openai", OpenaiMock);
+        vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
     });
     afterEach(() => {
         vi.unstubAllGlobals();

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-display-mode.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-display-mode.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EAEF,EAAE,GACH,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAI,UAGH,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG;YACX,WAAW,EAAE,QAAQ;YACrB,kBAAkB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SAClE,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,uEAAuE,EAAE,GAAG,EAAE;QAC/E,UAAU,CAAC,WAAW,GAAG,QAAQ,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACtF,UAAU,CAAC,WAAW,GAAG,QAAQ,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEhE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzC,UAAU,CAAC,WAAW,GAAG,YAAY,CAAC;QACtC,QAAQ,EAAE,CAAC;QAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8FAA8F,EAAE,KAAK,IAAI,EAAE;QAC5G,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;QAEtD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC;YACzD,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook } from \"@testing-library/react\";\nimport {\n  afterEach,\n  beforeEach,\n  describe,\n  expect,\n  it,\n  type Mock,\n  vi,\n} from \"vitest\";\nimport type { DisplayMode } from \"../bridges/types.js\";\nimport { useDisplayMode } from \"./use-display-mode.js\";\n\ndescribe(\"useDisplayMode\", () => {\n  let OpenaiMock: {\n    displayMode: DisplayMode;\n    requestDisplayMode: Mock;\n  };\n\n  beforeEach(() => {\n    OpenaiMock = {\n      displayMode: \"inline\",\n      requestDisplayMode: vi.fn().mockResolvedValue({ mode: \"inline\" }),\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 return the current display mode from window.openai.displayMode\", () => {\n    OpenaiMock.displayMode = \"inline\";\n    const { result } = renderHook(() => useDisplayMode());\n\n    expect(result.current[0]).toBe(\"inline\");\n  });\n\n  it(\"should return different display modes when window.openai.displayMode changes\", () => {\n    OpenaiMock.displayMode = \"inline\";\n    const { result, rerender } = renderHook(() => useDisplayMode());\n\n    expect(result.current[0]).toBe(\"inline\");\n\n    OpenaiMock.displayMode = \"fullscreen\";\n    rerender();\n\n    expect(result.current[0]).toBe(\"fullscreen\");\n  });\n\n  it(\"should call window.openai.requestDisplayMode with correct mode when setDisplayMode is called\", async () => {\n    const { result } = renderHook(() => useDisplayMode());\n\n    await act(async () => {\n      await result.current[1](\"fullscreen\");\n    });\n\n    expect(OpenaiMock.requestDisplayMode).toHaveBeenCalledWith({\n      mode: \"fullscreen\",\n    });\n  });\n});\n"]}

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

@@ -0,0 +1,27 @@
+/**
+ * File operations bound to the current host: `upload` a `File`, resolve a
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
+ * native file picker.
+ *
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
+ * picker; it throws if the capability is unavailable. Uploaded files are
+ * returned as metadata you can hand back to a tool (compatible with {@link FileRef}).
+ *
+ * @example
+ * ```tsx
+ * const { upload, selectFiles } = useFiles();
+ * const files = await selectFiles();
+ * const ref = await upload(files[0]);
+ * callTool({ fileId: ref.fileId });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-files
+ */
+export declare function useFiles(): {
+    upload: (file: File, options?: import("../index.js").UploadFileOptions) => Promise<import("../index.js").FileMetadata>;
+    getDownloadUrl: (file: import("../index.js").FileMetadata) => Promise<{
+        downloadUrl: string;
+    }>;
+    selectFiles: () => Promise<import("../index.js").FileMetadata[]>;
+};

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

@@ -0,0 +1,30 @@
+import { getAdaptor } from "../bridges/index.js";
+/**
+ * File operations bound to the current host: `upload` a `File`, resolve a
+ * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's
+ * native file picker.
+ *
+ * Currently Apps-SDK-only — calling any of these from MCP Apps throws.
+ * `selectFiles` additionally requires a ChatGPT host version that exposes the
+ * picker; it throws if the capability is unavailable. Uploaded files are
+ * returned as metadata you can hand back to a tool (compatible with {@link FileRef}).
+ *
+ * @example
+ * ```tsx
+ * const { upload, selectFiles } = useFiles();
+ * const files = await selectFiles();
+ * const ref = await upload(files[0]);
+ * callTool({ fileId: ref.fileId });
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-files
+ */
+export function useFiles() {
+    const adaptor = getAdaptor();
+    return {
+        upload: adaptor.uploadFile,
+        getDownloadUrl: adaptor.getFileDownloadUrl,
+        selectFiles: adaptor.selectFiles,
+    };
+}
+//# sourceMappingURL=use-files.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-files.js","sourceRoot":"","sources":["../../../src/web/hooks/use-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,UAAU;QAC1B,cAAc,EAAE,OAAO,CAAC,kBAAkB;QAC1C,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;AACJ,CAAC","sourcesContent":["import { getAdaptor } from \"../bridges/index.js\";\n\n/**\n * File operations bound to the current host: `upload` a `File`, resolve a\n * `downloadUrl` for an uploaded file, and `selectFiles` to open the host's\n * native file picker.\n *\n * Currently Apps-SDK-only — calling any of these from MCP Apps throws.\n * `selectFiles` additionally requires a ChatGPT host version that exposes the\n * picker; it throws if the capability is unavailable. Uploaded files are\n * returned as metadata you can hand back to a tool (compatible with {@link FileRef}).\n *\n * @example\n * ```tsx\n * const { upload, selectFiles } = useFiles();\n * const files = await selectFiles();\n * const ref = await upload(files[0]);\n * callTool({ fileId: ref.fileId });\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-files\n */\nexport function useFiles() {\n  const adaptor = getAdaptor();\n  return {\n    upload: adaptor.uploadFile,\n    getDownloadUrl: adaptor.getFileDownloadUrl,\n    selectFiles: adaptor.selectFiles,\n  };\n}\n"]}

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

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

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

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

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

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

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

@@ -0,0 +1,24 @@
+import { type SafeArea, type Theme } from "../bridges/index.js";
+export type LayoutState = {
+    theme: Theme;
+    maxHeight: number | undefined;
+    safeArea: SafeArea;
+};
+/**
+ * Hook for accessing layout and visual environment information.
+ * These values may change on resize or theme toggle.
+ *
+ * @example
+ * ```tsx
+ * const { theme, maxHeight, safeArea } = useLayout();
+ *
+ * // Apply theme-aware styling
+ * const backgroundColor = theme === "dark" ? "#1a1a1a" : "#ffffff";
+ *
+ * // Respect safe area insets
+ * const paddingTop = safeArea.insets.top;
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-layout
+ */
+export declare function useLayout(): LayoutState;

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

@@ -0,0 +1,25 @@
+import { useHostContext } from "../bridges/index.js";
+/**
+ * Hook for accessing layout and visual environment information.
+ * These values may change on resize or theme toggle.
+ *
+ * @example
+ * ```tsx
+ * const { theme, maxHeight, safeArea } = useLayout();
+ *
+ * // Apply theme-aware styling
+ * const backgroundColor = theme === "dark" ? "#1a1a1a" : "#ffffff";
+ *
+ * // Respect safe area insets
+ * const paddingTop = safeArea.insets.top;
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-layout
+ */
+export function useLayout() {
+    const theme = useHostContext("theme");
+    const maxHeight = useHostContext("maxHeight");
+    const safeArea = useHostContext("safeArea");
+    return { theme, maxHeight, safeArea };
+}
+//# sourceMappingURL=use-layout.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-layout.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAQhF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAE5C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACxC,CAAC","sourcesContent":["import { type SafeArea, type Theme, useHostContext } from \"../bridges/index.js\";\n\nexport type LayoutState = {\n  theme: Theme;\n  maxHeight: number | undefined;\n  safeArea: SafeArea;\n};\n\n/**\n * Hook for accessing layout and visual environment information.\n * These values may change on resize or theme toggle.\n *\n * @example\n * ```tsx\n * const { theme, maxHeight, safeArea } = useLayout();\n *\n * // Apply theme-aware styling\n * const backgroundColor = theme === \"dark\" ? \"#1a1a1a\" : \"#ffffff\";\n *\n * // Respect safe area insets\n * const paddingTop = safeArea.insets.top;\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/use-layout\n */\nexport function useLayout(): LayoutState {\n  const theme = useHostContext(\"theme\");\n  const maxHeight = useHostContext(\"maxHeight\");\n  const safeArea = useHostContext(\"safeArea\");\n\n  return { theme, maxHeight, safeArea };\n}\n"]}

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

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

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

@@ -0,0 +1,96 @@
+import { renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { McpAppAdaptor } from "../bridges/mcp-app/adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/bridge.js";
+import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
+import { useLayout } from "./use-layout.js";
+describe("useLayout", () => {
+    describe("apps-sdk host type", () => {
+        let OpenaiMock;
+        beforeEach(() => {
+            OpenaiMock = {
+                theme: "light",
+                maxHeight: 500,
+                safeArea: { insets: { top: 0, bottom: 0, left: 0, right: 0 } },
+            };
+            vi.stubGlobal("openai", OpenaiMock);
+            vi.stubGlobal("skybridge", { hostType: "apps-sdk" });
+        });
+        afterEach(() => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+        });
+        it("should return theme, maxHeight, and safeArea from window.openai", () => {
+            const { result } = renderHook(() => useLayout());
+            expect(result.current.theme).toBe("light");
+            expect(result.current.maxHeight).toBe(500);
+            expect(result.current.safeArea).toEqual({
+                insets: { top: 0, bottom: 0, left: 0, right: 0 },
+            });
+        });
+        it("should return dark theme when set to dark", () => {
+            OpenaiMock.theme = "dark";
+            const { result } = renderHook(() => useLayout());
+            expect(result.current.theme).toBe("dark");
+        });
+        it("should return different maxHeight when set", () => {
+            OpenaiMock.maxHeight = 800;
+            const { result } = renderHook(() => useLayout());
+            expect(result.current.maxHeight).toBe(800);
+        });
+        it("should return safeArea with insets when set", () => {
+            OpenaiMock.safeArea = {
+                insets: { top: 44, bottom: 34, left: 0, right: 0 },
+            };
+            const { result } = renderHook(() => useLayout());
+            expect(result.current.safeArea.insets.top).toBe(44);
+            expect(result.current.safeArea.insets.bottom).toBe(34);
+        });
+    });
+    describe("mcp-app host type", () => {
+        beforeEach(() => {
+            vi.stubGlobal("skybridge", { hostType: "mcp-app" });
+            vi.stubGlobal("ResizeObserver", MockResizeObserver);
+        });
+        afterEach(async () => {
+            vi.unstubAllGlobals();
+            vi.resetAllMocks();
+            McpAppBridge.resetInstance();
+            McpAppAdaptor.resetInstance();
+        });
+        it("should return theme, maxHeight, and safeArea from mcp host context", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    theme: "dark",
+                    containerDimensions: { maxHeight: 800, width: 400 },
+                    safeAreaInsets: { top: 20, right: 0, bottom: 34, left: 0 },
+                }),
+            });
+            const { result } = renderHook(() => useLayout());
+            await waitFor(() => {
+                expect(result.current.theme).toBe("dark");
+                expect(result.current.maxHeight).toBe(800);
+                expect(result.current.safeArea).toEqual({
+                    insets: { top: 20, right: 0, bottom: 34, left: 0 },
+                });
+            });
+        });
+        it("should maintain safeArea referential stability when data has not changed", async () => {
+            vi.stubGlobal("parent", {
+                postMessage: getMcpAppHostPostMessageMock({
+                    theme: "light",
+                    containerDimensions: { maxHeight: 500, width: 400 },
+                    safeAreaInsets: { top: 44, right: 0, bottom: 34, left: 0 },
+                }),
+            });
+            const { result, rerender } = renderHook(() => useLayout());
+            await waitFor(() => {
+                expect(result.current.safeArea).toBeDefined();
+            });
+            const initialSafeArea = result.current.safeArea;
+            rerender();
+            expect(result.current.safeArea).toBe(initialSafeArea);
+        });
+    });
+});
+//# sourceMappingURL=use-layout.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-layout.test.js","sourceRoot":"","sources":["../../../src/web/hooks/use-layout.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,UAIH,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACd,UAAU,GAAG;gBACX,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,GAAG;gBACd,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;aAC/D,CAAC;YACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;gBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACjD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC;YAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC;YAC3B,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,UAAU,CAAC,QAAQ,GAAG;gBACpB,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;aACnD,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,EAAE,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,aAAa,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,MAAM;oBACb,mBAAmB,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;oBACnD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAEjD,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;oBACtC,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBACnD,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACtB,WAAW,EAAE,4BAA4B,CAAC;oBACxC,KAAK,EAAE,OAAO;oBACd,mBAAmB,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;oBACnD,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;iBAC3D,CAAC;aACH,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YAE3D,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;YAEH,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAEhD,QAAQ,EAAE,CAAC;YAEX,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { McpAppAdaptor } from \"../bridges/mcp-app/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/bridge.js\";\nimport type { SafeArea, Theme } from \"../bridges/types.js\";\nimport {\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useLayout } from \"./use-layout.js\";\n\ndescribe(\"useLayout\", () => {\n  describe(\"apps-sdk host type\", () => {\n    let OpenaiMock: {\n      theme: Theme;\n      maxHeight: number;\n      safeArea: SafeArea;\n    };\n\n    beforeEach(() => {\n      OpenaiMock = {\n        theme: \"light\",\n        maxHeight: 500,\n        safeArea: { insets: { top: 0, bottom: 0, left: 0, right: 0 } },\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 return theme, maxHeight, and safeArea from window.openai\", () => {\n      const { result } = renderHook(() => useLayout());\n\n      expect(result.current.theme).toBe(\"light\");\n      expect(result.current.maxHeight).toBe(500);\n      expect(result.current.safeArea).toEqual({\n        insets: { top: 0, bottom: 0, left: 0, right: 0 },\n      });\n    });\n\n    it(\"should return dark theme when set to dark\", () => {\n      OpenaiMock.theme = \"dark\";\n      const { result } = renderHook(() => useLayout());\n\n      expect(result.current.theme).toBe(\"dark\");\n    });\n\n    it(\"should return different maxHeight when set\", () => {\n      OpenaiMock.maxHeight = 800;\n      const { result } = renderHook(() => useLayout());\n\n      expect(result.current.maxHeight).toBe(800);\n    });\n\n    it(\"should return safeArea with insets when set\", () => {\n      OpenaiMock.safeArea = {\n        insets: { top: 44, bottom: 34, left: 0, right: 0 },\n      };\n      const { result } = renderHook(() => useLayout());\n\n      expect(result.current.safeArea.insets.top).toBe(44);\n      expect(result.current.safeArea.insets.bottom).toBe(34);\n    });\n  });\n\n  describe(\"mcp-app host type\", () => {\n    beforeEach(() => {\n      vi.stubGlobal(\"skybridge\", { hostType: \"mcp-app\" });\n      vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    });\n\n    afterEach(async () => {\n      vi.unstubAllGlobals();\n      vi.resetAllMocks();\n      McpAppBridge.resetInstance();\n      McpAppAdaptor.resetInstance();\n    });\n\n    it(\"should return theme, maxHeight, and safeArea from mcp host context\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          theme: \"dark\",\n          containerDimensions: { maxHeight: 800, width: 400 },\n          safeAreaInsets: { top: 20, right: 0, bottom: 34, left: 0 },\n        }),\n      });\n      const { result } = renderHook(() => useLayout());\n\n      await waitFor(() => {\n        expect(result.current.theme).toBe(\"dark\");\n        expect(result.current.maxHeight).toBe(800);\n        expect(result.current.safeArea).toEqual({\n          insets: { top: 20, right: 0, bottom: 34, left: 0 },\n        });\n      });\n    });\n\n    it(\"should maintain safeArea referential stability when data has not changed\", async () => {\n      vi.stubGlobal(\"parent\", {\n        postMessage: getMcpAppHostPostMessageMock({\n          theme: \"light\",\n          containerDimensions: { maxHeight: 500, width: 400 },\n          safeAreaInsets: { top: 44, right: 0, bottom: 34, left: 0 },\n        }),\n      });\n      const { result, rerender } = renderHook(() => useLayout());\n\n      await waitFor(() => {\n        expect(result.current.safeArea).toBeDefined();\n      });\n\n      const initialSafeArea = result.current.safeArea;\n\n      rerender();\n\n      expect(result.current.safeArea).toBe(initialSafeArea);\n    });\n  });\n});\n"]}

package/dist/web/hooks/use-open-external.d.ts

@@ -0,0 +1,20 @@
+import type { OpenExternalOptions } from "../bridges/types.js";
+/** Function that opens a URL outside the view's iframe, returned by {@link useOpenExternal}. */
+export type OpenExternalFn = (href: string, options?: OpenExternalOptions) => void;
+/**
+ * Open an external URL through the host (e.g. in the user's browser).
+ *
+ * Use this instead of `window.open` or anchor `target="_blank"`, which are
+ * unreliable inside a sandboxed iframe. Hosts may transform the URL (e.g.
+ * ChatGPT appends a `?redirectUrl=…` parameter for allowlisted targets — pass
+ * `redirectUrl: false` to suppress it).
+ *
+ * @example
+ * ```tsx
+ * const openExternal = useOpenExternal();
+ * <button onClick={() => openExternal("https://example.com")}>Open docs</button>
+ * ```
+ *
+ * @see https://docs.skybridge.tech/api-reference/use-open-external
+ */
+export declare function useOpenExternal(): OpenExternalFn;