@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,815 +0,0 @@
1
- # Example: with-artifacts
2
-
3
- ## app/api/chat/route.ts
4
-
5
- ```typescript
6
- import { openai } from "@ai-sdk/openai";
7
- import { convertToModelMessages, stepCountIs, streamText } from "ai";
8
- import type { UIMessage } from "ai";
9
- import {
10
- AISDKToolkit,
11
- unstable_injectInteractableContext,
12
- type AISDKToolkitToolsOptions,
13
- } from "@assistant-ui/ai-sdk";
14
- import toolkit from "../../toolkit";
15
-
16
- export const maxDuration = 30;
17
-
18
- const aiToolkit = new AISDKToolkit({ toolkit });
19
-
20
- type FrontendToolDefs = NonNullable<AISDKToolkitToolsOptions["frontend"]>;
21
-
22
- export async function POST(req: Request) {
23
- const {
24
- messages,
25
- tools: clientTools,
26
- }: {
27
- messages: UIMessage[];
28
- tools?: FrontendToolDefs;
29
- } = await req.json();
30
-
31
- const tools = await aiToolkit.tools({
32
- ...(clientTools && { frontend: clientTools }),
33
- });
34
-
35
- const result = streamText({
36
- model: openai("gpt-5.6-luna"),
37
- system:
38
- "You create functional HTML artifacts. When the user requests a webpage, interface, visualization, or other visual content, call the artifact tool with a short title and a complete HTML document. When an artifact already exists and the user requests a change, call update_artifact with its id and only the fields that changed. Do not put artifact HTML in a code block.",
39
- messages: await convertToModelMessages(
40
- unstable_injectInteractableContext(messages),
41
- ),
42
- stopWhen: stepCountIs(10),
43
- tools,
44
- });
45
-
46
- return result.toUIMessageStreamResponse();
47
- }
48
-
49
- ```
50
-
51
- ## app/artifact-state.ts
52
-
53
- ```typescript
54
- import { z } from "zod";
55
-
56
- export const artifactSchema = z.object({
57
- title: z.string().describe("A short title for the artifact."),
58
- code: z
59
- .string()
60
- .describe(
61
- "A complete HTML document with inline CSS and JavaScript when needed.",
62
- ),
63
- });
64
-
65
- export type ArtifactState = z.infer<typeof artifactSchema>;
66
-
67
- export const emptyArtifact: ArtifactState = {
68
- title: "Untitled artifact",
69
- code: "",
70
- };
71
-
72
- export const artifactDescription =
73
- "Create an interactive HTML artifact when the user asks for a webpage, interface, visualization, or other visual content. Provide a short title and a complete HTML document.";
74
-
75
- ```
76
-
77
- ## app/artifact-surface.tsx
78
-
79
- ```tsx
80
- "use client";
81
-
82
- import {
83
- createContext,
84
- useContext,
85
- useEffect,
86
- useMemo,
87
- useRef,
88
- useState,
89
- type ReactNode,
90
- } from "react";
91
- import {
92
- unstable_useInteractable,
93
- unstable_useInteractableVersions,
94
- useAuiState,
95
- type Unstable_InteractableToolRenderProps,
96
- } from "@assistant-ui/react";
97
- import {
98
- ArrowLeftIcon,
99
- CheckIcon,
100
- Code2Icon,
101
- EyeIcon,
102
- FileCode2Icon,
103
- HistoryIcon,
104
- Loader2Icon,
105
- PanelRightOpenIcon,
106
- SparklesIcon,
107
- XIcon,
108
- } from "lucide-react";
109
- import {
110
- artifactDescription,
111
- artifactSchema,
112
- emptyArtifact,
113
- type ArtifactState,
114
- } from "./artifact-state";
115
-
116
- type ArtifactSurfaceTarget = {
117
- id: string;
118
- name: "artifact";
119
- messageId: string;
120
- };
121
-
122
- type ArtifactSurfaceContextValue = {
123
- active: ArtifactSurfaceTarget | null;
124
- open: (target: ArtifactSurfaceTarget) => void;
125
- close: () => void;
126
- returnToOrigin: () => void;
127
- };
128
-
129
- const ArtifactSurfaceContext =
130
- createContext<ArtifactSurfaceContextValue | null>(null);
131
-
132
- export function ArtifactSurfaceProvider({ children }: { children: ReactNode }) {
133
- const [active, setActive] = useState<ArtifactSurfaceTarget | null>(null);
134
-
135
- const value = useMemo<ArtifactSurfaceContextValue>(
136
- () => ({
137
- active,
138
- open: setActive,
139
- close: () => setActive(null),
140
- returnToOrigin: () => {
141
- const messageId = active?.messageId;
142
- setActive(null);
143
- if (!messageId) return;
144
- requestAnimationFrame(() => {
145
- const message = Array.from(
146
- document.querySelectorAll<HTMLElement>("[data-message-id]"),
147
- ).find((element) => element.dataset.messageId === messageId);
148
- message?.scrollIntoView({ behavior: "smooth", block: "center" });
149
- });
150
- },
151
- }),
152
- [active],
153
- );
154
-
155
- return (
156
- <ArtifactSurfaceContext.Provider value={value}>
157
- {children}
158
- </ArtifactSurfaceContext.Provider>
159
- );
160
- }
161
-
162
- export function useArtifactSurface() {
163
- const value = useContext(ArtifactSurfaceContext);
164
- if (!value) {
165
- throw new Error(
166
- "useArtifactSurface must be used within ArtifactSurfaceProvider",
167
- );
168
- }
169
- return value;
170
- }
171
-
172
- export function ArtifactTrigger({
173
- state,
174
- version,
175
- id,
176
- streaming,
177
- }: Unstable_InteractableToolRenderProps<ArtifactState>) {
178
- const messageId = useAuiState((s) => s.message.id);
179
- const { active, open } = useArtifactSurface();
180
- const displayState = version && !version.isLatest ? version.state : state;
181
- const title = displayState.title || "Untitled artifact";
182
- const lineCount = displayState.code
183
- ? displayState.code.split(/\r?\n/).length
184
- : 0;
185
- const isOpen = active?.id === id;
186
-
187
- return (
188
- <div className="bg-card my-3 overflow-hidden rounded-xl border shadow-[0_10px_30px_-22px_rgba(24,24,27,0.5)]">
189
- <div className="bg-muted text-muted-foreground flex items-center gap-2 border-b px-3 py-2 font-mono text-[10px] tracking-[0.16em] uppercase">
190
- <FileCode2Icon className="size-3.5" />
191
- HTML artifact
192
- {streaming ? (
193
- <span className="ml-auto inline-flex items-center gap-1.5 text-amber-700">
194
- <Loader2Icon className="size-3 animate-spin" />
195
- Writing
196
- </span>
197
- ) : (
198
- <span className="ml-auto inline-flex items-center gap-1.5 text-emerald-700">
199
- <CheckIcon className="size-3" />
200
- Ready
201
- </span>
202
- )}
203
- </div>
204
- <div className="flex items-center gap-4 p-3">
205
- <div className="min-w-0 flex-1">
206
- <p className="truncate text-sm font-semibold">{title}</p>
207
- <p className="text-muted-foreground mt-0.5 text-xs">
208
- {lineCount > 0 ? `${lineCount} lines` : "Preparing document"}
209
- {version && !version.isLatest ? " · historical version" : ""}
210
- </p>
211
- </div>
212
- <button
213
- type="button"
214
- data-testid="artifact-trigger"
215
- disabled={streaming}
216
- onClick={() =>
217
- open({
218
- id,
219
- name: "artifact",
220
- messageId,
221
- })
222
- }
223
- className="bg-primary text-primary-foreground hover:bg-primary/90 inline-flex h-9 shrink-0 items-center gap-2 rounded-lg px-3 text-xs font-medium transition-colors disabled:cursor-wait disabled:opacity-50"
224
- >
225
- <PanelRightOpenIcon className="size-3.5" />
226
- {isOpen ? "In workbench" : "Open workbench"}
227
- </button>
228
- </div>
229
- </div>
230
- );
231
- }
232
-
233
- export function ArtifactSurface() {
234
- const { active } = useArtifactSurface();
235
- if (!active) return null;
236
- return <ArtifactWorkbench key={active.id} target={active} />;
237
- }
238
-
239
- function ArtifactWorkbench({ target }: { target: ArtifactSurfaceTarget }) {
240
- const [state, { setState }] = unstable_useInteractable("artifact", {
241
- id: target.id,
242
- description: artifactDescription,
243
- stateSchema: artifactSchema,
244
- initialState: emptyArtifact,
245
- });
246
- const versions = unstable_useInteractableVersions<ArtifactState>(
247
- target.id,
248
- target.name,
249
- );
250
- const { close, returnToOrigin } = useArtifactSurface();
251
- const [view, setView] = useState<"preview" | "code">("preview");
252
- const [historyOpen, setHistoryOpen] = useState(false);
253
- const historyRef = useRef<HTMLDivElement>(null);
254
-
255
- useEffect(() => {
256
- if (!historyOpen) return;
257
- const dismissPointer = (event: PointerEvent) => {
258
- if (!historyRef.current?.contains(event.target as Node)) {
259
- setHistoryOpen(false);
260
- }
261
- };
262
- const dismissKey = (event: KeyboardEvent) => {
263
- if (event.key === "Escape") setHistoryOpen(false);
264
- };
265
- const dismissBlur = () => setHistoryOpen(false);
266
- document.addEventListener("pointerdown", dismissPointer);
267
- document.addEventListener("keydown", dismissKey);
268
- window.addEventListener("blur", dismissBlur);
269
- return () => {
270
- document.removeEventListener("pointerdown", dismissPointer);
271
- document.removeEventListener("keydown", dismissKey);
272
- window.removeEventListener("blur", dismissBlur);
273
- };
274
- }, [historyOpen]);
275
-
276
- return (
277
- <aside
278
- data-testid="artifact-surface"
279
- className="bg-muted fixed inset-0 z-30 flex min-w-0 flex-1 flex-col md:static md:z-0 md:border-l"
280
- >
281
- <header className="border-border bg-background/90 flex h-14 shrink-0 items-center gap-3 border-b px-3 backdrop-blur md:px-5">
282
- <div className="flex min-w-0 items-center gap-2">
283
- <span className="grid size-7 shrink-0 place-items-center rounded-lg bg-amber-300 text-zinc-950 shadow-[inset_0_0_0_1px_rgba(24,24,27,0.12)]">
284
- <SparklesIcon className="size-3.5" />
285
- </span>
286
- <div className="min-w-0">
287
- <p className="truncate text-sm font-semibold">
288
- {state.title || "Untitled artifact"}
289
- </p>
290
- <p className="text-muted-foreground font-mono text-[9px] tracking-[0.14em] uppercase">
291
- Opened from conversation
292
- </p>
293
- </div>
294
- </div>
295
-
296
- <div className="ml-auto flex items-center gap-1.5">
297
- <div className="relative" ref={historyRef}>
298
- <button
299
- type="button"
300
- data-testid="artifact-version-select"
301
- aria-label="Artifact version history"
302
- aria-expanded={historyOpen}
303
- onClick={() => setHistoryOpen((open) => !open)}
304
- className="border-border bg-card text-foreground hover:bg-muted inline-flex h-8 items-center gap-1.5 rounded-md border px-2.5 text-xs font-medium"
305
- >
306
- <HistoryIcon className="size-3.5" />
307
- {versions.length} {versions.length === 1 ? "version" : "versions"}
308
- </button>
309
- {historyOpen && (
310
- <div className="border-border bg-card absolute top-9 right-0 z-10 flex w-44 flex-col overflow-hidden rounded-md border py-1 shadow-lg">
311
- {versions.map((version, index) => (
312
- <button
313
- key={`${version.origin}-${index}`}
314
- type="button"
315
- onClick={() => {
316
- version.restore();
317
- setHistoryOpen(false);
318
- }}
319
- className="text-foreground hover:bg-muted flex items-center justify-between px-3 py-1.5 text-left text-xs"
320
- >
321
- <span>
322
- v{index + 1} ·{" "}
323
- {version.origin === "user-edit" ? "you" : "assistant"}
324
- </span>
325
- {index === versions.length - 1 && (
326
- <span className="text-muted-foreground font-mono text-[9px] uppercase">
327
- latest
328
- </span>
329
- )}
330
- </button>
331
- ))}
332
- </div>
333
- )}
334
- </div>
335
- <button
336
- type="button"
337
- data-testid="artifact-return"
338
- aria-label="Return to conversation"
339
- onClick={returnToOrigin}
340
- className="border-border bg-card text-foreground hover:bg-muted inline-flex h-8 items-center gap-1.5 rounded-md border px-2.5 text-xs font-medium"
341
- >
342
- <ArrowLeftIcon className="size-3.5" />
343
- <span className="hidden sm:inline">Conversation</span>
344
- </button>
345
- <button
346
- type="button"
347
- data-testid="artifact-close"
348
- onClick={close}
349
- className="text-muted-foreground hover:bg-muted hover:text-foreground grid size-8 place-items-center rounded-md"
350
- aria-label="Close artifact"
351
- >
352
- <XIcon className="size-4" />
353
- </button>
354
- </div>
355
- </header>
356
-
357
- <div className="flex min-h-0 flex-1 flex-col p-2 md:p-4">
358
- <div className="border-border bg-card flex min-h-0 flex-1 flex-col overflow-hidden rounded-xl border shadow-[0_24px_70px_-44px_rgba(24,24,27,0.55)]">
359
- <div className="bg-muted/80 flex shrink-0 items-center gap-1 border-b p-1.5">
360
- <button
361
- type="button"
362
- aria-pressed={view === "preview"}
363
- onClick={() => setView("preview")}
364
- className={`inline-flex h-8 items-center gap-2 rounded-md px-3 text-xs font-medium transition-colors ${
365
- view === "preview"
366
- ? "bg-card text-foreground ring-border shadow-sm ring-1"
367
- : "text-muted-foreground hover:text-foreground"
368
- }`}
369
- >
370
- <EyeIcon className="size-3.5" />
371
- Preview
372
- </button>
373
- <button
374
- type="button"
375
- aria-pressed={view === "code"}
376
- onClick={() => setView("code")}
377
- className={`inline-flex h-8 items-center gap-2 rounded-md px-3 text-xs font-medium transition-colors ${
378
- view === "code"
379
- ? "bg-card text-foreground ring-border shadow-sm ring-1"
380
- : "text-muted-foreground hover:text-foreground"
381
- }`}
382
- >
383
- <Code2Icon className="size-3.5" />
384
- Source
385
- </button>
386
- <span className="text-muted-foreground ml-auto pr-2 font-mono text-[9px] tracking-[0.14em] uppercase">
387
- Live document
388
- </span>
389
- </div>
390
-
391
- {view === "preview" ? (
392
- <iframe
393
- data-testid="artifact-preview"
394
- title={`Preview of ${state.title || "artifact"}`}
395
- srcDoc={state.code}
396
- sandbox="allow-scripts allow-forms"
397
- className="min-h-0 flex-1 bg-white"
398
- />
399
- ) : (
400
- <div className="flex min-h-0 flex-1 flex-col">
401
- <input
402
- aria-label="Artifact title"
403
- value={state.title}
404
- onChange={(event) =>
405
- setState((previous) => ({
406
- ...previous,
407
- title: event.target.value,
408
- }))
409
- }
410
- className="placeholder:text-muted-foreground h-11 shrink-0 border-b px-4 text-sm font-semibold outline-none"
411
- placeholder="Artifact title"
412
- />
413
- <textarea
414
- data-testid="artifact-code-editor"
415
- aria-label="Artifact HTML source"
416
- value={state.code}
417
- onChange={(event) =>
418
- setState((previous) => ({
419
- ...previous,
420
- code: event.target.value,
421
- }))
422
- }
423
- spellCheck={false}
424
- className="min-h-0 flex-1 resize-none bg-zinc-950 p-4 font-mono text-[13px] leading-6 text-zinc-100 outline-none selection:bg-amber-300 selection:text-zinc-950"
425
- />
426
- </div>
427
- )}
428
- </div>
429
- </div>
430
- </aside>
431
- );
432
- }
433
-
434
- ```
435
-
436
- ## app/globals.css
437
-
438
- ```css
439
- @import "tailwindcss";
440
- @import "tw-animate-css";
441
-
442
- @source "../../../packages/ui/src";
443
-
444
- @custom-variant dark (&:is(.dark *));
445
-
446
- @theme inline {
447
- --radius-sm: calc(var(--radius) - 4px);
448
- --radius-md: calc(var(--radius) - 2px);
449
- --radius-lg: var(--radius);
450
- --radius-xl: calc(var(--radius) + 4px);
451
- --color-background: var(--background);
452
- --color-foreground: var(--foreground);
453
- --color-card: var(--card);
454
- --color-card-foreground: var(--card-foreground);
455
- --color-popover: var(--popover);
456
- --color-popover-foreground: var(--popover-foreground);
457
- --color-primary: var(--primary);
458
- --color-primary-foreground: var(--primary-foreground);
459
- --color-secondary: var(--secondary);
460
- --color-secondary-foreground: var(--secondary-foreground);
461
- --color-muted: var(--muted);
462
- --color-muted-foreground: var(--muted-foreground);
463
- --color-accent: var(--accent);
464
- --color-accent-foreground: var(--accent-foreground);
465
- --color-destructive: var(--destructive);
466
- --color-border: var(--border);
467
- --color-input: var(--input);
468
- --color-ring: var(--ring);
469
- --color-chart-1: var(--chart-1);
470
- --color-chart-2: var(--chart-2);
471
- --color-chart-3: var(--chart-3);
472
- --color-chart-4: var(--chart-4);
473
- --color-chart-5: var(--chart-5);
474
- --color-sidebar: var(--sidebar);
475
- --color-sidebar-foreground: var(--sidebar-foreground);
476
- --color-sidebar-primary: var(--sidebar-primary);
477
- --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
478
- --color-sidebar-accent: var(--sidebar-accent);
479
- --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
480
- --color-sidebar-border: var(--sidebar-border);
481
- --color-sidebar-ring: var(--sidebar-ring);
482
- }
483
-
484
- :root {
485
- --radius: 0.625rem;
486
- --background: oklch(1 0 0);
487
- --foreground: oklch(0.141 0.005 285.823);
488
- --card: oklch(1 0 0);
489
- --card-foreground: oklch(0.141 0.005 285.823);
490
- --popover: oklch(1 0 0);
491
- --popover-foreground: oklch(0.141 0.005 285.823);
492
- --primary: oklch(0.21 0.006 285.885);
493
- --primary-foreground: oklch(0.985 0 0);
494
- --secondary: oklch(0.967 0.001 286.375);
495
- --secondary-foreground: oklch(0.21 0.006 285.885);
496
- --muted: oklch(0.967 0.001 286.375);
497
- --muted-foreground: oklch(0.552 0.016 285.938);
498
- --accent: oklch(0.967 0.001 286.375);
499
- --accent-foreground: oklch(0.21 0.006 285.885);
500
- --destructive: oklch(0.577 0.245 27.325);
501
- --border: oklch(0.92 0.004 286.32);
502
- --input: oklch(0.92 0.004 286.32);
503
- --ring: oklch(0.705 0.015 286.067);
504
- --chart-1: oklch(0.646 0.222 41.116);
505
- --chart-2: oklch(0.6 0.118 184.704);
506
- --chart-3: oklch(0.398 0.07 227.392);
507
- --chart-4: oklch(0.828 0.189 84.429);
508
- --chart-5: oklch(0.769 0.188 70.08);
509
- --sidebar: oklch(0.985 0 0);
510
- --sidebar-foreground: oklch(0.141 0.005 285.823);
511
- --sidebar-primary: oklch(0.21 0.006 285.885);
512
- --sidebar-primary-foreground: oklch(0.985 0 0);
513
- --sidebar-accent: oklch(0.967 0.001 286.375);
514
- --sidebar-accent-foreground: oklch(0.21 0.006 285.885);
515
- --sidebar-border: oklch(0.92 0.004 286.32);
516
- --sidebar-ring: oklch(0.705 0.015 286.067);
517
- }
518
-
519
- .dark {
520
- --background: oklch(0.141 0.005 285.823);
521
- --foreground: oklch(0.985 0 0);
522
- --card: oklch(0.21 0.006 285.885);
523
- --card-foreground: oklch(0.985 0 0);
524
- --popover: oklch(0.21 0.006 285.885);
525
- --popover-foreground: oklch(0.985 0 0);
526
- --primary: oklch(0.92 0.004 286.32);
527
- --primary-foreground: oklch(0.21 0.006 285.885);
528
- --secondary: oklch(0.274 0.006 286.033);
529
- --secondary-foreground: oklch(0.985 0 0);
530
- --muted: oklch(0.274 0.006 286.033);
531
- --muted-foreground: oklch(0.705 0.015 286.067);
532
- --accent: oklch(0.274 0.006 286.033);
533
- --accent-foreground: oklch(0.985 0 0);
534
- --destructive: oklch(0.704 0.191 22.216);
535
- --border: oklch(1 0 0 / 10%);
536
- --input: oklch(1 0 0 / 15%);
537
- --ring: oklch(0.552 0.016 285.938);
538
- --chart-1: oklch(0.488 0.243 264.376);
539
- --chart-2: oklch(0.696 0.17 162.48);
540
- --chart-3: oklch(0.769 0.188 70.08);
541
- --chart-4: oklch(0.627 0.265 303.9);
542
- --chart-5: oklch(0.645 0.246 16.439);
543
- --sidebar: oklch(0.21 0.006 285.885);
544
- --sidebar-foreground: oklch(0.985 0 0);
545
- --sidebar-primary: oklch(0.488 0.243 264.376);
546
- --sidebar-primary-foreground: oklch(0.985 0 0);
547
- --sidebar-accent: oklch(0.274 0.006 286.033);
548
- --sidebar-accent-foreground: oklch(0.985 0 0);
549
- --sidebar-border: oklch(1 0 0 / 10%);
550
- --sidebar-ring: oklch(0.552 0.016 285.938);
551
- }
552
-
553
- @layer base {
554
- * {
555
- @apply border-border outline-ring/50;
556
- }
557
- body {
558
- @apply bg-background text-foreground;
559
- }
560
- }
561
-
562
- ```
563
-
564
- ## app/layout.tsx
565
-
566
- ```tsx
567
- import type { Metadata } from "next";
568
- import "./globals.css";
569
-
570
- export const metadata: Metadata = {
571
- title: "assistant-ui Artifacts Example",
572
- description: "Example using assistant-ui with HTML artifact rendering",
573
- };
574
-
575
- export default function RootLayout({
576
- children,
577
- }: Readonly<{
578
- children: React.ReactNode;
579
- }>) {
580
- return (
581
- <html lang="en">
582
- <body className="h-dvh">{children}</body>
583
- </html>
584
- );
585
- }
586
-
587
- ```
588
-
589
- ## app/page.tsx
590
-
591
- ```tsx
592
- "use client";
593
-
594
- import { Thread } from "@/components/assistant-ui/thread";
595
- import {
596
- AssistantRuntimeProvider,
597
- AuiProvider,
598
- AuiConfig,
599
- Suggestions,
600
- Tools,
601
- unstable_Interactables,
602
- useAui,
603
- } from "@assistant-ui/react";
604
- import { useChatRuntime } from "@assistant-ui/ai-sdk";
605
- import { lastAssistantMessageIsCompleteWithToolCalls } from "ai";
606
- import {
607
- ArtifactSurface,
608
- ArtifactSurfaceProvider,
609
- useArtifactSurface,
610
- } from "./artifact-surface";
611
- import toolkit from "./toolkit";
612
-
613
- function ArtifactExperience() {
614
- const { active } = useArtifactSurface();
615
-
616
- return (
617
- <main className="bg-background flex h-full min-h-0 overflow-hidden">
618
- <section
619
- className={
620
- active
621
- ? "bg-background hidden min-w-0 md:block md:w-[min(44vw,42rem)] md:shrink-0"
622
- : "bg-background min-w-0 flex-1"
623
- }
624
- >
625
- <Thread />
626
- </section>
627
- <ArtifactSurface />
628
- </main>
629
- );
630
- }
631
-
632
- function ArtifactScopes() {
633
- const aui = useAui();
634
- const config = AuiConfig({
635
- tools: Tools({ toolkit }),
636
- unstable_interactables: unstable_Interactables(),
637
- suggestions: Suggestions([
638
- {
639
- title: "Build a landing page",
640
- label: "with modern styling",
641
- prompt:
642
- "Build a beautiful landing page for a coffee shop with modern CSS.",
643
- },
644
- {
645
- title: "Create a calculator",
646
- label: "with HTML and JavaScript",
647
- prompt:
648
- "Create a calculator app with HTML, CSS, and JavaScript that supports basic arithmetic.",
649
- },
650
- ]),
651
- });
652
-
653
- return (
654
- <AuiProvider extends={aui} config={config}>
655
- <ArtifactSurfaceProvider>
656
- <ArtifactExperience />
657
- </ArtifactSurfaceProvider>
658
- </AuiProvider>
659
- );
660
- }
661
-
662
- export default function Home() {
663
- const runtime = useChatRuntime({
664
- sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
665
- });
666
-
667
- return (
668
- <AssistantRuntimeProvider runtime={runtime}>
669
- <ArtifactScopes />
670
- </AssistantRuntimeProvider>
671
- );
672
- }
673
-
674
- ```
675
-
676
- ## app/toolkit.tsx
677
-
678
- ```tsx
679
- "use generative";
680
-
681
- import { defineToolkit, unstable_interactableTool } from "@assistant-ui/react";
682
- import { ArtifactTrigger } from "./artifact-surface";
683
- import { artifactDescription, artifactSchema } from "./artifact-state";
684
-
685
- export default defineToolkit({
686
- artifact: unstable_interactableTool({
687
- description: artifactDescription,
688
- stateSchema: artifactSchema,
689
- render: (props) => <ArtifactTrigger {...props} />,
690
- }),
691
- });
692
-
693
- ```
694
-
695
- ## components.json
696
-
697
- ```json
698
- {
699
- "$schema": "https://ui.shadcn.com/schema.json",
700
- "style": "new-york",
701
- "rsc": true,
702
- "tsx": true,
703
- "tailwind": {
704
- "config": "",
705
- "css": "app/globals.css",
706
- "baseColor": "zinc",
707
- "cssVariables": true,
708
- "prefix": ""
709
- },
710
- "aliases": {
711
- "components": "@/components",
712
- "utils": "@/lib/utils",
713
- "ui": "@/components/ui",
714
- "lib": "@/lib",
715
- "hooks": "@/hooks"
716
- },
717
- "iconLibrary": "lucide",
718
- "registries": {
719
- "@assistant-ui": "https://r.assistant-ui.com/{name}.json"
720
- }
721
- }
722
-
723
- ```
724
-
725
- ## next.config.js
726
-
727
- ```javascript
728
- import { withAui } from "@assistant-ui/next";
729
- /** @type {import('next').NextConfig} */
730
- const nextConfig = {
731
- transpilePackages: [
732
- "@assistant-ui/react",
733
- "@assistant-ui/ai-sdk",
734
- "@assistant-ui/react-markdown",
735
- ],
736
- };
737
-
738
- export default withAui(nextConfig);
739
-
740
- ```
741
-
742
- ## package.json
743
-
744
- ```json
745
- {
746
- "name": "with-artifacts",
747
- "version": "0.0.0",
748
- "private": true,
749
- "type": "module",
750
- "scripts": {
751
- "dev": "next dev",
752
- "build": "next build",
753
- "start": "next start"
754
- },
755
- "dependencies": {
756
- "@ai-sdk/openai": "^4.0.46",
757
- "@assistant-ui/ai-sdk": "workspace:*",
758
- "@assistant-ui/react": "workspace:*",
759
- "@assistant-ui/react-markdown": "workspace:*",
760
- "@assistant-ui/ui": "workspace:*",
761
- "ai": "^7.0.77",
762
- "class-variance-authority": "^0.7.1",
763
- "clsx": "^2.1.1",
764
- "lucide-react": "^1.33.0",
765
- "next": "^16.3.2",
766
- "react": "^19.2.8",
767
- "react-dom": "^19.2.8",
768
- "tailwind-merge": "^3.6.0",
769
- "zod": "^4.4.3"
770
- },
771
- "devDependencies": {
772
- "@assistant-ui/next": "workspace:*",
773
- "@assistant-ui/x-buildutils": "workspace:*",
774
- "@tailwindcss/postcss": "^4.3.3",
775
- "@types/node": "^26.2.0",
776
- "@types/react": "^19.2.18",
777
- "@types/react-dom": "^19.2.5",
778
- "postcss": "^8.5.26",
779
- "tailwindcss": "^4.3.3",
780
- "tw-animate-css": "^1.4.0",
781
- "typescript": "^7.0.2"
782
- }
783
- }
784
-
785
- ```
786
-
787
- ## tsconfig.json
788
-
789
- ```json
790
- {
791
- "extends": "@assistant-ui/x-buildutils/ts/next",
792
- "compilerOptions": {
793
- "paths": {
794
- "@/*": ["./*"],
795
- "@/components/assistant-ui/*": [
796
- "../../packages/ui/src/components/assistant-ui/*"
797
- ],
798
- "@/hooks/*": ["../../packages/ui/src/hooks/*"],
799
- "@/components/ui/*": [
800
- "../../packages/ui/src/components/ui/base/*",
801
- "../../packages/ui/src/components/ui/radix/*"
802
- ],
803
- "@/components/ui/radix/*": [
804
- "../../packages/ui/src/components/ui/radix/*"
805
- ],
806
- "@/lib/utils": ["../../packages/ui/src/lib/utils"],
807
- "@assistant-ui/ui/*": ["../../packages/ui/src/*"]
808
- }
809
- },
810
- "include": ["**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
811
- "exclude": ["node_modules"]
812
- }
813
-
814
- ```
815
-