@assistant-ui/mcp-docs-server 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (459) hide show
  1. package/README.md +16 -43
  2. package/dist/index.d.ts +2 -3
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +3 -91
  5. package/dist/index.js.map +1 -1
  6. package/dist/proxy.d.ts +9 -0
  7. package/dist/proxy.d.ts.map +1 -0
  8. package/dist/proxy.js +76 -0
  9. package/dist/proxy.js.map +1 -0
  10. package/package.json +9 -13
  11. package/src/index.ts +3 -115
  12. package/src/proxy.test.ts +250 -0
  13. package/src/proxy.ts +111 -0
  14. package/.docs/organized/code-examples/waterfall.md +0 -807
  15. package/.docs/organized/code-examples/with-a2a.md +0 -674
  16. package/.docs/organized/code-examples/with-ag-ui.md +0 -552
  17. package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -465
  18. package/.docs/organized/code-examples/with-artifacts.md +0 -814
  19. package/.docs/organized/code-examples/with-assistant-transport.md +0 -575
  20. package/.docs/organized/code-examples/with-browser-extension.md +0 -371
  21. package/.docs/organized/code-examples/with-chain-of-thought.md +0 -960
  22. package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
  23. package/.docs/organized/code-examples/with-cloud.md +0 -438
  24. package/.docs/organized/code-examples/with-custom-thread-list.md +0 -568
  25. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -526
  26. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -696
  27. package/.docs/organized/code-examples/with-eve.md +0 -404
  28. package/.docs/organized/code-examples/with-expo.md +0 -2063
  29. package/.docs/organized/code-examples/with-external-store.md +0 -420
  30. package/.docs/organized/code-examples/with-ffmpeg.md +0 -828
  31. package/.docs/organized/code-examples/with-generative-ui.md +0 -1812
  32. package/.docs/organized/code-examples/with-google-adk.md +0 -367
  33. package/.docs/organized/code-examples/with-heat-graph.md +0 -304
  34. package/.docs/organized/code-examples/with-image-generation.md +0 -462
  35. package/.docs/organized/code-examples/with-interactables.md +0 -732
  36. package/.docs/organized/code-examples/with-langchain.md +0 -445
  37. package/.docs/organized/code-examples/with-langgraph.md +0 -854
  38. package/.docs/organized/code-examples/with-livekit.md +0 -642
  39. package/.docs/organized/code-examples/with-mcp.md +0 -780
  40. package/.docs/organized/code-examples/with-nuxt.md +0 -2428
  41. package/.docs/organized/code-examples/with-opencode.md +0 -1974
  42. package/.docs/organized/code-examples/with-openui.md +0 -449
  43. package/.docs/organized/code-examples/with-pi.md +0 -2083
  44. package/.docs/organized/code-examples/with-react-hook-form.md +0 -724
  45. package/.docs/organized/code-examples/with-react-ink-web.md +0 -690
  46. package/.docs/organized/code-examples/with-react-ink.md +0 -472
  47. package/.docs/organized/code-examples/with-react-router.md +0 -935
  48. package/.docs/organized/code-examples/with-resumable-stream.md +0 -667
  49. package/.docs/organized/code-examples/with-store.md +0 -679
  50. package/.docs/organized/code-examples/with-svelte.md +0 -415
  51. package/.docs/organized/code-examples/with-sveltekit.md +0 -1061
  52. package/.docs/organized/code-examples/with-tanstack.md +0 -811
  53. package/.docs/organized/code-examples/with-tap-runtime.md +0 -812
  54. package/.docs/organized/code-examples/with-virtualized-thread.md +0 -680
  55. package/.docs/organized/code-examples/with-vue.md +0 -408
  56. package/.docs/raw/docs/(docs)/architecture.mdx +0 -146
  57. package/.docs/raw/docs/(docs)/base-ui.mdx +0 -39
  58. package/.docs/raw/docs/(docs)/cli.mdx +0 -542
  59. package/.docs/raw/docs/(docs)/devtools.mdx +0 -79
  60. package/.docs/raw/docs/(docs)/index.mdx +0 -21
  61. package/.docs/raw/docs/(docs)/installation.mdx +0 -483
  62. package/.docs/raw/docs/(docs)/llm.mdx +0 -211
  63. package/.docs/raw/docs/(docs)/rtl.mdx +0 -78
  64. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +0 -36
  65. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +0 -20
  66. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +0 -34
  67. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +0 -44
  68. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +0 -59
  69. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +0 -20
  70. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +0 -20
  71. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -84
  72. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +0 -22
  73. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +0 -64
  74. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +0 -22
  75. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +0 -52
  76. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +0 -49
  77. package/.docs/raw/docs/(reference)/api-reference/generative-ui/a2ui.mdx +0 -40
  78. package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +0 -56
  79. package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +0 -86
  80. package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +0 -39
  81. package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +0 -42
  82. package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +0 -84
  83. package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +0 -85
  84. package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +0 -45
  85. package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +0 -93
  86. package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +0 -62
  87. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +0 -129
  88. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +0 -31
  89. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +0 -34
  90. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +0 -350
  91. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +0 -28
  92. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +0 -97
  93. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
  94. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -97
  95. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
  96. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +0 -200
  97. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -37
  98. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +0 -50
  99. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +0 -22
  100. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +0 -20
  101. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +0 -566
  102. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +0 -152
  103. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +0 -239
  104. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -208
  105. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +0 -108
  106. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -99
  107. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -145
  108. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +0 -82
  109. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +0 -619
  110. package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -22
  111. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -65
  112. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +0 -73
  113. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +0 -117
  114. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -339
  115. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +0 -77
  116. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +0 -88
  117. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -81
  118. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -129
  119. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +0 -138
  120. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +0 -122
  121. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -289
  122. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -20
  123. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +0 -24
  124. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +0 -32
  125. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +0 -43
  126. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +0 -43
  127. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +0 -24
  128. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +0 -20
  129. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -24
  130. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -24
  131. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +0 -36
  132. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +0 -85
  133. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +0 -45
  134. package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx +0 -55
  135. package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +0 -151
  136. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +0 -106
  137. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -62
  138. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +0 -178
  139. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +0 -48
  140. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +0 -62
  141. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +0 -22
  142. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +0 -19
  143. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +0 -149
  144. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +0 -22
  145. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +0 -54
  146. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +0 -36
  147. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +0 -527
  148. package/.docs/raw/docs/cloud/ai-sdk.mdx +0 -602
  149. package/.docs/raw/docs/cloud/authorization.mdx +0 -252
  150. package/.docs/raw/docs/cloud/index.mdx +0 -46
  151. package/.docs/raw/docs/cloud/langgraph.mdx +0 -554
  152. package/.docs/raw/docs/copilots/assistant-frame.mdx +0 -400
  153. package/.docs/raw/docs/copilots/make-assistant-visible.mdx +0 -82
  154. package/.docs/raw/docs/copilots/model-context.mdx +0 -156
  155. package/.docs/raw/docs/copilots/motivation.mdx +0 -202
  156. package/.docs/raw/docs/copilots/use-assistant-instructions.mdx +0 -64
  157. package/.docs/raw/docs/guides/attachments.mdx +0 -619
  158. package/.docs/raw/docs/guides/branching.mdx +0 -76
  159. package/.docs/raw/docs/guides/chain-of-thought.mdx +0 -164
  160. package/.docs/raw/docs/guides/chatgpt-subscription.mdx +0 -108
  161. package/.docs/raw/docs/guides/context-api.mdx +0 -619
  162. package/.docs/raw/docs/guides/dictation.mdx +0 -298
  163. package/.docs/raw/docs/guides/editing.mdx +0 -102
  164. package/.docs/raw/docs/guides/electron.mdx +0 -369
  165. package/.docs/raw/docs/guides/headless-composer-input.mdx +0 -113
  166. package/.docs/raw/docs/guides/image-generation.mdx +0 -74
  167. package/.docs/raw/docs/guides/index.mdx +0 -117
  168. package/.docs/raw/docs/guides/input-history.mdx +0 -55
  169. package/.docs/raw/docs/guides/latex.mdx +0 -158
  170. package/.docs/raw/docs/guides/mentions.mdx +0 -575
  171. package/.docs/raw/docs/guides/message-timing.mdx +0 -209
  172. package/.docs/raw/docs/guides/quoting.mdx +0 -169
  173. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +0 -212
  174. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +0 -152
  175. package/.docs/raw/docs/guides/resumable-streams.mdx +0 -292
  176. package/.docs/raw/docs/guides/slash-commands.mdx +0 -358
  177. package/.docs/raw/docs/guides/speech.mdx +0 -172
  178. package/.docs/raw/docs/guides/suggestions.mdx +0 -384
  179. package/.docs/raw/docs/guides/virtualization.mdx +0 -133
  180. package/.docs/raw/docs/guides/voice.mdx +0 -310
  181. package/.docs/raw/docs/ink/adapters.mdx +0 -99
  182. package/.docs/raw/docs/ink/custom-backend.mdx +0 -254
  183. package/.docs/raw/docs/ink/hooks.mdx +0 -469
  184. package/.docs/raw/docs/ink/index.mdx +0 -236
  185. package/.docs/raw/docs/ink/migration.mdx +0 -138
  186. package/.docs/raw/docs/ink/primitives.mdx +0 -1259
  187. package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +0 -528
  188. package/.docs/raw/docs/integrations/auth/better-auth.mdx +0 -188
  189. package/.docs/raw/docs/integrations/auth/clerk.mdx +0 -166
  190. package/.docs/raw/docs/integrations/auth/next-auth.mdx +0 -191
  191. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +0 -88
  192. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +0 -282
  193. package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +0 -188
  194. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +0 -57
  195. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +0 -201
  196. package/.docs/raw/docs/integrations/gateways/index.mdx +0 -162
  197. package/.docs/raw/docs/integrations/index.mdx +0 -178
  198. package/.docs/raw/docs/integrations/observability/helicone.mdx +0 -129
  199. package/.docs/raw/docs/integrations/observability/langfuse.mdx +0 -161
  200. package/.docs/raw/docs/integrations/observability/langsmith.mdx +0 -151
  201. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +0 -773
  202. package/.docs/raw/docs/migrations/deprecation-policy.mdx +0 -42
  203. package/.docs/raw/docs/migrations/index.mdx +0 -50
  204. package/.docs/raw/docs/migrations/react-compatibility.mdx +0 -74
  205. package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +0 -328
  206. package/.docs/raw/docs/migrations/toolkit-tools.mdx +0 -236
  207. package/.docs/raw/docs/migrations/v0-11.mdx +0 -172
  208. package/.docs/raw/docs/migrations/v0-12.mdx +0 -302
  209. package/.docs/raw/docs/migrations/v0-14.mdx +0 -297
  210. package/.docs/raw/docs/migrations/v0-15.mdx +0 -270
  211. package/.docs/raw/docs/primitives/action-bar.mdx +0 -352
  212. package/.docs/raw/docs/primitives/assistant-modal.mdx +0 -216
  213. package/.docs/raw/docs/primitives/attachment.mdx +0 -217
  214. package/.docs/raw/docs/primitives/branch-picker.mdx +0 -222
  215. package/.docs/raw/docs/primitives/chain-of-thought.mdx +0 -315
  216. package/.docs/raw/docs/primitives/composer.mdx +0 -659
  217. package/.docs/raw/docs/primitives/error.mdx +0 -142
  218. package/.docs/raw/docs/primitives/index.mdx +0 -99
  219. package/.docs/raw/docs/primitives/message.mdx +0 -618
  220. package/.docs/raw/docs/primitives/selection-toolbar.mdx +0 -191
  221. package/.docs/raw/docs/primitives/suggestion.mdx +0 -254
  222. package/.docs/raw/docs/primitives/thread-list.mdx +0 -467
  223. package/.docs/raw/docs/primitives/thread.mdx +0 -509
  224. package/.docs/raw/docs/react-native/adapters.mdx +0 -94
  225. package/.docs/raw/docs/react-native/custom-backend.mdx +0 -207
  226. package/.docs/raw/docs/react-native/hooks.mdx +0 -339
  227. package/.docs/raw/docs/react-native/index.mdx +0 -289
  228. package/.docs/raw/docs/react-native/migration.mdx +0 -142
  229. package/.docs/raw/docs/react-native/primitives.mdx +0 -839
  230. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +0 -399
  231. package/.docs/raw/docs/runtimes/a2a/overview.mdx +0 -60
  232. package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +0 -216
  233. package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +0 -124
  234. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +0 -70
  235. package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +0 -243
  236. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +0 -255
  237. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +0 -61
  238. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -122
  239. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +0 -135
  240. package/.docs/raw/docs/runtimes/ai-sdk/v6-legacy.mdx +0 -636
  241. package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +0 -716
  242. package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +0 -118
  243. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +0 -265
  244. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +0 -167
  245. package/.docs/raw/docs/runtimes/concepts/stability.mdx +0 -68
  246. package/.docs/raw/docs/runtimes/concepts/threads.mdx +0 -513
  247. package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +0 -763
  248. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +0 -339
  249. package/.docs/raw/docs/runtimes/custom/external-store.mdx +0 -957
  250. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +0 -902
  251. package/.docs/raw/docs/runtimes/custom/overview.mdx +0 -71
  252. package/.docs/raw/docs/runtimes/eve/overview.mdx +0 -151
  253. package/.docs/raw/docs/runtimes/eve/quickstart.mdx +0 -192
  254. package/.docs/raw/docs/runtimes/google-adk/api.mdx +0 -256
  255. package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +0 -784
  256. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +0 -69
  257. package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +0 -229
  258. package/.docs/raw/docs/runtimes/langchain.mdx +0 -901
  259. package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +0 -181
  260. package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +0 -305
  261. package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +0 -104
  262. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +0 -84
  263. package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +0 -496
  264. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +0 -144
  265. package/.docs/raw/docs/runtimes/langgraph/threads.mdx +0 -113
  266. package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +0 -29
  267. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -93
  268. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +0 -347
  269. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -393
  270. package/.docs/raw/docs/runtimes/opencode/hooks.mdx +0 -194
  271. package/.docs/raw/docs/runtimes/opencode/overview.mdx +0 -58
  272. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +0 -119
  273. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +0 -133
  274. package/.docs/raw/docs/tools/a2ui.mdx +0 -107
  275. package/.docs/raw/docs/tools/backend.mdx +0 -147
  276. package/.docs/raw/docs/tools/defining-tools.mdx +0 -574
  277. package/.docs/raw/docs/tools/dynamic-tools.mdx +0 -112
  278. package/.docs/raw/docs/tools/generative-ui-primitive.mdx +0 -180
  279. package/.docs/raw/docs/tools/generative-ui-slack.mdx +0 -167
  280. package/.docs/raw/docs/tools/generative-ui-teams.mdx +0 -160
  281. package/.docs/raw/docs/tools/generative-ui.mdx +0 -322
  282. package/.docs/raw/docs/tools/index.mdx +0 -72
  283. package/.docs/raw/docs/tools/interactables.mdx +0 -1084
  284. package/.docs/raw/docs/tools/mcp-apps.mdx +0 -346
  285. package/.docs/raw/docs/tools/mcp.mdx +0 -466
  286. package/.docs/raw/docs/tools/multi-agent.mdx +0 -237
  287. package/.docs/raw/docs/tools/openui.mdx +0 -175
  288. package/.docs/raw/docs/tools/tool-ui.mdx +0 -1008
  289. package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
  290. package/.docs/raw/docs/ui/accordion.mdx +0 -266
  291. package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
  292. package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
  293. package/.docs/raw/docs/ui/attachment.mdx +0 -259
  294. package/.docs/raw/docs/ui/badge.mdx +0 -150
  295. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -212
  296. package/.docs/raw/docs/ui/context-display.mdx +0 -148
  297. package/.docs/raw/docs/ui/diff-viewer.mdx +0 -280
  298. package/.docs/raw/docs/ui/directive-text.mdx +0 -114
  299. package/.docs/raw/docs/ui/dot-matrix.mdx +0 -133
  300. package/.docs/raw/docs/ui/file.mdx +0 -159
  301. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
  302. package/.docs/raw/docs/ui/image.mdx +0 -102
  303. package/.docs/raw/docs/ui/markdown.mdx +0 -64
  304. package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
  305. package/.docs/raw/docs/ui/mermaid.mdx +0 -92
  306. package/.docs/raw/docs/ui/message-timing.mdx +0 -93
  307. package/.docs/raw/docs/ui/model-selector.mdx +0 -455
  308. package/.docs/raw/docs/ui/number-roll.mdx +0 -154
  309. package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
  310. package/.docs/raw/docs/ui/quote.mdx +0 -211
  311. package/.docs/raw/docs/ui/reasoning.mdx +0 -186
  312. package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
  313. package/.docs/raw/docs/ui/select.mdx +0 -254
  314. package/.docs/raw/docs/ui/sources.mdx +0 -177
  315. package/.docs/raw/docs/ui/streamdown.mdx +0 -392
  316. package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
  317. package/.docs/raw/docs/ui/tabs.mdx +0 -271
  318. package/.docs/raw/docs/ui/thread-list.mdx +0 -372
  319. package/.docs/raw/docs/ui/thread.mdx +0 -512
  320. package/.docs/raw/docs/ui/tool-fallback.mdx +0 -127
  321. package/.docs/raw/docs/ui/tool-group.mdx +0 -240
  322. package/.docs/raw/docs/ui/voice.mdx +0 -173
  323. package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
  324. package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
  325. package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
  326. package/dist/constants.d.ts +0 -14
  327. package/dist/constants.d.ts.map +0 -1
  328. package/dist/constants.js +0 -19
  329. package/dist/constants.js.map +0 -1
  330. package/dist/prepare-docs/code-examples.d.ts +0 -5
  331. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  332. package/dist/prepare-docs/code-examples.js +0 -117
  333. package/dist/prepare-docs/code-examples.js.map +0 -1
  334. package/dist/prepare-docs/copy-raw.d.ts +0 -5
  335. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  336. package/dist/prepare-docs/copy-raw.js +0 -49
  337. package/dist/prepare-docs/copy-raw.js.map +0 -1
  338. package/dist/prepare-docs/prepare.d.ts +0 -1
  339. package/dist/prepare-docs/prepare.js +0 -22
  340. package/dist/prepare-docs/prepare.js.map +0 -1
  341. package/dist/prompts/xulux-playground.d.ts +0 -12
  342. package/dist/prompts/xulux-playground.d.ts.map +0 -1
  343. package/dist/prompts/xulux-playground.js +0 -33
  344. package/dist/prompts/xulux-playground.js.map +0 -1
  345. package/dist/tools/docs.d.ts +0 -22
  346. package/dist/tools/docs.d.ts.map +0 -1
  347. package/dist/tools/docs.js +0 -177
  348. package/dist/tools/docs.js.map +0 -1
  349. package/dist/tools/examples.d.ts +0 -24
  350. package/dist/tools/examples.d.ts.map +0 -1
  351. package/dist/tools/examples.js +0 -87
  352. package/dist/tools/examples.js.map +0 -1
  353. package/dist/tools/resources.d.ts +0 -6
  354. package/dist/tools/resources.d.ts.map +0 -1
  355. package/dist/tools/resources.js +0 -75
  356. package/dist/tools/resources.js.map +0 -1
  357. package/dist/tools/search.d.ts +0 -24
  358. package/dist/tools/search.d.ts.map +0 -1
  359. package/dist/tools/search.js +0 -39
  360. package/dist/tools/search.js.map +0 -1
  361. package/dist/tools/tests/mcp-test-client.d.ts +0 -15
  362. package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
  363. package/dist/tools/tests/mcp-test-client.js +0 -68
  364. package/dist/tools/tests/mcp-test-client.js.map +0 -1
  365. package/dist/tools/tests/test-setup.d.ts +0 -7
  366. package/dist/tools/tests/test-setup.d.ts.map +0 -1
  367. package/dist/tools/tests/test-setup.js +0 -36
  368. package/dist/tools/tests/test-setup.js.map +0 -1
  369. package/dist/tools/xulux-templates.d.ts +0 -58
  370. package/dist/tools/xulux-templates.d.ts.map +0 -1
  371. package/dist/tools/xulux-templates.js +0 -84
  372. package/dist/tools/xulux-templates.js.map +0 -1
  373. package/dist/utils/cache.d.ts +0 -5
  374. package/dist/utils/cache.d.ts.map +0 -1
  375. package/dist/utils/cache.js +0 -18
  376. package/dist/utils/cache.js.map +0 -1
  377. package/dist/utils/logger.d.ts +0 -10
  378. package/dist/utils/logger.d.ts.map +0 -1
  379. package/dist/utils/logger.js +0 -20
  380. package/dist/utils/logger.js.map +0 -1
  381. package/dist/utils/mcp-format.d.ts +0 -11
  382. package/dist/utils/mcp-format.d.ts.map +0 -1
  383. package/dist/utils/mcp-format.js +0 -14
  384. package/dist/utils/mcp-format.js.map +0 -1
  385. package/dist/utils/mdx.d.ts +0 -12
  386. package/dist/utils/mdx.d.ts.map +0 -1
  387. package/dist/utils/mdx.js +0 -45
  388. package/dist/utils/mdx.js.map +0 -1
  389. package/dist/utils/paths.d.ts +0 -12
  390. package/dist/utils/paths.d.ts.map +0 -1
  391. package/dist/utils/paths.js +0 -93
  392. package/dist/utils/paths.js.map +0 -1
  393. package/dist/utils/search.d.ts +0 -10
  394. package/dist/utils/search.d.ts.map +0 -1
  395. package/dist/utils/search.js +0 -97
  396. package/dist/utils/search.js.map +0 -1
  397. package/dist/utils/security.d.ts +0 -5
  398. package/dist/utils/security.d.ts.map +0 -1
  399. package/dist/utils/security.js +0 -22
  400. package/dist/utils/security.js.map +0 -1
  401. package/dist/xulux/catalog-client.d.ts +0 -14
  402. package/dist/xulux/catalog-client.d.ts.map +0 -1
  403. package/dist/xulux/catalog-client.js +0 -67
  404. package/dist/xulux/catalog-client.js.map +0 -1
  405. package/dist/xulux/fallback-catalog.d.ts +0 -7
  406. package/dist/xulux/fallback-catalog.d.ts.map +0 -1
  407. package/dist/xulux/fallback-catalog.js +0 -47
  408. package/dist/xulux/fallback-catalog.js.map +0 -1
  409. package/dist/xulux/fetch-sandbox.d.ts +0 -5
  410. package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
  411. package/dist/xulux/fetch-sandbox.js +0 -40
  412. package/dist/xulux/fetch-sandbox.js.map +0 -1
  413. package/dist/xulux/template-service.d.ts +0 -84
  414. package/dist/xulux/template-service.d.ts.map +0 -1
  415. package/dist/xulux/template-service.js +0 -223
  416. package/dist/xulux/template-service.js.map +0 -1
  417. package/dist/xulux/types.d.ts +0 -55
  418. package/dist/xulux/types.d.ts.map +0 -1
  419. package/dist/xulux/types.js +0 -6
  420. package/dist/xulux/types.js.map +0 -1
  421. package/src/constants.ts +0 -24
  422. package/src/prepare-docs/code-examples.ts +0 -158
  423. package/src/prepare-docs/copy-raw.ts +0 -50
  424. package/src/prepare-docs/prepare.ts +0 -24
  425. package/src/prompts/xulux-playground.ts +0 -36
  426. package/src/tools/docs.ts +0 -255
  427. package/src/tools/examples.ts +0 -114
  428. package/src/tools/resources.ts +0 -111
  429. package/src/tools/search.ts +0 -46
  430. package/src/tools/tests/completions.test.ts +0 -60
  431. package/src/tools/tests/directory-size-cap.test.ts +0 -50
  432. package/src/tools/tests/docs.test.ts +0 -144
  433. package/src/tools/tests/examples.test.ts +0 -94
  434. package/src/tools/tests/integration.test.ts +0 -45
  435. package/src/tools/tests/json-parsing.test.ts +0 -23
  436. package/src/tools/tests/listings-cache.test.ts +0 -19
  437. package/src/tools/tests/mcp-protocol.test.ts +0 -216
  438. package/src/tools/tests/mcp-test-client.ts +0 -111
  439. package/src/tools/tests/path-traversal.test.ts +0 -81
  440. package/src/tools/tests/resources.test.ts +0 -133
  441. package/src/tools/tests/search.test.ts +0 -37
  442. package/src/tools/tests/test-setup.ts +0 -50
  443. package/src/tools/tests/xulux-templates.test.ts +0 -262
  444. package/src/tools/xulux-templates.ts +0 -141
  445. package/src/utils/cache.ts +0 -20
  446. package/src/utils/logger.ts +0 -20
  447. package/src/utils/mcp-format.ts +0 -14
  448. package/src/utils/mdx.ts +0 -59
  449. package/src/utils/paths.ts +0 -139
  450. package/src/utils/search.ts +0 -131
  451. package/src/utils/security.ts +0 -52
  452. package/src/utils/tests/cache.test.ts +0 -51
  453. package/src/utils/tests/mcp-format.test.ts +0 -22
  454. package/src/utils/tests/security.test.ts +0 -119
  455. package/src/xulux/catalog-client.ts +0 -105
  456. package/src/xulux/fallback-catalog.ts +0 -63
  457. package/src/xulux/fetch-sandbox.ts +0 -56
  458. package/src/xulux/template-service.ts +0 -406
  459. package/src/xulux/types.ts +0 -60
@@ -1,129 +0,0 @@
1
- ---
2
- title: Composer Trigger Hooks
3
- description: Unstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers.
4
- ---
5
-
6
- import { unstable_useLiveCompletionAdapter, unstable_useMentionAdapter, unstable_useSlashCommandAdapter } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### unstable_useTriggerPopoverRootContext
18
-
19
- ```ts
20
- const unstable_useTriggerPopoverRootContext: () => TriggerPopoverRootContextValue;
21
- ```
22
-
23
- ### unstable_useTriggerPopoverRootContextOptional
24
-
25
- ```ts
26
- const unstable_useTriggerPopoverRootContextOptional: () => TriggerPopoverRootContextValue | null;
27
- ```
28
-
29
- ### unstable_useTriggerPopoverScopeContext
30
-
31
- ```ts
32
- const unstable_useTriggerPopoverScopeContext: () => TriggerPopoverResourceOutput;
33
- ```
34
-
35
- ### unstable_useTriggerPopoverScopeContextOptional
36
-
37
- ```ts
38
- const unstable_useTriggerPopoverScopeContextOptional: () => TriggerPopoverResourceOutput | null;
39
- ```
40
-
41
- ### unstable_useTriggerPopoverTriggers
42
-
43
- Live map of registered triggers, re-rendering on change. Prefer
44
- `subscribeLifecycle` for incremental add/remove handling.
45
-
46
- ```ts
47
- const unstable_useTriggerPopoverTriggers: () => ReadonlyMap<string, RegisteredTrigger>;
48
- ```
49
-
50
- ### unstable_useTriggerPopoverTriggersOptional
51
-
52
- Like `useTriggerPopoverTriggers` but returns an empty map outside a root.
53
-
54
- ```ts
55
- const unstable_useTriggerPopoverTriggersOptional: () => ReadonlyMap<string, RegisteredTrigger>;
56
- ```
57
-
58
- ### unstable_useLiveCompletionAdapter
59
-
60
- <Callout type="tip">
61
- <strong>Experimental.</strong> Under active development and may change without notice.
62
- </Callout>
63
-
64
- Bridges an async completion source (a server search, a gateway RPC) into the
65
- synchronous `Unstable_TriggerAdapter` that `ComposerTriggerPopover` consumes.
66
- `search(query)` returns the last fetched items synchronously and schedules a
67
- debounced fetch when the query changes; when results arrive the returned
68
- `adapter` identity changes, which re-runs the popover's lookup so the fresh
69
- items render. This is a search-only adapter (`categories` are empty).
70
-
71
- `isLoading` is `true` while a fetch is in flight. Pass it to the popover's
72
- `isLoading` prop to render a loading state.
73
-
74
- ```tsx
75
- const mentions = unstable_useLiveCompletionAdapter({
76
- fetcher: (query) => searchUsers(query),
77
- });
78
-
79
- <ComposerTriggerPopover
80
- char="@"
81
- adapter={mentions.adapter}
82
- isLoading={mentions.isLoading}
83
- directive={{ onInserted }}
84
- />
85
- ```
86
-
87
- <ParametersTable {...unstable_useLiveCompletionAdapter} />
88
-
89
- ### unstable_useMentionAdapter
90
-
91
- <Callout type="tip">
92
- <strong>Experimental.</strong> Under active development and might change without notice.
93
- </Callout>
94
-
95
- Creates a spreadable `{ adapter, directive }` bundle for `@` mentions.
96
- Supports tools registered in model context, explicit items, or both —
97
- flat or categorized.
98
-
99
- ```tsx
100
- const mention = unstable_useMentionAdapter();
101
- <ComposerTriggerPopover char="@" {...mention} />
102
- ```
103
-
104
- <ParametersTable {...unstable_useMentionAdapter} />
105
-
106
- ### unstable_useSlashCommandAdapter
107
-
108
- <Callout type="tip">
109
- <strong>Experimental.</strong> Under active development and may change without notice.
110
- </Callout>
111
-
112
- Bundles slash command definitions (with inline `execute` callbacks) into
113
- `{adapter, action}` that plug directly into `ComposerTriggerPopover`.
114
- `execute` stays in the hook closure and is never attached to the returned
115
- `TriggerItem`, keeping items serializable.
116
-
117
- ```tsx
118
- const slash = unstable_useSlashCommandAdapter({
119
- commands: [
120
- { id: "summarize", execute: () => runSummarize(), icon: "FileText" },
121
- { id: "translate", execute: () => runTranslate(), icon: "Languages" },
122
- ],
123
- });
124
-
125
- <ComposerTriggerPopover char="/" {...slash} />
126
- ```
127
-
128
- <ParametersTable {...unstable_useSlashCommandAdapter} />
129
- {/* api-reference:end */}
@@ -1,31 +0,0 @@
1
- ---
2
- title: Hooks API Reference
3
- description: "React hooks for assistant-ui: useAui, useAuiState, runtime creation, model context registration, and helpers for building custom AI chat behavior."
4
- ---
5
-
6
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
7
- {/* The page list is generated from exported APIs; edit only the manual prose slot. */}
8
-
9
- {/* api-manual:start */}
10
- Hooks are the escape hatch and integration layer for React applications. Use them to read assistant state, call runtime actions, create runtimes, register model context, and connect custom components to assistant-ui behavior.
11
- {/* api-manual:end */}
12
-
13
- ## Pages
14
-
15
- <Cards>
16
- <Card title={"Composer Trigger Hooks"} href={"/docs/api-reference/hooks/composer-triggers"}>
17
- {"Unstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers."}
18
- </Card>
19
- <Card title={"Model Context Hooks"} href={"/docs/api-reference/hooks/model-context"}>
20
- {"React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers."}
21
- </Card>
22
- <Card title={"Primitive Hooks"} href={"/docs/api-reference/hooks/primitives"}>
23
- {"Primitive hooks for reading scoped assistant-ui runtime state, viewport behavior, timing, and message part data inside React components."}
24
- </Card>
25
- <Card title={"Runtime Hooks"} href={"/docs/api-reference/hooks/runtimes"}>
26
- {"Runtime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences."}
27
- </Card>
28
- <Card title={"State Hooks"} href={"/docs/api-reference/hooks/state"}>
29
- {"State selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and attachments."}
30
- </Card>
31
- </Cards>
@@ -1,34 +0,0 @@
1
- ---
2
- title: Model Context Hooks
3
- description: React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers.
4
- ---
5
-
6
- import { useAuiToolOverrides } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### useAuiToolOverrides
18
-
19
- <Callout type="tip">
20
- <strong>Experimental.</strong> Experimental, API may change.
21
- </Callout>
22
-
23
- Overrides toolkit entries for the current assistant scope.
24
-
25
- This is intended for dynamic local-state tools whose model-facing contract is
26
- declared in a `"use generative"` toolkit file with `execute: stubTool()`, but
27
- whose actual executor must close over React state in the mounted component.
28
- Keep the override keys stable after mount; dynamic key addition/removal is not
29
- currently observed.
30
- Overrides are registered at priority 1000, above toolkit defaults. Only one
31
- mounted override provider may define a given tool name at a time.
32
-
33
- <ParametersTable {...useAuiToolOverrides} />
34
- {/* api-reference:end */}
@@ -1,350 +0,0 @@
1
- ---
2
- title: Primitive Hooks
3
- description: Primitive hooks for reading scoped assistant-ui runtime state, viewport behavior, timing, and message part data inside React components.
4
- ---
5
-
6
- import { unstable_useComposerInput, unstable_useMessageStallDetection, useCloudThreadListAdapter, useMessagePartData, useScrollLock, useThreadViewportAutoScroll } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### useCloudThreadListAdapter
18
-
19
- <ParametersTable {...useCloudThreadListAdapter} />
20
-
21
- ### useMessageQuote
22
-
23
- Hook that returns the quote info for the current message, if any.
24
-
25
- Reads from `message.metadata.custom.quote`.
26
-
27
- ```tsx
28
- function QuoteBlock() {
29
- const quote = useMessageQuote();
30
- if (!quote) return null;
31
- return <blockquote>{quote.text}</blockquote>;
32
- }
33
- ```
34
-
35
- ```ts
36
- const useMessageQuote: () => QuoteInfo | undefined;
37
- ```
38
-
39
- ### useMessageTiming
40
-
41
- Hook that returns timing information for the current assistant message.
42
-
43
- Reads from `message.metadata.timing`.
44
-
45
- ```tsx
46
- function MessageStats() {
47
- const timing = useMessageTiming();
48
- if (!timing) return null;
49
- return <span>{timing.tokensPerSecond?.toFixed(1)} tok/s</span>;
50
- }
51
- ```
52
-
53
- ```ts
54
- const useMessageTiming: () => MessageTiming | undefined;
55
- ```
56
-
57
- ### useRuntimeAdapters
58
-
59
- ```ts
60
- type RuntimeAdapters = {
61
- modelContext?: ModelContextProvider | undefined;
62
- history?: ThreadHistoryAdapter | undefined;
63
- attachments?: AttachmentAdapter | undefined;
64
- };
65
-
66
- const useRuntimeAdapters: () => RuntimeAdapters | null;
67
- ```
68
-
69
- ### useScrollLock
70
-
71
- Locks scroll position during collapsible/height animations and hides scrollbar.
72
-
73
- This utility prevents page jumps when content height changes during animations,
74
- providing a smooth user experience. It finds the nearest scrollable ancestor and
75
- temporarily locks its scroll position while the animation completes.
76
-
77
- - Prevents forced reflows: no layout reads, mutations scoped to scrollable parent only
78
- - Reactive: only intercepts scroll events when browser actually adjusts
79
- - Cleans up automatically after animation duration
80
-
81
- ```tsx
82
- const collapsibleRef = useRef<HTMLDivElement>(null);
83
- const lockScroll = useScrollLock(collapsibleRef, 200);
84
-
85
- const handleCollapse = () => {
86
- lockScroll(); // Lock scroll before collapsing
87
- setIsOpen(false);
88
- };
89
- ```
90
-
91
- <ParametersTable {...useScrollLock} />
92
-
93
- ### useThreadViewport
94
-
95
- ```ts
96
- const useThreadViewport: { (): ThreadViewportState; <TSelected>(selector: (state: ThreadViewportState) => TSelected): TSelected; (options: { optional: true; }): ThreadViewportState | null; <TSelected>(options: { optional: true; selector?: (state: ThreadViewportState) => TSelected; }): TSelected | null; };
97
- ```
98
-
99
- ### useThreadViewportAutoScroll
100
-
101
- <ParametersTable {...useThreadViewportAutoScroll} />
102
-
103
- ### useThreadViewportStore
104
-
105
- ```ts
106
- const useThreadViewportStore: { (): ReadonlyStore<ThreadViewportState>; (options: { optional: true; }): ReadonlyStore<ThreadViewportState> | null; };
107
- ```
108
-
109
- ### unstable_useComposerInput
110
-
111
- <Callout type="tip">
112
- <strong>Experimental.</strong> Under active development and might change without notice.
113
- </Callout>
114
-
115
- Headless bridge to the composer's text value and send action, for building a
116
- custom composer input without `ComposerPrimitive.Input`. It is a thin bridge,
117
- not a second input: it does not own keyboard behavior, autosize, IME or
118
- contentEditable sync, paste/drop attachments, focus management, or rich-text
119
- state. Spread `unstable_useTriggerPopoverAriaProps()` onto your element for
120
- trigger-popover combobox semantics.
121
-
122
- ```tsx
123
- const { value, setText, send, isDisabled, canSend } = unstable_useComposerInput();
124
- <textarea
125
- value={value}
126
- disabled={isDisabled}
127
- onChange={(e) => setText(e.target.value)}
128
- onKeyDown={(e) => {
129
- if (e.key === "Enter" && !e.shiftKey && canSend) {
130
- e.preventDefault();
131
- send();
132
- }
133
- }}
134
- />
135
- ```
136
-
137
- <ParametersTable {...unstable_useComposerInput} />
138
-
139
- ### unstable_useComposerInputHistory
140
-
141
- <Callout type="tip">
142
- <strong>Experimental.</strong> Under active development and might change without notice.
143
- </Callout>
144
-
145
- Terminal-style input history for the thread composer: ArrowUp on an
146
- empty draft recalls previously sent user messages (newest first),
147
- ArrowDown steps back toward the newest and finally restores the draft
148
- that was being typed when browsing started.
149
-
150
- Recall only triggers when the caret is on the first/last line with no
151
- selection, so multi-line editing keeps native arrow behavior. The
152
- handler yields to an open mention/slash popover, to IME composition,
153
- to modifier keys, and to consumer handlers that already called
154
- `preventDefault`. It is inert on edit composers.
155
-
156
- ```tsx
157
- const history = unstable_useComposerInputHistory();
158
- <ComposerPrimitive.Input {...history} />
159
- ```
160
-
161
- ```ts
162
- function unstable_useComposerInputHistory(): Unstable_ComposerInputHistory;
163
- ```
164
-
165
- ### unstable_useMessageStallDetection
166
-
167
- <Callout type="tip">
168
- <strong>Experimental.</strong> Under active development and might change without notice.
169
- </Callout>
170
-
171
- Detects mid-run output stalls on the current message: while the message is
172
- running, watches a fingerprint of its content (part count plus text,
173
- argument, and result sizes) and reports a stall once the fingerprint stops
174
- changing for `thresholdMs`. Useful for re-surfacing a "still working"
175
- indicator during tool think-time or provider stalls, after the first
176
- tokens have already streamed.
177
-
178
- Must be used inside a message scope.
179
-
180
- <ParametersTable {...unstable_useMessageStallDetection} />
181
-
182
- ### unstable_useThreadMessageIds
183
-
184
- <Callout type="tip">
185
- <strong>Experimental.</strong> Unstable / Experimental - may change in any release.
186
- </Callout>
187
-
188
- Returns the ids of the messages in the current thread, in order.
189
-
190
- The returned array keeps a stable identity across content-only updates (e.g.
191
- streaming), changing reference only when the id sequence itself changes. Pair
192
- with `ThreadPrimitive.Unstable_MessageById` to drive a virtualized or custom
193
- message list.
194
-
195
- ```ts
196
- const unstable_useThreadMessageIds: () => readonly string[];
197
- ```
198
-
199
- ### unstable_useTriggerPopoverAriaProps
200
-
201
- <Callout type="tip">
202
- <strong>Experimental.</strong> Under active development and might change without notice.
203
- </Callout>
204
-
205
- ARIA combobox attributes for the focused element (typically the composer
206
- input) describing the open trigger popover, per the WAI-ARIA editable
207
- combobox pattern. Returns an empty object outside a `TriggerPopoverRoot` or
208
- when no popover is open. Spread these last so they take precedence over any
209
- matching ARIA props you set yourself, mirroring `ComposerPrimitive.Input`.
210
-
211
- ```tsx
212
- const aria = unstable_useTriggerPopoverAriaProps();
213
- <textarea {...aria} />
214
- ```
215
-
216
- ```ts
217
- function unstable_useTriggerPopoverAriaProps(): Unstable_TriggerPopoverAriaProps;
218
- ```
219
-
220
- ### useMessagePartData
221
-
222
- <Callout type="warn">
223
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
224
- Return `null` for optional rendering. Do not throw inside the selector:
225
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
226
- part mismatch during thread switches can unmount the React root.
227
- </Callout>
228
-
229
- ```tsx
230
- const part = useAuiState((s) =>
231
- s.part.type === "data" && (!name || s.part.name === name)
232
- ? s.part
233
- : null,
234
- );
235
- ```
236
-
237
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
238
-
239
- <ParametersTable {...useMessagePartData} />
240
-
241
- ### useMessagePartFile
242
-
243
- <Callout type="warn">
244
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
245
- Return `null` for optional rendering. Do not throw inside the selector:
246
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
247
- part mismatch during thread switches can unmount the React root.
248
- </Callout>
249
-
250
- ```tsx
251
- const file = useAuiState((s) => {
252
- if (s.part.type !== "file") return null;
253
- return s.part;
254
- });
255
- ```
256
-
257
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
258
-
259
- ```ts
260
- const useMessagePartFile: () => FileMessagePart & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; };
261
- ```
262
-
263
- ### useMessagePartImage
264
-
265
- <Callout type="warn">
266
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
267
- Return `null` for optional rendering. Do not throw inside the selector:
268
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
269
- part mismatch during thread switches can unmount the React root.
270
- </Callout>
271
-
272
- ```tsx
273
- const image = useAuiState((s) => {
274
- if (s.part.type !== "image") return null;
275
- return s.part;
276
- });
277
- ```
278
-
279
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
280
-
281
- ```ts
282
- const useMessagePartImage: () => ImageMessagePart & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; };
283
- ```
284
-
285
- ### useMessagePartReasoning
286
-
287
- <Callout type="warn">
288
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
289
- Return `null` for optional rendering. Do not throw inside the selector:
290
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
291
- part mismatch during thread switches can unmount the React root.
292
- </Callout>
293
-
294
- ```tsx
295
- const reasoning = useAuiState((s) => {
296
- if (s.part.type !== "reasoning") return null;
297
- return s.part;
298
- });
299
- ```
300
-
301
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
302
-
303
- ```ts
304
- const useMessagePartReasoning: () => ReasoningMessagePart & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; };
305
- ```
306
-
307
- ### useMessagePartSource
308
-
309
- <Callout type="warn">
310
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
311
- Return `null` for optional rendering. Do not throw inside the selector:
312
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
313
- part mismatch during thread switches can unmount the React root.
314
- </Callout>
315
-
316
- ```tsx
317
- const source = useAuiState((s) => {
318
- if (s.part.type !== "source") return null;
319
- return s.part;
320
- });
321
- ```
322
-
323
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
324
-
325
- ```ts
326
- const useMessagePartSource: () => ({ readonly type: "source"; readonly sourceType: "url"; readonly id: string; readonly url: string; readonly title?: string; readonly providerMetadata?: SourceProviderMetadata; readonly parentId?: string; } & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; }) | ({ readonly type: "source"; readonly sourceType: "document"; readonly id: string; readonly url?: undefined; readonly title: string; readonly mediaType: string; readonly filename?: string; readonly providerMetadata?: SourceProviderMetadata; readonly parentId?: string; } & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; });
327
- ```
328
-
329
- ### useMessagePartText
330
-
331
- <Callout type="warn">
332
- <strong>Deprecated.</strong> Use [useAuiState](/docs/api-reference/hooks/state#useauistate) to select and narrow `s.part`.
333
- Return `null` for optional rendering. Do not throw inside the selector:
334
- selectors run inside `useSyncExternalStore`'s `getSnapshot`, so a transient
335
- part mismatch during thread switches can unmount the React root.
336
- </Callout>
337
-
338
- ```tsx
339
- const text = useAuiState((s) => {
340
- if (s.part.type !== "text" && s.part.type !== "reasoning") return null;
341
- return s.part;
342
- });
343
- ```
344
-
345
- See the [migration guide](https://assistant-ui.com/docs/migrations/v0-12).
346
-
347
- ```ts
348
- const useMessagePartText: () => (TextMessagePart & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; }) | (ReasoningMessagePart & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; });
349
- ```
350
- {/* api-reference:end */}
@@ -1,28 +0,0 @@
1
- ---
2
- title: Runtime Hooks
3
- description: Runtime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences.
4
- ---
5
-
6
- import { useCloudThreadListRuntime, useLocalRuntime, useRemoteThreadListRuntime } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### useCloudThreadListRuntime
18
-
19
- <ParametersTable {...useCloudThreadListRuntime} />
20
-
21
- ### useLocalRuntime
22
-
23
- <ParametersTable {...useLocalRuntime} />
24
-
25
- ### useRemoteThreadListRuntime
26
-
27
- <ParametersTable {...useRemoteThreadListRuntime} />
28
- {/* api-reference:end */}
@@ -1,97 +0,0 @@
1
- ---
2
- title: State Hooks
3
- description: State selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and attachments.
4
- ---
5
-
6
- import { useAuiEvent, useAuiState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### useAui
18
-
19
- Returns the current `AssistantClient` from context.
20
-
21
- Read the client supplied by the nearest [AuiProvider](/docs/api-reference/context-providers/assistant-runtime-provider#auiprovider) or
22
- [AssistantRuntimeProvider](/docs/api-reference/context-providers/assistant-runtime-provider#assistantruntimeprovider), then access a scope on it —
23
- `aui.thread`, `aui.composer`, `aui.message`, and so on. Pair
24
- with [useAuiState](/docs/api-reference/hooks/state#useauistate) to read reactive state and [useAuiEvent](/docs/api-reference/hooks/state#useauievent)
25
- to subscribe to events. The returned client also exposes lower-level
26
- methods such as `aui.on(...)` and `aui.subscribe(...)`; prefer
27
- `useAuiEvent` for React event subscriptions.
28
-
29
- Rendered outside a provider, the returned client's scope accessors
30
- throw a descriptive error whenever they are called.
31
-
32
- {/* api-example:useAui:start */}
33
- ```tsx
34
- import { useAui } from "@assistant-ui/react";
35
-
36
- const aui = useAui();
37
-
38
- aui.composer().setText("Hello");
39
- aui.composer().send();
40
- aui.thread().cancelRun();
41
- ```
42
- {/* api-example:useAui:end */}
43
-
44
- ```ts
45
- function useAui(): AssistantClient;
46
- ```
47
-
48
- ### useAuiEvent
49
-
50
- Subscribes to an assistant event for the lifetime of the component.
51
-
52
- The subscription is established on mount and re-established whenever the
53
- scope or event name changes. The `callback` is wrapped in an effect-event
54
- shim, so the latest closure is invoked on each emission — you do not
55
- need to memoize it.
56
-
57
- {/* api-example:useAuiEvent:start */}
58
- ```tsx
59
- import { useAuiEvent } from "@assistant-ui/react";
60
-
61
- useAuiEvent("thread.modelContextUpdate", ({ threadId }) => {
62
- console.log("Model context updated", threadId);
63
- });
64
- ```
65
- {/* api-example:useAuiEvent:end */}
66
-
67
- <ParametersTable {...useAuiEvent} />
68
-
69
- ### useAuiState
70
-
71
- Subscribes to a slice of [AssistantState](/docs/api-reference/primitives/assistant-if#assistantstate) and re-renders the
72
- component whenever that slice changes.
73
-
74
- The `selector` is called on every store update; its return value is
75
- compared by `Object.is`, and the component re-renders only when the
76
- selected slice changes. Returning the entire state object is not
77
- supported and throws at runtime — select a specific field instead, or
78
- compose multiple `useAuiState` calls. Returning a new object or array
79
- literal, including spreading `s.thread` into a new object, causes a
80
- re-render on every store update; either select primitives or return a
81
- memoized reference.
82
-
83
- Scopes that may be unavailable can be read via `s.optional.<scope>`,
84
- which resolves to `undefined` instead of throwing.
85
-
86
- {/* api-example:useAuiState:start */}
87
- ```tsx
88
- import { useAuiState } from "@assistant-ui/react";
89
-
90
- const messages = useAuiState((s) => s.thread.messages);
91
- const isRunning = useAuiState((s) => s.thread.isRunning);
92
- const composerText = useAuiState((s) => s.composer.text);
93
- ```
94
- {/* api-example:useAuiState:end */}
95
-
96
- <ParametersTable {...useAuiState} />
97
- {/* api-reference:end */}
@@ -1,24 +0,0 @@
1
- ---
2
- title: "@assistant-ui/cloud-ai-sdk"
3
- description: Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes.
4
- ---
5
-
6
- import { cloudAiSdk_useCloudChat, cloudAiSdk_useThreads } from "@/generated/integrationTypeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### useCloudChat
18
-
19
- <ParametersTable {...cloudAiSdk_useCloudChat} />
20
-
21
- ### useThreads
22
-
23
- <ParametersTable {...cloudAiSdk_useThreads} />
24
- {/* api-reference:end */}