@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,936 +0,0 @@
1
- # Example: with-react-router
2
-
3
- ## app/app.css
4
-
5
- ```css
6
- @import "tailwindcss";
7
- @import "tw-animate-css";
8
-
9
- @source "../../../packages/ui/src";
10
-
11
- @custom-variant dark (&:is(.dark *));
12
-
13
- @theme {
14
- --font-sans:
15
- "Inter", ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji",
16
- "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
17
- }
18
-
19
- html,
20
- body {
21
- @apply bg-white dark:bg-gray-950;
22
-
23
- @media (prefers-color-scheme: dark) {
24
- color-scheme: dark;
25
- }
26
- }
27
-
28
- @theme inline {
29
- --radius-sm: calc(var(--radius) - 4px);
30
- --radius-md: calc(var(--radius) - 2px);
31
- --radius-lg: var(--radius);
32
- --radius-xl: calc(var(--radius) + 4px);
33
- --color-background: var(--background);
34
- --color-foreground: var(--foreground);
35
- --color-card: var(--card);
36
- --color-card-foreground: var(--card-foreground);
37
- --color-popover: var(--popover);
38
- --color-popover-foreground: var(--popover-foreground);
39
- --color-primary: var(--primary);
40
- --color-primary-foreground: var(--primary-foreground);
41
- --color-secondary: var(--secondary);
42
- --color-secondary-foreground: var(--secondary-foreground);
43
- --color-muted: var(--muted);
44
- --color-muted-foreground: var(--muted-foreground);
45
- --color-accent: var(--accent);
46
- --color-accent-foreground: var(--accent-foreground);
47
- --color-destructive: var(--destructive);
48
- --color-border: var(--border);
49
- --color-input: var(--input);
50
- --color-ring: var(--ring);
51
- --color-chart-1: var(--chart-1);
52
- --color-chart-2: var(--chart-2);
53
- --color-chart-3: var(--chart-3);
54
- --color-chart-4: var(--chart-4);
55
- --color-chart-5: var(--chart-5);
56
- --color-sidebar: var(--sidebar);
57
- --color-sidebar-foreground: var(--sidebar-foreground);
58
- --color-sidebar-primary: var(--sidebar-primary);
59
- --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
60
- --color-sidebar-accent: var(--sidebar-accent);
61
- --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
62
- --color-sidebar-border: var(--sidebar-border);
63
- --color-sidebar-ring: var(--sidebar-ring);
64
- }
65
-
66
- :root {
67
- --radius: 0.625rem;
68
- --background: oklch(1 0 0);
69
- --foreground: oklch(0.145 0 0);
70
- --card: oklch(1 0 0);
71
- --card-foreground: oklch(0.145 0 0);
72
- --popover: oklch(1 0 0);
73
- --popover-foreground: oklch(0.145 0 0);
74
- --primary: oklch(0.205 0 0);
75
- --primary-foreground: oklch(0.985 0 0);
76
- --secondary: oklch(0.97 0 0);
77
- --secondary-foreground: oklch(0.205 0 0);
78
- --muted: oklch(0.97 0 0);
79
- --muted-foreground: oklch(0.556 0 0);
80
- --accent: oklch(0.97 0 0);
81
- --accent-foreground: oklch(0.205 0 0);
82
- --destructive: oklch(0.577 0.245 27.325);
83
- --border: oklch(0.922 0 0);
84
- --input: oklch(0.922 0 0);
85
- --ring: oklch(0.708 0 0);
86
- --chart-1: oklch(0.646 0.222 41.116);
87
- --chart-2: oklch(0.6 0.118 184.704);
88
- --chart-3: oklch(0.398 0.07 227.392);
89
- --chart-4: oklch(0.828 0.189 84.429);
90
- --chart-5: oklch(0.769 0.188 70.08);
91
- --sidebar: oklch(0.985 0 0);
92
- --sidebar-foreground: oklch(0.145 0 0);
93
- --sidebar-primary: oklch(0.205 0 0);
94
- --sidebar-primary-foreground: oklch(0.985 0 0);
95
- --sidebar-accent: oklch(0.97 0 0);
96
- --sidebar-accent-foreground: oklch(0.205 0 0);
97
- --sidebar-border: oklch(0.922 0 0);
98
- --sidebar-ring: oklch(0.708 0 0);
99
- }
100
-
101
- .dark {
102
- --background: oklch(0.145 0 0);
103
- --foreground: oklch(0.985 0 0);
104
- --card: oklch(0.205 0 0);
105
- --card-foreground: oklch(0.985 0 0);
106
- --popover: oklch(0.205 0 0);
107
- --popover-foreground: oklch(0.985 0 0);
108
- --primary: oklch(0.922 0 0);
109
- --primary-foreground: oklch(0.205 0 0);
110
- --secondary: oklch(0.269 0 0);
111
- --secondary-foreground: oklch(0.985 0 0);
112
- --muted: oklch(0.269 0 0);
113
- --muted-foreground: oklch(0.708 0 0);
114
- --accent: oklch(0.269 0 0);
115
- --accent-foreground: oklch(0.985 0 0);
116
- --destructive: oklch(0.704 0.191 22.216);
117
- --border: oklch(1 0 0 / 10%);
118
- --input: oklch(1 0 0 / 15%);
119
- --ring: oklch(0.556 0 0);
120
- --chart-1: oklch(0.488 0.243 264.376);
121
- --chart-2: oklch(0.696 0.17 162.48);
122
- --chart-3: oklch(0.769 0.188 70.08);
123
- --chart-4: oklch(0.627 0.265 303.9);
124
- --chart-5: oklch(0.645 0.246 16.439);
125
- --sidebar: oklch(0.205 0 0);
126
- --sidebar-foreground: oklch(0.985 0 0);
127
- --sidebar-primary: oklch(0.488 0.243 264.376);
128
- --sidebar-primary-foreground: oklch(0.985 0 0);
129
- --sidebar-accent: oklch(0.269 0 0);
130
- --sidebar-accent-foreground: oklch(0.985 0 0);
131
- --sidebar-border: oklch(1 0 0 / 10%);
132
- --sidebar-ring: oklch(0.556 0 0);
133
- }
134
-
135
- @layer base {
136
- * {
137
- @apply border-border outline-ring/50;
138
- }
139
- body {
140
- @apply bg-background text-foreground;
141
- }
142
- }
143
-
144
- ```
145
-
146
- ## app/MyRuntimeProvider.tsx
147
-
148
- ```tsx
149
- import type { ThreadMessageLike, AppendMessage } from "@assistant-ui/react";
150
- import {
151
- AssistantRuntimeProvider,
152
- useExternalStoreRuntime,
153
- } from "@assistant-ui/react";
154
- import { createParser, type EventSourceMessage } from "eventsource-parser";
155
- import { useState, useCallback } from "react";
156
-
157
- // SSE event types from server
158
- type SSEEvent =
159
- | { type: "text"; content: string }
160
- | { type: "tool_call"; id: string; name: string; arguments: string }
161
- | { type: "tool_result"; id: string; result: string };
162
-
163
- // Parse SSE stream using eventsource-parser
164
- async function* parseSSEStream(
165
- response: Response,
166
- ): AsyncGenerator<SSEEvent, void, unknown> {
167
- const reader = response.body?.getReader();
168
- if (!reader) throw new Error("No reader available");
169
-
170
- const decoder = new TextDecoder();
171
- const events: SSEEvent[] = [];
172
- let done = false;
173
-
174
- const parser = createParser({
175
- onEvent: (event: EventSourceMessage) => {
176
- if (event.data === "[DONE]") {
177
- done = true;
178
- return;
179
- }
180
- try {
181
- events.push(JSON.parse(event.data) as SSEEvent);
182
- } catch {
183
- // Skip invalid JSON
184
- }
185
- },
186
- });
187
-
188
- while (!done) {
189
- const result = await reader.read();
190
- if (result.done) break;
191
-
192
- parser.feed(decoder.decode(result.value, { stream: true }));
193
-
194
- while (events.length > 0) {
195
- yield events.shift()!;
196
- }
197
- }
198
-
199
- // Yield any remaining events
200
- while (events.length > 0) {
201
- yield events.shift()!;
202
- }
203
- }
204
-
205
- // Extract content part type from ThreadMessageLike
206
- type ContentPart = Exclude<ThreadMessageLike["content"], string>[number];
207
-
208
- // Helper to update assistant message content
209
- const updateAssistantContent = (
210
- messages: readonly ThreadMessageLike[],
211
- updater: (content: ContentPart[]) => ContentPart[],
212
- ): ThreadMessageLike[] => {
213
- const newMessages = [...messages];
214
- const lastMsg = newMessages[newMessages.length - 1];
215
-
216
- if (lastMsg?.role === "assistant") {
217
- const content = Array.isArray(lastMsg.content)
218
- ? [...lastMsg.content]
219
- : [{ type: "text" as const, text: lastMsg.content as string }];
220
- newMessages[newMessages.length - 1] = {
221
- ...lastMsg,
222
- content: updater(content),
223
- };
224
- } else {
225
- newMessages.push({ role: "assistant", content: updater([]) });
226
- }
227
-
228
- return newMessages;
229
- };
230
-
231
- export function MyRuntimeProvider({
232
- children,
233
- }: Readonly<{
234
- children: React.ReactNode;
235
- }>) {
236
- const [messages, setMessages] = useState<readonly ThreadMessageLike[]>([]);
237
- const [isRunning, setIsRunning] = useState(false);
238
-
239
- const onNew = useCallback(
240
- async (message: AppendMessage) => {
241
- if (message.content[0]?.type !== "text")
242
- throw new Error("Only text content is supported");
243
-
244
- const userMessage: ThreadMessageLike = {
245
- role: "user",
246
- content: [{ type: "text", text: message.content[0].text }],
247
- };
248
-
249
- const newMessages = [...messages, userMessage];
250
- setMessages(newMessages);
251
- setIsRunning(true);
252
-
253
- try {
254
- const response = await fetch("/api/chat", {
255
- method: "POST",
256
- headers: { "Content-Type": "application/json" },
257
- body: JSON.stringify({
258
- messages: newMessages.map((m) => ({
259
- role: m.role,
260
- content:
261
- typeof m.content === "string"
262
- ? m.content
263
- : ((m.content[0] as { text?: string })?.text ?? ""),
264
- })),
265
- }),
266
- });
267
-
268
- if (!response.ok) throw new Error("Failed to fetch response");
269
-
270
- let textContent = "";
271
-
272
- for await (const event of parseSSEStream(response)) {
273
- switch (event.type) {
274
- case "text":
275
- textContent += event.content;
276
- setMessages((prev) =>
277
- updateAssistantContent(prev, (content) => {
278
- const idx = content.findIndex((p) => p.type === "text");
279
- const textPart = { type: "text" as const, text: textContent };
280
- if (idx >= 0) {
281
- content[idx] = textPart;
282
- } else {
283
- content.push(textPart);
284
- }
285
- return content;
286
- }),
287
- );
288
- break;
289
-
290
- case "tool_call":
291
- setMessages((prev) =>
292
- updateAssistantContent(prev, (content) => [
293
- ...content,
294
- {
295
- type: "tool-call" as const,
296
- toolCallId: event.id,
297
- toolName: event.name,
298
- args: JSON.parse(event.arguments),
299
- argsText: event.arguments,
300
- },
301
- ]),
302
- );
303
- break;
304
-
305
- case "tool_result":
306
- setMessages((prev) =>
307
- updateAssistantContent(prev, (content) =>
308
- content.map((part) =>
309
- part.type === "tool-call" && part.toolCallId === event.id
310
- ? { ...part, result: JSON.parse(event.result) }
311
- : part,
312
- ),
313
- ),
314
- );
315
- break;
316
- }
317
- }
318
- } catch (error) {
319
- console.error("Error:", error);
320
- setMessages((prev) => [
321
- ...prev,
322
- {
323
- role: "assistant",
324
- content: [
325
- {
326
- type: "text",
327
- text: "Sorry, an error occurred. Please try again.",
328
- },
329
- ],
330
- },
331
- ]);
332
- } finally {
333
- setIsRunning(false);
334
- }
335
- },
336
- [messages],
337
- );
338
-
339
- const runtime = useExternalStoreRuntime<ThreadMessageLike>({
340
- messages,
341
- setMessages,
342
- onNew,
343
- convertMessage: (m) => m,
344
- isRunning,
345
- });
346
-
347
- return (
348
- <AssistantRuntimeProvider runtime={runtime}>
349
- {children}
350
- </AssistantRuntimeProvider>
351
- );
352
- }
353
-
354
- ```
355
-
356
- ## app/root.tsx
357
-
358
- ```tsx
359
- import {
360
- isRouteErrorResponse,
361
- Links,
362
- Meta,
363
- Outlet,
364
- Scripts,
365
- ScrollRestoration,
366
- } from "react-router";
367
-
368
- import type { Route } from "./+types/root";
369
- import { MyRuntimeProvider } from "./MyRuntimeProvider";
370
- import "./app.css";
371
-
372
- export const links: Route.LinksFunction = () => [
373
- { rel: "preconnect", href: "https://fonts.googleapis.com" },
374
- {
375
- rel: "preconnect",
376
- href: "https://fonts.gstatic.com",
377
- crossOrigin: "anonymous",
378
- },
379
- {
380
- rel: "stylesheet",
381
- href: "https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap",
382
- },
383
- ];
384
-
385
- export function Layout({ children }: { children: React.ReactNode }) {
386
- return (
387
- <html lang="en" className="h-dvh">
388
- <head>
389
- <meta charSet="utf-8" />
390
- <meta name="viewport" content="width=device-width, initial-scale=1" />
391
- <Meta />
392
- <Links />
393
- </head>
394
- <body className="h-dvh font-sans">
395
- <MyRuntimeProvider>{children}</MyRuntimeProvider>
396
- <ScrollRestoration />
397
- <Scripts />
398
- </body>
399
- </html>
400
- );
401
- }
402
-
403
- export default function App() {
404
- return <Outlet />;
405
- }
406
-
407
- export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
408
- let message = "Oops!";
409
- let details = "An unexpected error occurred.";
410
- let stack: string | undefined;
411
-
412
- if (isRouteErrorResponse(error)) {
413
- message = error.status === 404 ? "404" : "Error";
414
- details =
415
- error.status === 404
416
- ? "The requested page could not be found."
417
- : error.statusText || details;
418
- } else if (import.meta.env.DEV && error && error instanceof Error) {
419
- details = error.message;
420
- stack = error.stack;
421
- }
422
-
423
- return (
424
- <main className="container mx-auto p-4 pt-16">
425
- <h1>{message}</h1>
426
- <p>{details}</p>
427
- {stack && (
428
- <pre className="w-full overflow-x-auto p-4">
429
- <code>{stack}</code>
430
- </pre>
431
- )}
432
- </main>
433
- );
434
- }
435
-
436
- ```
437
-
438
- ## app/routes.ts
439
-
440
- ```typescript
441
- import { type RouteConfig, index, route } from "@react-router/dev/routes";
442
-
443
- export default [
444
- index("routes/home.tsx"),
445
- route("api/chat", "routes/api.chat.ts"),
446
- ] satisfies RouteConfig;
447
-
448
- ```
449
-
450
- ## app/routes/api.chat.ts
451
-
452
- ```typescript
453
- import type { Route } from "./+types/api.chat";
454
- import OpenAI from "openai";
455
-
456
- type ChatCompletionMessageParam =
457
- OpenAI.Chat.Completions.ChatCompletionMessageParam;
458
-
459
- const openai = new OpenAI({
460
- apiKey: process.env.OPENAI_API_KEY,
461
- });
462
-
463
- // Define available tools
464
- const tools: OpenAI.Chat.Completions.ChatCompletionTool[] = [
465
- {
466
- type: "function",
467
- function: {
468
- name: "get_weather",
469
- description: "Get the current weather for a location",
470
- parameters: {
471
- type: "object",
472
- properties: {
473
- location: {
474
- type: "string",
475
- description: "The city name, e.g. San Francisco",
476
- },
477
- },
478
- required: ["location"],
479
- },
480
- },
481
- },
482
- ];
483
-
484
- // Simple tool execution
485
- async function executeTool(
486
- name: string,
487
- args: Record<string, unknown>,
488
- ): Promise<string> {
489
- if (name === "get_weather") {
490
- const location = args.location as string;
491
- // Simulate weather API call
492
- const temp = Math.floor(Math.random() * 30) + 10;
493
- const conditions = ["sunny", "cloudy", "rainy", "partly cloudy"];
494
- const condition = conditions[Math.floor(Math.random() * conditions.length)];
495
- return JSON.stringify({
496
- location,
497
- temperature: temp,
498
- unit: "celsius",
499
- condition,
500
- });
501
- }
502
- return JSON.stringify({ error: "Unknown tool" });
503
- }
504
-
505
- export async function action({ request }: Route.ActionArgs) {
506
- const { messages } = await request.json();
507
-
508
- const openaiMessages: ChatCompletionMessageParam[] = messages.map(
509
- (m: { role: string; content: string }) => ({
510
- role: m.role as "user" | "assistant",
511
- content: m.content,
512
- }),
513
- );
514
-
515
- const encoder = new TextEncoder();
516
-
517
- const stream = new ReadableStream({
518
- async start(controller) {
519
- let continueLoop = true;
520
-
521
- while (continueLoop) {
522
- const response = await openai.chat.completions.create({
523
- model: "gpt-5.6-luna",
524
- messages: openaiMessages,
525
- tools,
526
- stream: true,
527
- });
528
-
529
- let currentToolCalls: {
530
- id: string;
531
- name: string;
532
- arguments: string;
533
- }[] = [];
534
- let assistantContent = "";
535
-
536
- for await (const chunk of response) {
537
- const delta = chunk.choices[0]?.delta;
538
-
539
- // Handle text content
540
- if (delta?.content) {
541
- assistantContent += delta.content;
542
- controller.enqueue(
543
- encoder.encode(
544
- `data: ${JSON.stringify({ type: "text", content: delta.content })}\n\n`,
545
- ),
546
- );
547
- }
548
-
549
- // Handle tool calls
550
- if (delta?.tool_calls) {
551
- for (const toolCall of delta.tool_calls) {
552
- const index = toolCall.index;
553
-
554
- if (!currentToolCalls[index]) {
555
- currentToolCalls[index] = {
556
- id: toolCall.id || "",
557
- name: toolCall.function?.name || "",
558
- arguments: "",
559
- };
560
- }
561
-
562
- if (toolCall.id) {
563
- currentToolCalls[index].id = toolCall.id;
564
- }
565
- if (toolCall.function?.name) {
566
- currentToolCalls[index].name = toolCall.function.name;
567
- }
568
- if (toolCall.function?.arguments) {
569
- currentToolCalls[index].arguments +=
570
- toolCall.function.arguments;
571
- }
572
- }
573
- }
574
- }
575
-
576
- // If there are tool calls, execute them and continue the loop
577
- if (currentToolCalls.length > 0) {
578
- // Add assistant message with tool calls
579
- openaiMessages.push({
580
- role: "assistant",
581
- content: assistantContent || null,
582
- tool_calls: currentToolCalls.map((tc) => ({
583
- id: tc.id,
584
- type: "function" as const,
585
- function: {
586
- name: tc.name,
587
- arguments: tc.arguments,
588
- },
589
- })),
590
- });
591
-
592
- // Execute each tool and add results
593
- for (const toolCall of currentToolCalls) {
594
- // Send tool call event to client
595
- controller.enqueue(
596
- encoder.encode(
597
- `data: ${JSON.stringify({
598
- type: "tool_call",
599
- id: toolCall.id,
600
- name: toolCall.name,
601
- arguments: toolCall.arguments,
602
- })}\n\n`,
603
- ),
604
- );
605
-
606
- let parsedArgs: unknown;
607
- try {
608
- parsedArgs = JSON.parse(toolCall.arguments);
609
- } catch (parseError) {
610
- const message =
611
- parseError instanceof Error
612
- ? parseError.message
613
- : "Invalid tool arguments";
614
-
615
- // Surface parsing failure to the client and continue gracefully
616
- const errorResult = JSON.stringify({
617
- error: message,
618
- });
619
-
620
- controller.enqueue(
621
- encoder.encode(
622
- `data: ${JSON.stringify({
623
- type: "tool_result",
624
- id: toolCall.id,
625
- result: errorResult,
626
- })}\n\n`,
627
- ),
628
- );
629
-
630
- openaiMessages.push({
631
- role: "tool",
632
- tool_call_id: toolCall.id,
633
- content: errorResult,
634
- });
635
-
636
- continue;
637
- }
638
-
639
- const args = parsedArgs as Record<string, unknown>;
640
- const result = await executeTool(toolCall.name, args);
641
-
642
- // Send tool result event to client
643
- controller.enqueue(
644
- encoder.encode(
645
- `data: ${JSON.stringify({
646
- type: "tool_result",
647
- id: toolCall.id,
648
- result,
649
- })}\n\n`,
650
- ),
651
- );
652
-
653
- // Add tool result to messages
654
- openaiMessages.push({
655
- role: "tool",
656
- tool_call_id: toolCall.id,
657
- content: result,
658
- });
659
- }
660
-
661
- // Reset for next iteration
662
- currentToolCalls = [];
663
- } else {
664
- // No tool calls, we're done
665
- continueLoop = false;
666
- }
667
- }
668
-
669
- controller.enqueue(encoder.encode("data: [DONE]\n\n"));
670
- controller.close();
671
- },
672
- });
673
-
674
- return new Response(stream, {
675
- headers: {
676
- "Content-Type": "text/event-stream",
677
- "Cache-Control": "no-cache",
678
- Connection: "keep-alive",
679
- },
680
- });
681
- }
682
-
683
- ```
684
-
685
- ## app/routes/home.tsx
686
-
687
- ```tsx
688
- import { Thread } from "@/components/assistant-ui/thread";
689
- import {
690
- useAui,
691
- AuiProvider,
692
- AuiConfig,
693
- Suggestions,
694
- } from "@assistant-ui/react";
695
-
696
- export function meta() {
697
- return [
698
- { title: "assistant-ui with React Router" },
699
- { name: "description", content: "assistant-ui example with React Router" },
700
- ];
701
- }
702
-
703
- function ThreadWithSuggestions() {
704
- const aui = useAui();
705
- const config = AuiConfig({
706
- suggestions: Suggestions([
707
- {
708
- title: "Hello!",
709
- label: "start a conversation",
710
- prompt: "Hello! What can you help me with?",
711
- },
712
- {
713
- title: "Tell me a joke",
714
- label: "about programming",
715
- prompt: "Tell me a funny programming joke.",
716
- },
717
- ]),
718
- });
719
- return (
720
- <AuiProvider extends={aui} config={config}>
721
- <Thread />
722
- </AuiProvider>
723
- );
724
- }
725
-
726
- export default function Home() {
727
- return (
728
- <main className="h-dvh">
729
- <ThreadWithSuggestions />
730
- </main>
731
- );
732
- }
733
-
734
- ```
735
-
736
- ## components.json
737
-
738
- ```json
739
- {
740
- "$schema": "https://ui.shadcn.com/schema.json",
741
- "style": "new-york",
742
- "rsc": false,
743
- "tsx": true,
744
- "tailwind": {
745
- "config": "",
746
- "css": "app/app.css",
747
- "baseColor": "neutral",
748
- "cssVariables": true,
749
- "prefix": ""
750
- },
751
- "iconLibrary": "lucide",
752
- "aliases": {
753
- "components": "@/components",
754
- "utils": "@/lib/utils",
755
- "ui": "@/components/ui",
756
- "lib": "@/lib",
757
- "hooks": "@/hooks"
758
- },
759
- "registries": {
760
- "@assistant-ui": "https://r.assistant-ui.com/{name}.json"
761
- }
762
- }
763
-
764
- ```
765
-
766
- ## package.json
767
-
768
- ```json
769
- {
770
- "name": "with-react-router",
771
- "private": true,
772
- "type": "module",
773
- "scripts": {
774
- "build": "react-router build",
775
- "dev": "react-router dev",
776
- "start": "react-router-serve ./build/server/index.js",
777
- "typecheck": "react-router typegen && tsc"
778
- },
779
- "dependencies": {
780
- "@assistant-ui/react": "workspace:*",
781
- "@assistant-ui/react-markdown": "workspace:*",
782
- "@react-router/node": "^8.3.0",
783
- "@react-router/serve": "^8.3.0",
784
- "class-variance-authority": "^0.7.1",
785
- "clsx": "^2.1.1",
786
- "eventsource-parser": "^4.1.0",
787
- "isbot": "^5.2.1",
788
- "lucide-react": "^1.33.0",
789
- "openai": "^7.5.0",
790
- "react": "^19.2.8",
791
- "react-dom": "^19.2.8",
792
- "react-router": "^8.3.0",
793
- "remark-gfm": "^4.0.1",
794
- "tailwind-merge": "^3.6.0"
795
- },
796
- "devDependencies": {
797
- "@react-router/dev": "^8.3.0",
798
- "@tailwindcss/vite": "^4.3.3",
799
- "@types/node": "^26.2.0",
800
- "@types/react": "^19.2.18",
801
- "@types/react-dom": "^19.2.5",
802
- "tailwindcss": "^4.3.3",
803
- "tw-animate-css": "^1.4.0",
804
- "typescript": "npm:@typescript/typescript6@^6.0.2",
805
- "typescript-7": "npm:typescript@^7.0.2",
806
- "vite": "^8.2.2",
807
- "vite-tsconfig-paths": "^6.1.1"
808
- }
809
- }
810
-
811
- ```
812
-
813
- ## react-router.config.ts
814
-
815
- ```typescript
816
- import type { Config } from "@react-router/dev/config";
817
-
818
- export default {
819
- // Config options...
820
- // Server-side render by default, to enable SPA mode set this to `false`
821
- ssr: true,
822
- } satisfies Config;
823
-
824
- ```
825
-
826
- ## README.md
827
-
828
- ```markdown
829
- # React Router Integration
830
-
831
- This example demonstrates how to use assistant-ui with React Router (v8) and Vite.
832
-
833
- ## Quick Start
834
-
835
- ### Using CLI (Recommended)
836
-
837
- ```bash
838
- npx assistant-ui@latest create my-app --example with-react-router
839
- cd my-app
840
- ```
841
-
842
- ### Environment Variables
843
-
844
- Create `.env`:
845
-
846
- ```
847
- OPENAI_API_KEY=sk-...
848
- ```
849
-
850
- ### Run
851
-
852
- ```bash
853
- npm install
854
- npm run dev
855
- ```
856
-
857
- ## Features
858
-
859
- - React Router v8 integration
860
- - Vite-based development server
861
- - OpenAI streaming chat
862
- - Zustand for state management
863
- - Markdown message rendering
864
-
865
- ## Related Documentation
866
-
867
- - [assistant-ui Documentation](https://www.assistant-ui.com/docs)
868
- - [React Router Documentation](https://reactrouter.com/)
869
-
870
- ```
871
-
872
- ## tsconfig.json
873
-
874
- ```json
875
- {
876
- "include": [
877
- "**/*",
878
- "**/.server/**/*",
879
- "**/.client/**/*",
880
- ".react-router/types/**/*"
881
- ],
882
- "compilerOptions": {
883
- "lib": ["DOM", "DOM.Iterable", "ES2022"],
884
- "types": ["node", "vite/client"],
885
- "target": "ES2022",
886
- "module": "ES2022",
887
- "moduleResolution": "bundler",
888
- "jsx": "react-jsx",
889
- "rootDirs": [".", "./.react-router/types"],
890
- "paths": {
891
- "@/*": ["./app/*"],
892
- "@/components/assistant-ui/*": [
893
- "../../packages/ui/src/components/assistant-ui/*"
894
- ],
895
- "@/hooks/*": ["../../packages/ui/src/hooks/*"],
896
- "@/components/ui/*": [
897
- "../../packages/ui/src/components/ui/base/*",
898
- "../../packages/ui/src/components/ui/radix/*"
899
- ],
900
- "@/components/ui/radix/*": [
901
- "../../packages/ui/src/components/ui/radix/*"
902
- ],
903
- "@/lib/utils": ["../../packages/ui/src/lib/utils"],
904
- "@assistant-ui/ui/*": ["../../packages/ui/src/*"]
905
- },
906
- "esModuleInterop": true,
907
- "verbatimModuleSyntax": true,
908
- "noEmit": true,
909
- "resolveJsonModule": true,
910
- "skipLibCheck": true,
911
- "strict": true
912
- }
913
- }
914
-
915
- ```
916
-
917
- ## vite.config.ts
918
-
919
- ```typescript
920
- import { reactRouter } from "@react-router/dev/vite";
921
- import tailwindcss from "@tailwindcss/vite";
922
- import { defineConfig } from "vite";
923
- import tsconfigPaths from "vite-tsconfig-paths";
924
-
925
- export default defineConfig({
926
- plugins: [tailwindcss(), reactRouter(), tsconfigPaths()],
927
- resolve: {
928
- dedupe: ["react", "react-dom", "@assistant-ui/react"],
929
- },
930
- optimizeDeps: {
931
- include: ["remark-gfm"],
932
- },
933
- });
934
-
935
- ```
936
-