@assistant-ui/mcp-docs-server 0.2.3 → 0.3.1

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 (452) 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 +91 -0
  9. package/dist/proxy.js.map +1 -0
  10. package/package.json +8 -12
  11. package/src/index.ts +3 -115
  12. package/src/proxy.test.ts +385 -0
  13. package/src/proxy.ts +126 -0
  14. package/.docs/organized/code-examples/waterfall.md +0 -807
  15. package/.docs/organized/code-examples/with-a2a.md +0 -675
  16. package/.docs/organized/code-examples/with-ag-ui.md +0 -553
  17. package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -466
  18. package/.docs/organized/code-examples/with-artifacts.md +0 -815
  19. package/.docs/organized/code-examples/with-assistant-transport.md +0 -576
  20. package/.docs/organized/code-examples/with-browser-extension.md +0 -371
  21. package/.docs/organized/code-examples/with-chain-of-thought.md +0 -962
  22. package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
  23. package/.docs/organized/code-examples/with-cloud.md +0 -439
  24. package/.docs/organized/code-examples/with-custom-thread-list.md +0 -569
  25. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -527
  26. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -697
  27. package/.docs/organized/code-examples/with-eve.md +0 -405
  28. package/.docs/organized/code-examples/with-expo.md +0 -2246
  29. package/.docs/organized/code-examples/with-external-store.md +0 -421
  30. package/.docs/organized/code-examples/with-ffmpeg.md +0 -829
  31. package/.docs/organized/code-examples/with-generative-ui.md +0 -1810
  32. package/.docs/organized/code-examples/with-google-adk.md +0 -368
  33. package/.docs/organized/code-examples/with-heat-graph.md +0 -304
  34. package/.docs/organized/code-examples/with-image-generation.md +0 -463
  35. package/.docs/organized/code-examples/with-interactables.md +0 -733
  36. package/.docs/organized/code-examples/with-langchain.md +0 -446
  37. package/.docs/organized/code-examples/with-langgraph.md +0 -855
  38. package/.docs/organized/code-examples/with-livekit.md +0 -643
  39. package/.docs/organized/code-examples/with-mcp.md +0 -782
  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 -450
  43. package/.docs/organized/code-examples/with-pi.md +0 -2084
  44. package/.docs/organized/code-examples/with-react-hook-form.md +0 -727
  45. package/.docs/organized/code-examples/with-react-ink-web.md +0 -740
  46. package/.docs/organized/code-examples/with-react-ink.md +0 -473
  47. package/.docs/organized/code-examples/with-react-router.md +0 -936
  48. package/.docs/organized/code-examples/with-resumable-stream.md +0 -668
  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 -812
  53. package/.docs/organized/code-examples/with-tap-runtime.md +0 -813
  54. package/.docs/organized/code-examples/with-virtualized-thread.md +0 -681
  55. package/.docs/organized/code-examples/with-vue.md +0 -408
  56. package/.docs/raw/docs/(getting-started)/architecture.mdx +0 -146
  57. package/.docs/raw/docs/(getting-started)/base-ui.mdx +0 -39
  58. package/.docs/raw/docs/(getting-started)/cli.mdx +0 -542
  59. package/.docs/raw/docs/(getting-started)/devtools.mdx +0 -79
  60. package/.docs/raw/docs/(getting-started)/index.mdx +0 -23
  61. package/.docs/raw/docs/(getting-started)/installation.mdx +0 -483
  62. package/.docs/raw/docs/(getting-started)/llm.mdx +0 -211
  63. package/.docs/raw/docs/(getting-started)/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 -26
  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 -57
  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/ai-sdk.mdx +0 -200
  94. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
  95. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -118
  96. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
  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 -637
  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 -152
  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 -604
  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 -411
  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 -215
  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 -237
  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.mdx +0 -283
  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 -976
  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 -267
  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 -731
  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 -363
  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 -1020
  289. package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
  290. package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
  291. package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
  292. package/.docs/raw/docs/ui/attachment.mdx +0 -279
  293. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -247
  294. package/.docs/raw/docs/ui/context-display.mdx +0 -148
  295. package/.docs/raw/docs/ui/directive-text.mdx +0 -114
  296. package/.docs/raw/docs/ui/file.mdx +0 -159
  297. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
  298. package/.docs/raw/docs/ui/image.mdx +0 -102
  299. package/.docs/raw/docs/ui/markdown.mdx +0 -103
  300. package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
  301. package/.docs/raw/docs/ui/mermaid.mdx +0 -92
  302. package/.docs/raw/docs/ui/message-timing.mdx +0 -93
  303. package/.docs/raw/docs/ui/model-selector.mdx +0 -455
  304. package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
  305. package/.docs/raw/docs/ui/quote.mdx +0 -211
  306. package/.docs/raw/docs/ui/reasoning.mdx +0 -214
  307. package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
  308. package/.docs/raw/docs/ui/sources.mdx +0 -186
  309. package/.docs/raw/docs/ui/streamdown.mdx +0 -392
  310. package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
  311. package/.docs/raw/docs/ui/thread-list.mdx +0 -411
  312. package/.docs/raw/docs/ui/thread.mdx +0 -559
  313. package/.docs/raw/docs/ui/tool-fallback.mdx +0 -141
  314. package/.docs/raw/docs/ui/tool-group.mdx +0 -240
  315. package/.docs/raw/docs/ui/voice.mdx +0 -173
  316. package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
  317. package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
  318. package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
  319. package/dist/constants.d.ts +0 -14
  320. package/dist/constants.d.ts.map +0 -1
  321. package/dist/constants.js +0 -19
  322. package/dist/constants.js.map +0 -1
  323. package/dist/prepare-docs/code-examples.d.ts +0 -5
  324. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  325. package/dist/prepare-docs/code-examples.js +0 -117
  326. package/dist/prepare-docs/code-examples.js.map +0 -1
  327. package/dist/prepare-docs/copy-raw.d.ts +0 -5
  328. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  329. package/dist/prepare-docs/copy-raw.js +0 -49
  330. package/dist/prepare-docs/copy-raw.js.map +0 -1
  331. package/dist/prepare-docs/prepare.d.ts +0 -1
  332. package/dist/prepare-docs/prepare.js +0 -22
  333. package/dist/prepare-docs/prepare.js.map +0 -1
  334. package/dist/prompts/xulux-playground.d.ts +0 -12
  335. package/dist/prompts/xulux-playground.d.ts.map +0 -1
  336. package/dist/prompts/xulux-playground.js +0 -33
  337. package/dist/prompts/xulux-playground.js.map +0 -1
  338. package/dist/tools/docs.d.ts +0 -22
  339. package/dist/tools/docs.d.ts.map +0 -1
  340. package/dist/tools/docs.js +0 -177
  341. package/dist/tools/docs.js.map +0 -1
  342. package/dist/tools/examples.d.ts +0 -24
  343. package/dist/tools/examples.d.ts.map +0 -1
  344. package/dist/tools/examples.js +0 -87
  345. package/dist/tools/examples.js.map +0 -1
  346. package/dist/tools/resources.d.ts +0 -6
  347. package/dist/tools/resources.d.ts.map +0 -1
  348. package/dist/tools/resources.js +0 -75
  349. package/dist/tools/resources.js.map +0 -1
  350. package/dist/tools/search.d.ts +0 -24
  351. package/dist/tools/search.d.ts.map +0 -1
  352. package/dist/tools/search.js +0 -39
  353. package/dist/tools/search.js.map +0 -1
  354. package/dist/tools/tests/mcp-test-client.d.ts +0 -15
  355. package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
  356. package/dist/tools/tests/mcp-test-client.js +0 -68
  357. package/dist/tools/tests/mcp-test-client.js.map +0 -1
  358. package/dist/tools/tests/test-setup.d.ts +0 -7
  359. package/dist/tools/tests/test-setup.d.ts.map +0 -1
  360. package/dist/tools/tests/test-setup.js +0 -36
  361. package/dist/tools/tests/test-setup.js.map +0 -1
  362. package/dist/tools/xulux-templates.d.ts +0 -58
  363. package/dist/tools/xulux-templates.d.ts.map +0 -1
  364. package/dist/tools/xulux-templates.js +0 -84
  365. package/dist/tools/xulux-templates.js.map +0 -1
  366. package/dist/utils/cache.d.ts +0 -5
  367. package/dist/utils/cache.d.ts.map +0 -1
  368. package/dist/utils/cache.js +0 -18
  369. package/dist/utils/cache.js.map +0 -1
  370. package/dist/utils/logger.d.ts +0 -10
  371. package/dist/utils/logger.d.ts.map +0 -1
  372. package/dist/utils/logger.js +0 -20
  373. package/dist/utils/logger.js.map +0 -1
  374. package/dist/utils/mcp-format.d.ts +0 -11
  375. package/dist/utils/mcp-format.d.ts.map +0 -1
  376. package/dist/utils/mcp-format.js +0 -14
  377. package/dist/utils/mcp-format.js.map +0 -1
  378. package/dist/utils/mdx.d.ts +0 -12
  379. package/dist/utils/mdx.d.ts.map +0 -1
  380. package/dist/utils/mdx.js +0 -45
  381. package/dist/utils/mdx.js.map +0 -1
  382. package/dist/utils/paths.d.ts +0 -12
  383. package/dist/utils/paths.d.ts.map +0 -1
  384. package/dist/utils/paths.js +0 -93
  385. package/dist/utils/paths.js.map +0 -1
  386. package/dist/utils/search.d.ts +0 -10
  387. package/dist/utils/search.d.ts.map +0 -1
  388. package/dist/utils/search.js +0 -97
  389. package/dist/utils/search.js.map +0 -1
  390. package/dist/utils/security.d.ts +0 -5
  391. package/dist/utils/security.d.ts.map +0 -1
  392. package/dist/utils/security.js +0 -22
  393. package/dist/utils/security.js.map +0 -1
  394. package/dist/xulux/catalog-client.d.ts +0 -14
  395. package/dist/xulux/catalog-client.d.ts.map +0 -1
  396. package/dist/xulux/catalog-client.js +0 -112
  397. package/dist/xulux/catalog-client.js.map +0 -1
  398. package/dist/xulux/fallback-catalog.d.ts +0 -7
  399. package/dist/xulux/fallback-catalog.d.ts.map +0 -1
  400. package/dist/xulux/fallback-catalog.js +0 -47
  401. package/dist/xulux/fallback-catalog.js.map +0 -1
  402. package/dist/xulux/fetch-sandbox.d.ts +0 -5
  403. package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
  404. package/dist/xulux/fetch-sandbox.js +0 -40
  405. package/dist/xulux/fetch-sandbox.js.map +0 -1
  406. package/dist/xulux/template-service.d.ts +0 -84
  407. package/dist/xulux/template-service.d.ts.map +0 -1
  408. package/dist/xulux/template-service.js +0 -223
  409. package/dist/xulux/template-service.js.map +0 -1
  410. package/dist/xulux/types.d.ts +0 -55
  411. package/dist/xulux/types.d.ts.map +0 -1
  412. package/dist/xulux/types.js +0 -6
  413. package/dist/xulux/types.js.map +0 -1
  414. package/src/constants.ts +0 -24
  415. package/src/prepare-docs/code-examples.ts +0 -158
  416. package/src/prepare-docs/copy-raw.ts +0 -50
  417. package/src/prepare-docs/prepare.ts +0 -24
  418. package/src/prompts/xulux-playground.ts +0 -36
  419. package/src/tools/docs.ts +0 -255
  420. package/src/tools/examples.ts +0 -114
  421. package/src/tools/resources.ts +0 -111
  422. package/src/tools/search.ts +0 -46
  423. package/src/tools/tests/completions.test.ts +0 -60
  424. package/src/tools/tests/directory-size-cap.test.ts +0 -50
  425. package/src/tools/tests/docs.test.ts +0 -147
  426. package/src/tools/tests/examples.test.ts +0 -94
  427. package/src/tools/tests/integration.test.ts +0 -45
  428. package/src/tools/tests/json-parsing.test.ts +0 -23
  429. package/src/tools/tests/listings-cache.test.ts +0 -19
  430. package/src/tools/tests/mcp-protocol.test.ts +0 -216
  431. package/src/tools/tests/mcp-test-client.ts +0 -111
  432. package/src/tools/tests/path-traversal.test.ts +0 -84
  433. package/src/tools/tests/resources.test.ts +0 -133
  434. package/src/tools/tests/search.test.ts +0 -37
  435. package/src/tools/tests/test-setup.ts +0 -50
  436. package/src/tools/tests/xulux-templates.test.ts +0 -325
  437. package/src/tools/xulux-templates.ts +0 -141
  438. package/src/utils/cache.ts +0 -20
  439. package/src/utils/logger.ts +0 -20
  440. package/src/utils/mcp-format.ts +0 -14
  441. package/src/utils/mdx.ts +0 -59
  442. package/src/utils/paths.ts +0 -139
  443. package/src/utils/search.ts +0 -131
  444. package/src/utils/security.ts +0 -52
  445. package/src/utils/tests/cache.test.ts +0 -51
  446. package/src/utils/tests/mcp-format.test.ts +0 -22
  447. package/src/utils/tests/security.test.ts +0 -119
  448. package/src/xulux/catalog-client.ts +0 -150
  449. package/src/xulux/fallback-catalog.ts +0 -63
  450. package/src/xulux/fetch-sandbox.ts +0 -56
  451. package/src/xulux/template-service.ts +0 -406
  452. package/src/xulux/types.ts +0 -64
@@ -1,65 +0,0 @@
1
- ---
2
- title: ErrorPrimitive
3
- description: Error primitives for rendering assistant-ui runtime, thread, and message failures inside custom chat interfaces.
4
- ---
5
-
6
- import { ErrorPrimitiveMessageProps, ErrorPrimitiveRootProps } from "@/generated/typeDocs";
7
- import { ErrorPrimitive as ErrorPrimitiveDocs } from "@/generated/primitiveDocs";
8
-
9
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
- {/* Do not edit manually. */}
11
-
12
- For examples and usage patterns, see [Error](/docs/primitives/error).
13
-
14
- {/* api-manual:start */}
15
- ## Anatomy
16
-
17
- ```tsx
18
- import { ErrorPrimitive } from "@assistant-ui/react";
19
-
20
- const ErrorDisplay = () => (
21
- <ErrorPrimitive.Root>
22
- <ErrorPrimitive.Message />
23
- </ErrorPrimitive.Root>
24
- );
25
- ```
26
- {/* api-manual:end */}
27
-
28
- {/* api-reference:start */}
29
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
30
- {/* Do not edit this block manually. */}
31
-
32
- ## API Reference
33
-
34
- ### Root
35
-
36
- {ErrorPrimitiveDocs.Root?.deprecated && (
37
- <Callout type="warn">
38
- <strong>Deprecated.</strong> {ErrorPrimitiveDocs.Root.deprecated}
39
- </Callout>
40
- )}
41
-
42
- {ErrorPrimitiveDocs.Root?.description}
43
-
44
- {ErrorPrimitiveDocs.Root?.element && (
45
- <p>This primitive renders a <code>{`<${ErrorPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
46
- )}
47
-
48
- <ParametersTable {...ErrorPrimitiveRootProps} />
49
-
50
- ### Message
51
-
52
- {ErrorPrimitiveDocs.Message?.deprecated && (
53
- <Callout type="warn">
54
- <strong>Deprecated.</strong> {ErrorPrimitiveDocs.Message.deprecated}
55
- </Callout>
56
- )}
57
-
58
- {ErrorPrimitiveDocs.Message?.description}
59
-
60
- {ErrorPrimitiveDocs.Message?.element && (
61
- <p>This primitive renders a <code>{`<${ErrorPrimitiveDocs.Message?.element}>`}</code> element unless <code>asChild</code> is set.</p>
62
- )}
63
-
64
- <ParametersTable {...ErrorPrimitiveMessageProps} />
65
- {/* api-reference:end */}
@@ -1,73 +0,0 @@
1
- ---
2
- title: Primitives API Reference
3
- description: "Composable React primitives for assistant-ui chat UIs: Thread, Composer, Message, BranchPicker, ActionBar, and the parts that build threads, message lists, attachments, and editing flows."
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
- Primitives are the low-level React components behind assistant-ui interfaces. They provide accessible behavior, state wiring, and composition points while leaving layout and styling under your control.
11
- {/* api-manual:end */}
12
-
13
- ## Pages
14
-
15
- <Cards>
16
- <Card title={"ActionBarPrimitive"} href={"/docs/api-reference/primitives/action-bar"}>
17
- {"Composable message action controls for copy, edit, reload, speech, and feedback in assistant-ui chat interfaces."}
18
- </Card>
19
- <Card title={"ActionBarMorePrimitive"} href={"/docs/api-reference/primitives/action-bar-more"}>
20
- {"Overflow menu primitives for grouping secondary assistant message actions in a custom React UI."}
21
- </Card>
22
- <Card title={"AuiIf"} href={"/docs/api-reference/primitives/assistant-if"}>
23
- {"Conditional rendering primitive for showing React UI from assistant-ui thread, message, composer, and runtime state."}
24
- </Card>
25
- <Card title={"AssistantModalPrimitive"} href={"/docs/api-reference/primitives/assistant-modal"}>
26
- {"Floating assistant modal primitives for building support chat, copilot, and embedded assistant experiences."}
27
- </Card>
28
- <Card title={"AttachmentPrimitive"} href={"/docs/api-reference/primitives/attachment"}>
29
- {"Attachment primitives for rendering file previews, names, thumbnails, and remove controls in assistant-ui messages and composers."}
30
- </Card>
31
- <Card title={"BranchPickerPrimitive"} href={"/docs/api-reference/primitives/branch-picker"}>
32
- {"Branch picker primitives for navigating regenerated assistant responses and alternate message paths inside a chat thread."}
33
- </Card>
34
- <Card title={"ChainOfThoughtPrimitive"} href={"/docs/api-reference/primitives/chain-of-thought"}>
35
- {"Chain of thought primitives for rendering assistant reasoning, step lists, and collapsible disclosure UI in message content."}
36
- </Card>
37
- <Card title={"ComposerPrimitive"} href={"/docs/api-reference/primitives/composer"}>
38
- {"Composable input primitives for assistant-ui prompts, send controls, cancellation, attachments, and composer state."}
39
- </Card>
40
- <Card title={"Composition"} href={"/docs/api-reference/primitives/composition"}>
41
- {"How to compose primitives with custom components using asChild."}
42
- </Card>
43
- <Card title={"ErrorPrimitive"} href={"/docs/api-reference/primitives/error"}>
44
- {"Error primitives for rendering assistant-ui runtime, thread, and message failures inside custom chat interfaces."}
45
- </Card>
46
- <Card title={"MessagePrimitive"} href={"/docs/api-reference/primitives/message"}>
47
- {"Message primitives for rendering assistant and user turns, message parts, attachments, actions, editing, and branch controls."}
48
- </Card>
49
- <Card title={"MessagePartPrimitive"} href={"/docs/api-reference/primitives/message-part"}>
50
- {"Message part primitives for rendering text, tool calls, data parts, reasoning, source content, and custom assistant output."}
51
- </Card>
52
- <Card title={"QueueItemPrimitive"} href={"/docs/api-reference/primitives/queue-item"}>
53
- {"Queue item primitives for rendering pending assistant-ui thread operations, optimistic work, and runtime queue state."}
54
- </Card>
55
- <Card title={"SelectionToolbarPrimitive"} href={"/docs/api-reference/primitives/selection-toolbar"}>
56
- {"Selection toolbar primitives for quote, copy, and contextual actions on selected chat text."}
57
- </Card>
58
- <Card title={"SuggestionPrimitive"} href={"/docs/api-reference/primitives/suggestion"}>
59
- {"Suggestion primitives for rendering starter prompts, follow-up actions, and composer suggestions in assistant-ui threads."}
60
- </Card>
61
- <Card title={"ThreadPrimitive"} href={"/docs/api-reference/primitives/thread"}>
62
- {"Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui."}
63
- </Card>
64
- <Card title={"ThreadListPrimitive"} href={"/docs/api-reference/primitives/thread-list"}>
65
- {"Thread list primitives for rendering conversation navigation, new thread actions, and custom assistant sidebars."}
66
- </Card>
67
- <Card title={"ThreadListItemPrimitive"} href={"/docs/api-reference/primitives/thread-list-item"}>
68
- {"Thread list item primitives for rendering selectable conversation rows with titles, archive controls, delete actions, and menus."}
69
- </Card>
70
- <Card title={"ThreadListItemMorePrimitive"} href={"/docs/api-reference/primitives/thread-list-item-more"}>
71
- {"Overflow menu primitives for secondary thread list item actions in custom assistant-ui sidebars."}
72
- </Card>
73
- </Cards>
@@ -1,117 +0,0 @@
1
- ---
2
- title: MessagePartPrimitive
3
- description: Message part primitives for rendering text, tool calls, data parts, reasoning, source content, and custom assistant output.
4
- ---
5
-
6
- import { MessagePartPrimitiveImageProps, MessagePartPrimitiveMessagesProps, MessagePartPrimitiveTextProps } from "@/generated/typeDocs";
7
- import { MessagePartPrimitive as MessagePartPrimitiveDocs } from "@/generated/primitiveDocs";
8
-
9
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
- {/* Do not edit manually. */}
11
-
12
- {/* api-manual:start */}
13
- ## Anatomy
14
-
15
- ```tsx
16
- import { MessagePartPrimitive } from "@assistant-ui/react";
17
-
18
- const TextMessagePart = () => {
19
- return <MessagePartPrimitive.Text />;
20
- };
21
- ```
22
- {/* api-manual:end */}
23
-
24
- {/* api-reference:start */}
25
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
26
- {/* Do not edit this block manually. */}
27
-
28
- ## API Reference
29
-
30
- ### Text
31
-
32
- {MessagePartPrimitiveDocs.Text?.deprecated && (
33
- <Callout type="warn">
34
- <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Text.deprecated}
35
- </Callout>
36
- )}
37
-
38
- {MessagePartPrimitiveDocs.Text?.description}
39
-
40
- {MessagePartPrimitiveDocs.Text?.element && (
41
- <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Text?.element}>`}</code> element unless <code>asChild</code> is set.</p>
42
- )}
43
-
44
- ```tsx
45
- <MessagePartPrimitive.Text
46
- smooth={true}
47
- component="p"
48
- className="message-text"
49
- />
50
- ```
51
-
52
- <ParametersTable {...MessagePartPrimitiveTextProps} />
53
-
54
- {/* api-manual:MessagePartPrimitive.Text:start */}
55
- | Data attribute | Values |
56
- | --- | --- |
57
- | `[data-status]` | `"running"`, `"complete"`, or `"incomplete"` |
58
- {/* api-manual:MessagePartPrimitive.Text:end */}
59
-
60
- ### Image
61
-
62
- {MessagePartPrimitiveDocs.Image?.deprecated && (
63
- <Callout type="warn">
64
- <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Image.deprecated}
65
- </Callout>
66
- )}
67
-
68
- {MessagePartPrimitiveDocs.Image?.description}
69
-
70
- {MessagePartPrimitiveDocs.Image?.element && (
71
- <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Image?.element}>`}</code> element unless <code>asChild</code> is set.</p>
72
- )}
73
-
74
- ```tsx
75
- <MessagePartPrimitive.Image
76
- alt="Generated image"
77
- className="message-image"
78
- style={{ maxWidth: '100%' }}
79
- />
80
- ```
81
-
82
- <ParametersTable {...MessagePartPrimitiveImageProps} />
83
-
84
- ### InProgress
85
-
86
- {MessagePartPrimitiveDocs.InProgress?.deprecated && (
87
- <Callout type="warn">
88
- <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.InProgress.deprecated}
89
- </Callout>
90
- )}
91
-
92
- {MessagePartPrimitiveDocs.InProgress?.description}
93
-
94
- {MessagePartPrimitiveDocs.InProgress?.element && (
95
- <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.InProgress?.element}>`}</code> element unless <code>asChild</code> is set.</p>
96
- )}
97
-
98
- {MessagePartPrimitiveDocs.InProgress?.props && (
99
- <ParametersTable type={MessagePartPrimitiveDocs.InProgress?.element} parameters={MessagePartPrimitiveDocs.InProgress.props} />
100
- )}
101
-
102
- ### Messages
103
-
104
- {MessagePartPrimitiveDocs.Messages?.deprecated && (
105
- <Callout type="warn">
106
- <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Messages.deprecated}
107
- </Callout>
108
- )}
109
-
110
- {MessagePartPrimitiveDocs.Messages?.description}
111
-
112
- {MessagePartPrimitiveDocs.Messages?.element && (
113
- <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Messages?.element}>`}</code> element unless <code>asChild</code> is set.</p>
114
- )}
115
-
116
- <ParametersTable {...MessagePartPrimitiveMessagesProps} />
117
- {/* api-reference:end */}
@@ -1,339 +0,0 @@
1
- ---
2
- title: MessagePrimitive
3
- description: Message primitives for rendering assistant and user turns, message parts, attachments, actions, editing, and branch controls.
4
- ---
5
-
6
- import { MessagePrimitiveAttachmentByIndexProps, MessagePrimitiveAttachmentsProps, MessagePrimitiveContentProps, MessagePrimitiveGenerativeUIProps, MessagePrimitiveGroupedPartsProps, MessagePrimitiveIfProps, MessagePrimitivePartByIndexProps, MessagePrimitivePartsProps, MessagePrimitiveQuoteProps, MessagePrimitiveRootProps, MessagePrimitiveUnstable_PartsGroupedByParentIdProps, MessagePrimitiveUnstable_PartsGroupedProps } from "@/generated/typeDocs";
7
- import { MessagePrimitive as MessagePrimitiveDocs } from "@/generated/primitiveDocs";
8
-
9
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
- {/* Do not edit manually. */}
11
-
12
- For examples and usage patterns, see [Message](/docs/primitives/message).
13
-
14
- {/* api-manual:start */}
15
- ## Anatomy
16
-
17
- ```tsx
18
- import { MessagePrimitive } from "@assistant-ui/react";
19
-
20
- const UserMessage = () => (
21
- <MessagePrimitive.Root>
22
- User: <MessagePrimitive.Parts />
23
- <BranchPicker />
24
- <ActionBar />
25
- </MessagePrimitive.Root>
26
- );
27
-
28
- const AssistantMessage = () => (
29
- <MessagePrimitive.Root>
30
- Assistant: <MessagePrimitive.Parts />
31
- <BranchPicker />
32
- <ActionBar />
33
- </MessagePrimitive.Root>
34
- );
35
- ```
36
- {/* api-manual:end */}
37
-
38
- {/* api-reference:start */}
39
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
40
- {/* Do not edit this block manually. */}
41
-
42
- ## API Reference
43
-
44
- ### Root
45
-
46
- {MessagePrimitiveDocs.Root?.deprecated && (
47
- <Callout type="warn">
48
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Root.deprecated}
49
- </Callout>
50
- )}
51
-
52
- {MessagePrimitiveDocs.Root?.description}
53
-
54
- {MessagePrimitiveDocs.Root?.element && (
55
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
56
- )}
57
-
58
- ```tsx
59
- <MessagePrimitive.Root>
60
- <MessagePrimitive.Content />
61
- <ActionBarPrimitive.Root>
62
- <ActionBarPrimitive.Copy />
63
- <ActionBarPrimitive.Edit />
64
- </ActionBarPrimitive.Root>
65
- </MessagePrimitive.Root>
66
- ```
67
-
68
- <ParametersTable {...MessagePrimitiveRootProps} />
69
-
70
- ### Parts
71
-
72
- {MessagePrimitiveDocs.Parts?.deprecated && (
73
- <Callout type="warn">
74
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Parts.deprecated}
75
- </Callout>
76
- )}
77
-
78
- {MessagePrimitiveDocs.Parts?.description}
79
-
80
- {MessagePrimitiveDocs.Parts?.element && (
81
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Parts?.element}>`}</code> element unless <code>asChild</code> is set.</p>
82
- )}
83
-
84
- <ParametersTable {...MessagePrimitivePartsProps} />
85
-
86
- ### PartByIndex
87
-
88
- {MessagePrimitiveDocs.PartByIndex?.deprecated && (
89
- <Callout type="warn">
90
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.PartByIndex.deprecated}
91
- </Callout>
92
- )}
93
-
94
- {MessagePrimitiveDocs.PartByIndex?.description}
95
-
96
- {MessagePrimitiveDocs.PartByIndex?.element && (
97
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.PartByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
98
- )}
99
-
100
- <ParametersTable {...MessagePrimitivePartByIndexProps} />
101
-
102
- ### Content
103
-
104
- {MessagePrimitiveDocs.Content?.deprecated && (
105
- <Callout type="warn">
106
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Content.deprecated}
107
- </Callout>
108
- )}
109
-
110
- {MessagePrimitiveDocs.Content?.description}
111
-
112
- {MessagePrimitiveDocs.Content?.element && (
113
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Content?.element}>`}</code> element unless <code>asChild</code> is set.</p>
114
- )}
115
-
116
- <ParametersTable {...MessagePrimitiveContentProps} />
117
-
118
- ### If
119
-
120
- {MessagePrimitiveDocs.If?.deprecated && (
121
- <Callout type="warn">
122
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.If.deprecated}
123
- </Callout>
124
- )}
125
-
126
- {MessagePrimitiveDocs.If?.description}
127
-
128
- {MessagePrimitiveDocs.If?.element && (
129
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.If?.element}>`}</code> element unless <code>asChild</code> is set.</p>
130
- )}
131
-
132
- <ParametersTable {...MessagePrimitiveIfProps} />
133
-
134
- ### Attachments
135
-
136
- {MessagePrimitiveDocs.Attachments?.deprecated && (
137
- <Callout type="warn">
138
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Attachments.deprecated}
139
- </Callout>
140
- )}
141
-
142
- {MessagePrimitiveDocs.Attachments?.description}
143
-
144
- {MessagePrimitiveDocs.Attachments?.element && (
145
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Attachments?.element}>`}</code> element unless <code>asChild</code> is set.</p>
146
- )}
147
-
148
- <ParametersTable {...MessagePrimitiveAttachmentsProps} />
149
-
150
- ### AttachmentByIndex
151
-
152
- {MessagePrimitiveDocs.AttachmentByIndex?.deprecated && (
153
- <Callout type="warn">
154
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.AttachmentByIndex.deprecated}
155
- </Callout>
156
- )}
157
-
158
- {MessagePrimitiveDocs.AttachmentByIndex?.description}
159
-
160
- {MessagePrimitiveDocs.AttachmentByIndex?.element && (
161
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.AttachmentByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
162
- )}
163
-
164
- <ParametersTable {...MessagePrimitiveAttachmentByIndexProps} />
165
-
166
- ### Quote
167
-
168
- {MessagePrimitiveDocs.Quote?.deprecated && (
169
- <Callout type="warn">
170
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Quote.deprecated}
171
- </Callout>
172
- )}
173
-
174
- {MessagePrimitiveDocs.Quote?.description}
175
-
176
- {MessagePrimitiveDocs.Quote?.element && (
177
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Quote?.element}>`}</code> element unless <code>asChild</code> is set.</p>
178
- )}
179
-
180
- <ParametersTable {...MessagePrimitiveQuoteProps} />
181
-
182
- ### Error
183
-
184
- {MessagePrimitiveDocs.Error?.deprecated && (
185
- <Callout type="warn">
186
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Error.deprecated}
187
- </Callout>
188
- )}
189
-
190
- {MessagePrimitiveDocs.Error?.description}
191
-
192
- {MessagePrimitiveDocs.Error?.element && (
193
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Error?.element}>`}</code> element unless <code>asChild</code> is set.</p>
194
- )}
195
-
196
- {MessagePrimitiveDocs.Error?.props && (
197
- <ParametersTable type={MessagePrimitiveDocs.Error?.element} parameters={MessagePrimitiveDocs.Error.props} />
198
- )}
199
-
200
- ### GroupedParts
201
-
202
- {MessagePrimitiveDocs.GroupedParts?.deprecated && (
203
- <Callout type="warn">
204
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.GroupedParts.deprecated}
205
- </Callout>
206
- )}
207
-
208
- {MessagePrimitiveDocs.GroupedParts?.description}
209
-
210
- {MessagePrimitiveDocs.GroupedParts?.element && (
211
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.GroupedParts?.element}>`}</code> element unless <code>asChild</code> is set.</p>
212
- )}
213
-
214
- ```tsx
215
- <MessagePrimitive.GroupedParts
216
- groupBy={groupPartByType({
217
- reasoning: ["group-thought", "group-reasoning"],
218
- "tool-call": ["group-thought", "group-tool"],
219
- })}
220
- >
221
- {({ part, children }) => {
222
- switch (part.type) {
223
- case "group-thought": return <Thought>{children}</Thought>;
224
- case "group-reasoning": return <Reasoning>{children}</Reasoning>;
225
- case "group-tool": return <ToolStack>{children}</ToolStack>;
226
- case "text": return <MarkdownText />;
227
- case "tool-call": return part.toolUI ?? <ToolFallback {...part} />;
228
- case "indicator": return <LoadingDots />;
229
- default: return null;
230
- }
231
- }}
232
- </MessagePrimitive.GroupedParts>
233
- ```
234
-
235
- <ParametersTable {...MessagePrimitiveGroupedPartsProps} />
236
-
237
- ### GenerativeUI
238
-
239
- {MessagePrimitiveDocs.GenerativeUI?.deprecated && (
240
- <Callout type="warn">
241
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.GenerativeUI.deprecated}
242
- </Callout>
243
- )}
244
-
245
- {MessagePrimitiveDocs.GenerativeUI?.description}
246
-
247
- {MessagePrimitiveDocs.GenerativeUI?.element && (
248
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.GenerativeUI?.element}>`}</code> element unless <code>asChild</code> is set.</p>
249
- )}
250
-
251
- ```tsx
252
- <MessagePrimitive.GenerativeUI
253
- components={{ Card: MyCard, Button: MyButton }}
254
- />
255
- ```
256
-
257
- <ParametersTable {...MessagePrimitiveGenerativeUIProps} />
258
-
259
- ### Unstable_PartsGrouped
260
-
261
- {MessagePrimitiveDocs.Unstable_PartsGrouped?.deprecated && (
262
- <Callout type="warn">
263
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Unstable_PartsGrouped.deprecated}
264
- </Callout>
265
- )}
266
-
267
- {MessagePrimitiveDocs.Unstable_PartsGrouped?.description}
268
-
269
- {MessagePrimitiveDocs.Unstable_PartsGrouped?.element && (
270
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Unstable_PartsGrouped?.element}>`}</code> element unless <code>asChild</code> is set.</p>
271
- )}
272
-
273
- ```tsx
274
- // Group by parent ID (default behavior)
275
- <MessagePrimitive.Unstable_PartsGrouped
276
- components={{
277
- Text: ({ text }) => <p className="message-text">{text}</p>,
278
- Image: ({ image }) => <img src={image} alt="Message image" />,
279
- Group: ({ groupKey, indices, children }) => {
280
- if (!groupKey) return <>{children}</>;
281
- return (
282
- <div className="parent-group border rounded p-4">
283
- <h4>Parent ID: {groupKey}</h4>
284
- {children}
285
- </div>
286
- );
287
- }
288
- }}
289
- />
290
- ```
291
-
292
- <ParametersTable {...MessagePrimitiveUnstable_PartsGroupedProps} />
293
-
294
- ### Unstable_PartsGroupedByParentId
295
-
296
- {MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.deprecated && (
297
- <Callout type="warn">
298
- <strong>Deprecated.</strong> {MessagePrimitiveDocs.Unstable_PartsGroupedByParentId.deprecated}
299
- </Callout>
300
- )}
301
-
302
- {MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.description}
303
-
304
- {MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.element && (
305
- <p>This primitive renders a <code>{`<${MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.element}>`}</code> element unless <code>asChild</code> is set.</p>
306
- )}
307
-
308
- <ParametersTable {...MessagePrimitiveUnstable_PartsGroupedByParentIdProps} />
309
-
310
- ### groupPartByType
311
-
312
- Build a `groupBy` from a `part.type → group-key path` lookup.
313
- Parts whose type isn't in the map are left ungrouped. The returned
314
- function carries a stable GROUPBY_MEMO_KEY fingerprint so
315
- `<MessagePrimitive.GroupedParts>` can memoize its tree across renders.
316
-
317
- The synthetic `"standalone-tool-call"` key matches tool calls that should
318
- render outside the chain-of-thought grouping. MCP-app calls are detected from
319
- the part alone; the registry-driven cases (human tools, the generative-UI
320
- tool, `display: "standalone"` opt-ins) are resolved from the
321
- GroupByContext that `<MessagePrimitive.GroupedParts>` passes to the
322
- `groupBy` function — the helper needs nothing threaded into it.
323
-
324
- ```tsx
325
- <MessagePrimitive.GroupedParts
326
- groupBy={groupPartByType({
327
- reasoning: ["group-thought", "group-reasoning"],
328
- "tool-call": ["group-thought", "group-tool"],
329
- "standalone-tool-call": [],
330
- })}
331
- >
332
- {({ part, children }) => { ... }}
333
- </MessagePrimitive.GroupedParts>
334
- ```
335
-
336
- ```ts
337
- const groupPartByType: <TKey extends `group-${string}`>(map: Partial<Readonly<Record<GroupPartType, readonly TKey[]>>>) => ((part: PartState, context?: GroupByContext) => readonly TKey[]);
338
- ```
339
- {/* api-reference:end */}
@@ -1,77 +0,0 @@
1
- ---
2
- title: QueueItemPrimitive
3
- description: Queue item primitives for rendering pending assistant-ui thread operations, optimistic work, and runtime queue state.
4
- ---
5
-
6
- import { QueueItemPrimitiveRemoveProps, QueueItemPrimitiveSteerProps, QueueItemPrimitiveTextProps } from "@/generated/typeDocs";
7
- import { QueueItemPrimitive as QueueItemPrimitiveDocs } from "@/generated/primitiveDocs";
8
-
9
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
- {/* Do not edit manually. */}
11
-
12
- {/* api-reference:start */}
13
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
14
- {/* Do not edit this block manually. */}
15
-
16
- ## API Reference
17
-
18
- ### Text
19
-
20
- {QueueItemPrimitiveDocs.Text?.deprecated && (
21
- <Callout type="warn">
22
- <strong>Deprecated.</strong> {QueueItemPrimitiveDocs.Text.deprecated}
23
- </Callout>
24
- )}
25
-
26
- {QueueItemPrimitiveDocs.Text?.description}
27
-
28
- {QueueItemPrimitiveDocs.Text?.element && (
29
- <p>This primitive renders a <code>{`<${QueueItemPrimitiveDocs.Text?.element}>`}</code> element unless <code>asChild</code> is set.</p>
30
- )}
31
-
32
- ```tsx
33
- <QueueItemPrimitive.Text />
34
- ```
35
-
36
- <ParametersTable {...QueueItemPrimitiveTextProps} />
37
-
38
- ### Steer
39
-
40
- {QueueItemPrimitiveDocs.Steer?.deprecated && (
41
- <Callout type="warn">
42
- <strong>Deprecated.</strong> {QueueItemPrimitiveDocs.Steer.deprecated}
43
- </Callout>
44
- )}
45
-
46
- {QueueItemPrimitiveDocs.Steer?.description}
47
-
48
- {QueueItemPrimitiveDocs.Steer?.element && (
49
- <p>This primitive renders a <code>{`<${QueueItemPrimitiveDocs.Steer?.element}>`}</code> element unless <code>asChild</code> is set.</p>
50
- )}
51
-
52
- ```tsx
53
- <QueueItemPrimitive.Steer>Run Now</QueueItemPrimitive.Steer>
54
- ```
55
-
56
- <ParametersTable {...QueueItemPrimitiveSteerProps} />
57
-
58
- ### Remove
59
-
60
- {QueueItemPrimitiveDocs.Remove?.deprecated && (
61
- <Callout type="warn">
62
- <strong>Deprecated.</strong> {QueueItemPrimitiveDocs.Remove.deprecated}
63
- </Callout>
64
- )}
65
-
66
- {QueueItemPrimitiveDocs.Remove?.description}
67
-
68
- {QueueItemPrimitiveDocs.Remove?.element && (
69
- <p>This primitive renders a <code>{`<${QueueItemPrimitiveDocs.Remove?.element}>`}</code> element unless <code>asChild</code> is set.</p>
70
- )}
71
-
72
- ```tsx
73
- <QueueItemPrimitive.Remove>×</QueueItemPrimitive.Remove>
74
- ```
75
-
76
- <ParametersTable {...QueueItemPrimitiveRemoveProps} />
77
- {/* api-reference:end */}