skybridge 0.0.0-dev.febf292 → 0.0.0-dev.fec0253

package/dist/web/helpers/state.js

@@ -1,26 +1,26 @@
 import superjson, {} from "superjson";
 import { getAdaptor } from "../bridges/index.js";
-import { WIDGET_CONTEXT_KEY } from "../data-llm.js";
-export function filterWidgetContext(state) {
+import { VIEW_CONTEXT_KEY } from "../data-llm.js";
+export function filterViewContext(state) {
     if (state === null || state === undefined) {
         return null;
     }
-    const { [WIDGET_CONTEXT_KEY]: _, ...filteredState } = state;
+    const { [VIEW_CONTEXT_KEY]: _, ...filteredState } = state;
     return filteredState;
 }
-export function injectWidgetContext(newState) {
+export function injectViewContext(newState) {
     if (newState === null) {
         return null;
     }
     const currentState = getAdaptor()
-        .getHostContextStore("widgetState")
+        .getHostContextStore("viewState")
         .getSnapshot();
     if (currentState !== null &&
         currentState !== undefined &&
-        WIDGET_CONTEXT_KEY in currentState) {
+        VIEW_CONTEXT_KEY in currentState) {
         return {
             ...newState,
-            [WIDGET_CONTEXT_KEY]: currentState[WIDGET_CONTEXT_KEY],
+            [VIEW_CONTEXT_KEY]: currentState[VIEW_CONTEXT_KEY],
         };
     }
     return newState;
@@ -32,11 +32,11 @@ export function deserializeState(value) {
     return superjson.deserialize(value);
 }
 export function getInitialState(defaultState) {
-    const widgetState = getAdaptor()
-        .getHostContextStore("widgetState")
+    const viewState = getAdaptor()
+        .getHostContextStore("viewState")
         .getSnapshot();
-    if (widgetState !== null && widgetState !== undefined) {
-        return filterWidgetContext(widgetState);
+    if (viewState !== null && viewState !== undefined) {
+        return filterViewContext(viewState);
     }
     return typeof defaultState === "function"
         ? defaultState()

package/dist/web/helpers/state.js.map

@@ -1 +1 @@
-{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../src/web/helpers/state.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAwB,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD,MAAM,UAAU,mBAAmB,CACjC,KAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,KAErD,CAAC;IAEF,OAAO,aAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,QAAkB;IAElB,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,EAAE;SAC9B,mBAAmB,CAAC,aAAa,CAAC;SAClC,WAAW,EAAqD,CAAC;IAEpE,IACE,YAAY,KAAK,IAAI;QACrB,YAAY,KAAK,SAAS;QAC1B,kBAAkB,IAAI,YAAY,EAClC,CAAC;QACD,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,kBAAkB,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;SAClD,CAAC;IACT,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAoB;IACjD,OAAO,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB;AACzE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAsB;IACrD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAoC;IAEpC,MAAM,WAAW,GAAG,UAAU,EAAE;SAC7B,mBAAmB,CAAC,aAAa,CAAC;SAClC,WAAW,EAAkB,CAAC;IAEjC,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,OAAO,YAAY,KAAK,UAAU;QACvC,CAAC,CAAC,YAAY,EAAE;QAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../src/web/helpers/state.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAwB,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGlD,MAAM,UAAU,iBAAiB,CAC/B,KAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,KAEnD,CAAC;IAEF,OAAO,aAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,QAAkB;IAElB,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,EAAE;SAC9B,mBAAmB,CAAC,WAAW,CAAC;SAChC,WAAW,EAAmD,CAAC;IAElE,IACE,YAAY,KAAK,IAAI;QACrB,YAAY,KAAK,SAAS;QAC1B,gBAAgB,IAAI,YAAY,EAChC,CAAC;QACD,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC;SAC9C,CAAC;IACT,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAoB;IACjD,OAAO,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB;AACzE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAsB;IACrD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAoC;IAEpC,MAAM,SAAS,GAAG,UAAU,EAAE;SAC3B,mBAAmB,CAAC,WAAW,CAAC;SAChC,WAAW,EAAkB,CAAC;IAEjC,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAClD,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,OAAO,YAAY,KAAK,UAAU;QACvC,CAAC,CAAC,YAAY,EAAE;QAChB,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["import superjson, { type SuperJSONResult } from \"superjson\";\nimport { getAdaptor } from \"../bridges/index.js\";\nimport { VIEW_CONTEXT_KEY } from \"../data-llm.js\";\nimport type { UnknownObject } from \"../types.js\";\n\nexport function filterViewContext<T extends UnknownObject>(\n  state?: T | null,\n): T | null {\n  if (state === null || state === undefined) {\n    return null;\n  }\n\n  const { [VIEW_CONTEXT_KEY]: _, ...filteredState } = state as T & {\n    [VIEW_CONTEXT_KEY]?: unknown;\n  };\n\n  return filteredState as T;\n}\n\nexport function injectViewContext<T extends UnknownObject>(\n  newState: T | null,\n): T | null {\n  if (newState === null) {\n    return null;\n  }\n\n  const currentState = getAdaptor()\n    .getHostContextStore(\"viewState\")\n    .getSnapshot() as (T & { [VIEW_CONTEXT_KEY]?: unknown }) | null;\n\n  if (\n    currentState !== null &&\n    currentState !== undefined &&\n    VIEW_CONTEXT_KEY in currentState\n  ) {\n    return {\n      ...newState,\n      [VIEW_CONTEXT_KEY]: currentState[VIEW_CONTEXT_KEY],\n    } as T;\n  }\n\n  return newState;\n}\n\nexport function serializeState(value: UnknownObject) {\n  return superjson.parse(superjson.stringify(value)); // Strips functions\n}\n\nexport function deserializeState(value: SuperJSONResult): unknown {\n  return superjson.deserialize(value);\n}\n\nexport function getInitialState<State extends UnknownObject>(\n  defaultState?: State | (() => State),\n): State | null {\n  const viewState = getAdaptor()\n    .getHostContextStore(\"viewState\")\n    .getSnapshot() as State | null;\n\n  if (viewState !== null && viewState !== undefined) {\n    return filterViewContext(viewState);\n  }\n\n  return typeof defaultState === \"function\"\n    ? defaultState()\n    : (defaultState ?? null);\n}\n"]}

package/dist/web/helpers/state.test.js

@@ -1,29 +1,29 @@
 import { describe, expect, it } from "vitest";
-import { WIDGET_CONTEXT_KEY } from "../data-llm.js";
-import { filterWidgetContext, serializeState } from "./state.js";
+import { VIEW_CONTEXT_KEY } from "../data-llm.js";
+import { filterViewContext, serializeState } from "./state.js";
 describe("state helpers", () => {
-    describe("filterWidgetContext", () => {
+    describe("filterViewContext", () => {
         it("should return null when state is null", () => {
-            expect(filterWidgetContext(null)).toBe(null);
+            expect(filterViewContext(null)).toBe(null);
         });
         it("should return null when state is undefined", () => {
-            expect(filterWidgetContext(undefined)).toBe(null);
+            expect(filterViewContext(undefined)).toBe(null);
         });
-        it("should correctly filter WIDGET_CONTEXT_KEY and preserve other properties", () => {
+        it("should correctly filter VIEW_CONTEXT_KEY and preserve other properties", () => {
             const stateWithContextAndOthers = {
                 a: 1,
                 b: "two",
                 c: { nested: true },
-                [WIDGET_CONTEXT_KEY]: "context",
+                [VIEW_CONTEXT_KEY]: "context",
             };
-            const filteredWithContextAndOthers = filterWidgetContext(stateWithContextAndOthers);
+            const filteredWithContextAndOthers = filterViewContext(stateWithContextAndOthers);
             expect(filteredWithContextAndOthers).toEqual({
                 a: 1,
                 b: "two",
                 c: { nested: true },
             });
             const stateNoContext = { count: 5, name: "test" };
-            const filteredNoContext = filterWidgetContext(stateNoContext);
+            const filteredNoContext = filterViewContext(stateNoContext);
             expect(filteredNoContext).toEqual(stateNoContext);
         });
     });

package/dist/web/helpers/state.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"state.test.js","sourceRoot":"","sources":["../../../src/web/helpers/state.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjE,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,yBAAyB,GAAG;gBAChC,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBACnB,CAAC,kBAAkB,CAAC,EAAE,SAAS;aAChC,CAAC;YACF,MAAM,4BAA4B,GAAG,mBAAmB,CACtD,yBAAyB,CAC1B,CAAC;YACF,MAAM,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC;gBAC3C,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;YAC9D,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK;gBACL,IAAI;gBACJ,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"state.test.js","sourceRoot":"","sources":["../../../src/web/helpers/state.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE/D,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,yBAAyB,GAAG;gBAChC,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBACnB,CAAC,gBAAgB,CAAC,EAAE,SAAS;aAC9B,CAAC;YACF,MAAM,4BAA4B,GAAG,iBAAiB,CACpD,yBAAyB,CAC1B,CAAC;YACF,MAAM,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC;gBAC3C,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACpB,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAClD,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;YAC5D,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK;gBACL,IAAI;gBACJ,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,MAAM;gBACT,CAAC,EAAE,IAAI;gBACP,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { VIEW_CONTEXT_KEY } from \"../data-llm.js\";\nimport { filterViewContext, serializeState } from \"./state.js\";\n\ndescribe(\"state helpers\", () => {\n  describe(\"filterViewContext\", () => {\n    it(\"should return null when state is null\", () => {\n      expect(filterViewContext(null)).toBe(null);\n    });\n\n    it(\"should return null when state is undefined\", () => {\n      expect(filterViewContext(undefined)).toBe(null);\n    });\n\n    it(\"should correctly filter VIEW_CONTEXT_KEY and preserve other properties\", () => {\n      const stateWithContextAndOthers = {\n        a: 1,\n        b: \"two\",\n        c: { nested: true },\n        [VIEW_CONTEXT_KEY]: \"context\",\n      };\n      const filteredWithContextAndOthers = filterViewContext(\n        stateWithContextAndOthers,\n      );\n      expect(filteredWithContextAndOthers).toEqual({\n        a: 1,\n        b: \"two\",\n        c: { nested: true },\n      });\n\n      const stateNoContext = { count: 5, name: \"test\" };\n      const filteredNoContext = filterViewContext(stateNoContext);\n      expect(filteredNoContext).toEqual(stateNoContext);\n    });\n  });\n\n  describe(\"serializeState\", () => {\n    it(\"should serialize plain objects\", () => {\n      const array = [1, \"two\", { three: 3 }];\n      const date = new Date(\"2023-01-01T00:00:00Z\");\n      const object = {\n        a: 1,\n        b: \"test\",\n        c: true,\n        array,\n        date,\n        function: () => \"test\",\n      };\n      const result = serializeState(object);\n\n      expect(result).toEqual({\n        a: 1,\n        b: \"test\",\n        c: true,\n        array: [1, \"two\", { three: 3 }],\n        date: new Date(\"2023-01-01T00:00:00.000Z\"),\n      });\n    });\n  });\n});\n"]}

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

@@ -1,11 +1,20 @@
 export { type CallToolAsyncFn, type CallToolFn, type CallToolState, type SideEffects, useCallTool, } from "./use-call-tool.js";
+export { useDeepLink } from "./use-deep-link.js";
 export { useDisplayMode } from "./use-display-mode.js";
+export { type DownloadFn, useDownload } from "./use-download.js";
+export { type FileResourceState, useFileResource, } from "./use-file-resource.js";
 export { useFiles } from "./use-files.js";
-export { type LayoutState, useLayout } from "./use-layout.js";
+export { type Host, type HostInfo, type OpenAIHostCapabilities, useHost, } from "./use-host.js";
+export { type ModelContextState, useModelContext, } from "./use-model-context.js";
 export { type OpenExternalFn, useOpenExternal } from "./use-open-external.js";
+export { useOpenFile } from "./use-open-file.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";
 export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
 export { useSetOpenInAppUrl } from "./use-set-open-in-app-url.js";
 export { useToolInfo } from "./use-tool-info.js";
 export { type UserState, useUser } from "./use-user.js";
-export { useWidgetState } from "./use-widget-state.js";
+export { useViewState } from "./use-view-state.js";
+export { useViewport, type ViewportState } from "./use-viewport.js";

package/dist/web/hooks/index.js

@@ -1,12 +1,21 @@
 export { useCallTool, } from "./use-call-tool.js";
+export { useDeepLink } from "./use-deep-link.js";
 export { useDisplayMode } from "./use-display-mode.js";
+export { useDownload } from "./use-download.js";
+export { useFileResource, } from "./use-file-resource.js";
 export { useFiles } from "./use-files.js";
-export { useLayout } from "./use-layout.js";
+export { useHost, } from "./use-host.js";
+export { useModelContext, } from "./use-model-context.js";
 export { useOpenExternal } from "./use-open-external.js";
+export { useOpenFile } from "./use-open-file.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";
 export { useSendFollowUpMessage } from "./use-send-follow-up-message.js";
 export { useSetOpenInAppUrl } from "./use-set-open-in-app-url.js";
 export { useToolInfo } from "./use-tool-info.js";
 export { useUser } from "./use-user.js";
-export { useWidgetState } from "./use-widget-state.js";
+export { useViewState } from "./use-view-state.js";
+export { useViewport } from "./use-viewport.js";
 //# sourceMappingURL=index.js.map

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,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,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,cAAc,EAAE,MAAM,uBAAuB,CAAC"}
+{"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,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAEL,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAIL,OAAO,GACR,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAuB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,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;AACnD,OAAO,EAAE,WAAW,EAAsB,MAAM,mBAAmB,CAAC","sourcesContent":["export {\n  type CallToolAsyncFn,\n  type CallToolFn,\n  type CallToolState,\n  type SideEffects,\n  useCallTool,\n} from \"./use-call-tool.js\";\nexport { useDeepLink } from \"./use-deep-link.js\";\nexport { useDisplayMode } from \"./use-display-mode.js\";\nexport { type DownloadFn, useDownload } from \"./use-download.js\";\nexport {\n  type FileResourceState,\n  useFileResource,\n} from \"./use-file-resource.js\";\nexport { useFiles } from \"./use-files.js\";\nexport {\n  type Host,\n  type HostInfo,\n  type OpenAIHostCapabilities,\n  useHost,\n} from \"./use-host.js\";\nexport {\n  type ModelContextState,\n  useModelContext,\n} from \"./use-model-context.js\";\nexport { type OpenExternalFn, useOpenExternal } from \"./use-open-external.js\";\nexport { useOpenFile } from \"./use-open-file.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\";\nexport { useViewport, type ViewportState } from \"./use-viewport.js\";\n"]}

package/dist/web/hooks/openai-extensions.test.d.ts

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

package/dist/web/hooks/openai-extensions.test.js

@@ -0,0 +1,107 @@
+import { act, renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { HostAdaptor } from "../bridges/adaptor.js";
+import { McpAppBridge } from "../bridges/mcp-app/index.js";
+import { getMcpAppHostPostMessageMock, MockResizeObserver, } from "./test/utils.js";
+import { useDeepLink } from "./use-deep-link.js";
+import { useModelContext } from "./use-model-context.js";
+import { useViewState } from "./use-view-state.js";
+async function notifyHostContext(params) {
+    await act(async () => {
+        window.dispatchEvent(new MessageEvent("message", {
+            source: window.parent,
+            data: {
+                jsonrpc: "2.0",
+                method: "ui/notifications/host-context-changed",
+                params,
+            },
+        }));
+    });
+}
+describe("model context and deep links in the view", () => {
+    beforeEach(() => {
+        vi.stubGlobal("openai", undefined);
+        vi.stubGlobal("skybridge", {});
+        vi.stubGlobal("ResizeObserver", MockResizeObserver);
+        localStorage.clear();
+    });
+    afterEach(() => {
+        HostAdaptor.resetInstance();
+        McpAppBridge.resetInstance();
+        vi.unstubAllGlobals();
+        localStorage.clear();
+    });
+    it("merges model context with view state and drops it once the user removes it", async () => {
+        const postMessage = getMcpAppHostPostMessageMock({}, { hostCapabilities: { updateModelContext: {} } });
+        vi.stubGlobal("parent", { postMessage });
+        const { result } = renderHook(() => ({
+            model: useModelContext(),
+            view: useViewState({ tab: "a" }),
+        }));
+        await waitFor(() => expect(result.current.model.supported).toBe(true));
+        const content = [
+            {
+                type: "text",
+                text: "Selected ski",
+                _meta: { "openai/title": "Ski" },
+            },
+        ];
+        const lastModelContext = () => postMessage.mock.calls
+            .map(([message]) => message)
+            .filter((message) => message.method === "ui/update-model-context")
+            .at(-1)?.params;
+        await act(async () => result.current.model.update({
+            content,
+            structuredContent: { ski: 1, tab: "x" },
+        }));
+        await act(async () => result.current.view[1]({ tab: "b" }));
+        expect(lastModelContext()).toEqual({
+            structuredContent: { ski: 1, tab: "b" },
+            content: [
+                {
+                    type: "text",
+                    text: JSON.stringify({ tab: "b" }),
+                    annotations: { audience: ["assistant"] },
+                },
+                ...content,
+            ],
+        });
+        await notifyHostContext({
+            "openai/modelContext": { updateId: "one", content },
+        });
+        expect(result.current.model.context).toEqual({ updateId: "one", content });
+        await notifyHostContext({ "openai/modelContext": null });
+        expect(result.current.model.context).toBeNull();
+        await act(async () => result.current.view[1]({ tab: "c" }));
+        expect(lastModelContext()).toEqual({
+            structuredContent: { tab: "c" },
+            content: [
+                {
+                    type: "text",
+                    text: JSON.stringify({ tab: "c" }),
+                    annotations: { audience: ["assistant"] },
+                },
+            ],
+        });
+    });
+    it("rejects model context updates on hosts without the capability", async () => {
+        const postMessage = getMcpAppHostPostMessageMock();
+        vi.stubGlobal("parent", { postMessage });
+        const { result } = renderHook(useModelContext);
+        await expect(result.current.update({ content: [] })).rejects.toThrow("updateModelContext");
+        expect(result.current.supported).toBe(false);
+        expect(postMessage.mock.calls.some(([message]) => message.method === "ui/update-model-context")).toBe(false);
+    });
+    it("reads app-relative deep links and ignores ones that leave the app", async () => {
+        vi.stubGlobal("parent", {
+            postMessage: getMcpAppHostPostMessageMock({
+                "openai/deepLink": { url: "/parts?tag=bolt" },
+            }),
+        });
+        const { result } = renderHook(useDeepLink);
+        await waitFor(() => expect(result.current).toBe("/parts?tag=bolt"));
+        await notifyHostContext({ "openai/deepLink": { url: "//evil.test" } });
+        expect(result.current).toBeUndefined();
+    });
+});
+//# sourceMappingURL=openai-extensions.test.js.map

package/dist/web/hooks/openai-extensions.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-extensions.test.js","sourceRoot":"","sources":["../../../src/web/hooks/openai-extensions.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EACL,4BAA4B,EAC5B,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,KAAK,UAAU,iBAAiB,CAAC,MAA+B;IAC9D,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,CAAC,aAAa,CAClB,IAAI,YAAY,CAAC,SAAS,EAAE;YAC1B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,uCAAuC;gBAC/C,MAAM;aACP;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACxD,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACnC,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC/B,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;QACpD,YAAY,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,WAAW,CAAC,aAAa,EAAE,CAAC;QAC5B,YAAY,CAAC,aAAa,EAAE,CAAC;QAC7B,EAAE,CAAC,gBAAgB,EAAE,CAAC;QACtB,YAAY,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QAC1F,MAAM,WAAW,GAAG,4BAA4B,CAC9C,EAAE,EACF,EAAE,gBAAgB,EAAE,EAAE,kBAAkB,EAAE,EAAE,EAAE,EAAE,CACjD,CAAC;QACF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC;YACnC,KAAK,EAAE,eAAe,EAAE;YACxB,IAAI,EAAE,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;SACjC,CAAC,CAAC,CAAC;QACJ,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG;YACd;gBACE,IAAI,EAAE,MAAe;gBACrB,IAAI,EAAE,cAAc;gBACpB,KAAK,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE;aACjC;SACF,CAAC;QACF,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,WAAW,CAAC,IAAI,CAAC,KAAK;aACnB,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAA+C,CAAC;aACnE,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,yBAAyB,CAAC;aACjE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAEpB,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE,CACnB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1B,OAAO;YACP,iBAAiB,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE;SACxC,CAAC,CACH,CAAC;QACF,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC;YACjC,iBAAiB,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE;YACvC,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;oBAClC,WAAW,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;iBACzC;gBACD,GAAG,OAAO;aACX;SACF,CAAC,CAAC;QAEH,MAAM,iBAAiB,CAAC;YACtB,qBAAqB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;SACpD,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3E,MAAM,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEhD,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC;YACjC,iBAAiB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE;YAC/B,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;oBAClC,WAAW,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;iBACzC;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,WAAW,GAAG,4BAA4B,EAAE,CAAC;QACnD,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;QAE/C,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAClE,oBAAoB,CACrB,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CACJ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CACzB,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,yBAAyB,CAC5D,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,4BAA4B,CAAC;gBACxC,iBAAiB,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE;aAC9C,CAAC;SACH,CAAC,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAEpE,MAAM,iBAAiB,CAAC,EAAE,iBAAiB,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { act, renderHook, waitFor } from \"@testing-library/react\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { HostAdaptor } from \"../bridges/adaptor.js\";\nimport { McpAppBridge } from \"../bridges/mcp-app/index.js\";\nimport {\n  getMcpAppHostPostMessageMock,\n  MockResizeObserver,\n} from \"./test/utils.js\";\nimport { useDeepLink } from \"./use-deep-link.js\";\nimport { useModelContext } from \"./use-model-context.js\";\nimport { useViewState } from \"./use-view-state.js\";\n\nasync function notifyHostContext(params: Record<string, unknown>) {\n  await act(async () => {\n    window.dispatchEvent(\n      new MessageEvent(\"message\", {\n        source: window.parent,\n        data: {\n          jsonrpc: \"2.0\",\n          method: \"ui/notifications/host-context-changed\",\n          params,\n        },\n      }),\n    );\n  });\n}\n\ndescribe(\"model context and deep links in the view\", () => {\n  beforeEach(() => {\n    vi.stubGlobal(\"openai\", undefined);\n    vi.stubGlobal(\"skybridge\", {});\n    vi.stubGlobal(\"ResizeObserver\", MockResizeObserver);\n    localStorage.clear();\n  });\n\n  afterEach(() => {\n    HostAdaptor.resetInstance();\n    McpAppBridge.resetInstance();\n    vi.unstubAllGlobals();\n    localStorage.clear();\n  });\n\n  it(\"merges model context with view state and drops it once the user removes it\", async () => {\n    const postMessage = getMcpAppHostPostMessageMock(\n      {},\n      { hostCapabilities: { updateModelContext: {} } },\n    );\n    vi.stubGlobal(\"parent\", { postMessage });\n    const { result } = renderHook(() => ({\n      model: useModelContext(),\n      view: useViewState({ tab: \"a\" }),\n    }));\n    await waitFor(() => expect(result.current.model.supported).toBe(true));\n    const content = [\n      {\n        type: \"text\" as const,\n        text: \"Selected ski\",\n        _meta: { \"openai/title\": \"Ski\" },\n      },\n    ];\n    const lastModelContext = () =>\n      postMessage.mock.calls\n        .map(([message]) => message as { method: string; params?: unknown })\n        .filter((message) => message.method === \"ui/update-model-context\")\n        .at(-1)?.params;\n\n    await act(async () =>\n      result.current.model.update({\n        content,\n        structuredContent: { ski: 1, tab: \"x\" },\n      }),\n    );\n    await act(async () => result.current.view[1]({ tab: \"b\" }));\n    expect(lastModelContext()).toEqual({\n      structuredContent: { ski: 1, tab: \"b\" },\n      content: [\n        {\n          type: \"text\",\n          text: JSON.stringify({ tab: \"b\" }),\n          annotations: { audience: [\"assistant\"] },\n        },\n        ...content,\n      ],\n    });\n\n    await notifyHostContext({\n      \"openai/modelContext\": { updateId: \"one\", content },\n    });\n    expect(result.current.model.context).toEqual({ updateId: \"one\", content });\n    await notifyHostContext({ \"openai/modelContext\": null });\n    expect(result.current.model.context).toBeNull();\n\n    await act(async () => result.current.view[1]({ tab: \"c\" }));\n    expect(lastModelContext()).toEqual({\n      structuredContent: { tab: \"c\" },\n      content: [\n        {\n          type: \"text\",\n          text: JSON.stringify({ tab: \"c\" }),\n          annotations: { audience: [\"assistant\"] },\n        },\n      ],\n    });\n  });\n\n  it(\"rejects model context updates on hosts without the capability\", async () => {\n    const postMessage = getMcpAppHostPostMessageMock();\n    vi.stubGlobal(\"parent\", { postMessage });\n    const { result } = renderHook(useModelContext);\n\n    await expect(result.current.update({ content: [] })).rejects.toThrow(\n      \"updateModelContext\",\n    );\n    expect(result.current.supported).toBe(false);\n    expect(\n      postMessage.mock.calls.some(\n        ([message]) => message.method === \"ui/update-model-context\",\n      ),\n    ).toBe(false);\n  });\n\n  it(\"reads app-relative deep links and ignores ones that leave the app\", async () => {\n    vi.stubGlobal(\"parent\", {\n      postMessage: getMcpAppHostPostMessageMock({\n        \"openai/deepLink\": { url: \"/parts?tag=bolt\" },\n      }),\n    });\n    const { result } = renderHook(useDeepLink);\n    await waitFor(() => expect(result.current).toBe(\"/parts?tag=bolt\"));\n\n    await notifyHostContext({ \"openai/deepLink\": { url: \"//evil.test\" } });\n    expect(result.current).toBeUndefined();\n  });\n});\n"]}

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

@@ -1,10 +1,15 @@
-import type { McpUiHostContext, McpUiToolResultNotification } from "@modelcontextprotocol/ext-apps";
+import type { McpUiDownloadFileResult, McpUiHostCapabilities, McpUiHostContext, McpUiInitializeResult, 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;
+    hostInfo?: McpUiInitializeResult["hostInfo"];
+};
+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,16 +7,17 @@ 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: {},
+                hostInfo: options.hostInfo ?? { name: "test-host", version: "1.0.0" },
+                hostCapabilities: options.hostCapabilities ?? {},
                 hostContext: initialContext,
             };
             act(() => fireEvent(window, new MessageEvent("message", {
+                source: window.parent,
                 data: {
                     jsonrpc: "2.0",
                     id: message.id,
@@ -27,6 +28,7 @@ export const getMcpAppHostPostMessageMock = (initialContext = DEFAULT_CONTEXT) =
         }
         case "ui/update-model-context": {
             act(() => fireEvent(window, new MessageEvent("message", {
+                source: window.parent,
                 data: {
                     jsonrpc: "2.0",
                     id: message.id,
@@ -35,10 +37,22 @@ 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) => {
     fireEvent(window, new MessageEvent("message", {
+        source: window.parent,
         data: {
             jsonrpc: "2.0",
             method: "ui/notifications/tool-input",
@@ -50,6 +64,7 @@ export const fireToolInputNotification = (args) => {
 };
 export const fireToolResultNotification = (params) => {
     fireEvent(window, new MessageEvent("message", {
+        source: window.parent,
         data: {
             jsonrpc: "2.0",
             method: "ui/notifications/tool-result",

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,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,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,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,IAAI,EAAE;YACJ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,8BAA8B;YACtC,MAAM;SACP;KACF,CACF,CACF,CAAC;AACJ,CAAC,CAAC"}
+{"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;AAQ7C,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,OAAO,CAAC,QAAQ,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE;gBACrE,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  hostInfo?: McpUiInitializeResult[\"hostInfo\"];\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: options.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

@@ -1,4 +1,4 @@
-import { type CallToolArgs, type CallToolResponse } from "../bridges/index.js";
+import { type CallToolArgs, type CallToolOptions, type CallToolResponse } from "../bridges/index.js";
 import type { HasRequiredKeys } from "../types.js";
 type CallToolIdleState = {
     status: "idle";
@@ -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,12 +65,44 @@ 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">;
-export declare const useCallTool: <ToolArgs extends CallToolArgs = null, ToolResponse extends Partial<ToolResponseSignature> = Record<string, never>>(name: string) => {
+/**
+ * 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, options?: CallToolOptions) => {
     callTool: CallToolFn<ToolArgs, CallToolResponse & ToolResponse>;
     callToolAsync: CallToolAsyncFn<ToolArgs, CallToolResponse & ToolResponse>;
     status: "idle";

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

@@ -1,14 +1,47 @@
-import { useRef, useState } from "react";
+import { useCallback, useRef, useState } from "react";
 import { getAdaptor, } from "../bridges/index.js";
-export const useCallTool = (name) => {
+/**
+ * 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, options) => {
     const [{ status, data, error }, setCallToolState] = useState({ status: "idle", data: undefined, error: undefined });
     const callIdRef = useRef(0);
     const adaptor = getAdaptor();
-    const execute = async (toolArgs) => {
+    const timeout = options?.timeout;
+    const execute = useCallback(async (toolArgs) => {
         const callId = ++callIdRef.current;
-        setCallToolState({ status: "pending", data: undefined, error: undefined });
+        setCallToolState({
+            status: "pending",
+            data: undefined,
+            error: undefined,
+        });
         try {
-            const data = await adaptor.callTool(name, toolArgs);
+            const data = await adaptor.callTool(name, toolArgs, { timeout });
             if (callId === callIdRef.current) {
                 setCallToolState({ status: "success", data, error: undefined });
             }
@@ -20,14 +53,14 @@ export const useCallTool = (name) => {
             }
             throw error;
         }
-    };
-    const callToolAsync = ((toolArgs) => {
+    }, [adaptor, name, timeout]);
+    const callToolAsync = useCallback((toolArgs) => {
         if (toolArgs === undefined) {
             return execute(null);
         }
         return execute(toolArgs);
-    });
-    const callTool = ((firstArg, sideEffects) => {
+    }, [execute]);
+    const callTool = useCallback((firstArg, sideEffects) => {
         let toolArgs;
         if (firstArg &&
             typeof firstArg === "object" &&
@@ -49,7 +82,7 @@ export const useCallTool = (name) => {
             sideEffects?.onError?.(error, toolArgs);
             sideEffects?.onSettled?.(undefined, error, toolArgs);
         });
-    });
+    }, [execute]);
     const callToolState = {
         status,
         data,

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"}
+{"version":3,"file":"use-call-tool.js","sourceRoot":"","sources":["../../../src/web/hooks/use-call-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtD,OAAO,EAIL,UAAU,GACX,MAAM,qBAAqB,CAAC;AA4G7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAIzB,IAAY,EACZ,OAAyB,EACzB,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;IAC7B,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC;IAEjC,MAAM,OAAO,GAAG,WAAW,CACzB,KAAK,EAAE,QAAkB,EAAqC,EAAE;QAC9D,MAAM,MAAM,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;QACnC,gBAAgB,CAAC;YACf,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;SACjB,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CACjC,IAAI,EACJ,QAAQ,EACR,EAAE,OAAO,EAAE,CACZ,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,EACD,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CACzB,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,QAAmB,EAAE,EAAE;QACtB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAgB,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,EACD,CAAC,OAAO,CAAC,CAC6C,CAAC;IAEzD,MAAM,QAAQ,GAAG,WAAW,CAC1B,CACE,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,EACD,CAAC,OAAO,CAAC,CACwC,CAAC;IAEpD,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 { useCallback, useRef, useState } from \"react\";\n\nimport {\n  type CallToolArgs,\n  type CallToolOptions,\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  options?: CallToolOptions,\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  const timeout = options?.timeout;\n\n  const execute = useCallback(\n    async (toolArgs: ToolArgs): Promise<CombinedCallToolResponse> => {\n      const callId = ++callIdRef.current;\n      setCallToolState({\n        status: \"pending\",\n        data: undefined,\n        error: undefined,\n      });\n\n      try {\n        const data = await adaptor.callTool<ToolArgs, CombinedCallToolResponse>(\n          name,\n          toolArgs,\n          { timeout },\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    [adaptor, name, timeout],\n  );\n\n  const callToolAsync = useCallback(\n    (toolArgs?: ToolArgs) => {\n      if (toolArgs === undefined) {\n        return execute(null as ToolArgs);\n      }\n      return execute(toolArgs);\n    },\n    [execute],\n  ) as CallToolAsyncFn<ToolArgs, CombinedCallToolResponse>;\n\n  const callTool = useCallback(\n    (\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    },\n    [execute],\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"]}