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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (459) hide show
  1. package/README.md +16 -43
  2. package/dist/index.d.ts +2 -3
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +3 -91
  5. package/dist/index.js.map +1 -1
  6. package/dist/proxy.d.ts +9 -0
  7. package/dist/proxy.d.ts.map +1 -0
  8. package/dist/proxy.js +76 -0
  9. package/dist/proxy.js.map +1 -0
  10. package/package.json +9 -13
  11. package/src/index.ts +3 -115
  12. package/src/proxy.test.ts +250 -0
  13. package/src/proxy.ts +111 -0
  14. package/.docs/organized/code-examples/waterfall.md +0 -807
  15. package/.docs/organized/code-examples/with-a2a.md +0 -674
  16. package/.docs/organized/code-examples/with-ag-ui.md +0 -552
  17. package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -465
  18. package/.docs/organized/code-examples/with-artifacts.md +0 -814
  19. package/.docs/organized/code-examples/with-assistant-transport.md +0 -575
  20. package/.docs/organized/code-examples/with-browser-extension.md +0 -371
  21. package/.docs/organized/code-examples/with-chain-of-thought.md +0 -960
  22. package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
  23. package/.docs/organized/code-examples/with-cloud.md +0 -438
  24. package/.docs/organized/code-examples/with-custom-thread-list.md +0 -568
  25. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -526
  26. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -696
  27. package/.docs/organized/code-examples/with-eve.md +0 -404
  28. package/.docs/organized/code-examples/with-expo.md +0 -2063
  29. package/.docs/organized/code-examples/with-external-store.md +0 -420
  30. package/.docs/organized/code-examples/with-ffmpeg.md +0 -828
  31. package/.docs/organized/code-examples/with-generative-ui.md +0 -1812
  32. package/.docs/organized/code-examples/with-google-adk.md +0 -367
  33. package/.docs/organized/code-examples/with-heat-graph.md +0 -304
  34. package/.docs/organized/code-examples/with-image-generation.md +0 -462
  35. package/.docs/organized/code-examples/with-interactables.md +0 -732
  36. package/.docs/organized/code-examples/with-langchain.md +0 -445
  37. package/.docs/organized/code-examples/with-langgraph.md +0 -854
  38. package/.docs/organized/code-examples/with-livekit.md +0 -642
  39. package/.docs/organized/code-examples/with-mcp.md +0 -780
  40. package/.docs/organized/code-examples/with-nuxt.md +0 -2428
  41. package/.docs/organized/code-examples/with-opencode.md +0 -1974
  42. package/.docs/organized/code-examples/with-openui.md +0 -449
  43. package/.docs/organized/code-examples/with-pi.md +0 -2083
  44. package/.docs/organized/code-examples/with-react-hook-form.md +0 -724
  45. package/.docs/organized/code-examples/with-react-ink-web.md +0 -690
  46. package/.docs/organized/code-examples/with-react-ink.md +0 -472
  47. package/.docs/organized/code-examples/with-react-router.md +0 -935
  48. package/.docs/organized/code-examples/with-resumable-stream.md +0 -667
  49. package/.docs/organized/code-examples/with-store.md +0 -679
  50. package/.docs/organized/code-examples/with-svelte.md +0 -415
  51. package/.docs/organized/code-examples/with-sveltekit.md +0 -1061
  52. package/.docs/organized/code-examples/with-tanstack.md +0 -811
  53. package/.docs/organized/code-examples/with-tap-runtime.md +0 -812
  54. package/.docs/organized/code-examples/with-virtualized-thread.md +0 -680
  55. package/.docs/organized/code-examples/with-vue.md +0 -408
  56. package/.docs/raw/docs/(docs)/architecture.mdx +0 -146
  57. package/.docs/raw/docs/(docs)/base-ui.mdx +0 -39
  58. package/.docs/raw/docs/(docs)/cli.mdx +0 -542
  59. package/.docs/raw/docs/(docs)/devtools.mdx +0 -79
  60. package/.docs/raw/docs/(docs)/index.mdx +0 -21
  61. package/.docs/raw/docs/(docs)/installation.mdx +0 -483
  62. package/.docs/raw/docs/(docs)/llm.mdx +0 -211
  63. package/.docs/raw/docs/(docs)/rtl.mdx +0 -78
  64. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +0 -36
  65. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +0 -20
  66. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +0 -34
  67. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +0 -44
  68. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +0 -59
  69. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +0 -20
  70. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +0 -20
  71. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -84
  72. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +0 -22
  73. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +0 -64
  74. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +0 -22
  75. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +0 -52
  76. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +0 -49
  77. package/.docs/raw/docs/(reference)/api-reference/generative-ui/a2ui.mdx +0 -40
  78. package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +0 -56
  79. package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +0 -86
  80. package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +0 -39
  81. package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +0 -42
  82. package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +0 -84
  83. package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +0 -85
  84. package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +0 -45
  85. package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +0 -93
  86. package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +0 -62
  87. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +0 -129
  88. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +0 -31
  89. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +0 -34
  90. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +0 -350
  91. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +0 -28
  92. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +0 -97
  93. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
  94. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -97
  95. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
  96. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +0 -200
  97. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -37
  98. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +0 -50
  99. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +0 -22
  100. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +0 -20
  101. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +0 -566
  102. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +0 -152
  103. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +0 -239
  104. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -208
  105. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +0 -108
  106. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -99
  107. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -145
  108. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +0 -82
  109. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +0 -619
  110. package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -22
  111. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -65
  112. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +0 -73
  113. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +0 -117
  114. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -339
  115. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +0 -77
  116. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +0 -88
  117. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -81
  118. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -129
  119. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +0 -138
  120. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +0 -122
  121. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -289
  122. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -20
  123. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +0 -24
  124. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +0 -32
  125. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +0 -43
  126. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +0 -43
  127. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +0 -24
  128. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +0 -20
  129. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -24
  130. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -24
  131. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +0 -36
  132. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +0 -85
  133. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +0 -45
  134. package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx +0 -55
  135. package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +0 -151
  136. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +0 -106
  137. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -62
  138. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +0 -178
  139. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +0 -48
  140. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +0 -62
  141. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +0 -22
  142. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +0 -19
  143. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +0 -149
  144. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +0 -22
  145. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +0 -54
  146. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +0 -36
  147. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +0 -527
  148. package/.docs/raw/docs/cloud/ai-sdk.mdx +0 -602
  149. package/.docs/raw/docs/cloud/authorization.mdx +0 -252
  150. package/.docs/raw/docs/cloud/index.mdx +0 -46
  151. package/.docs/raw/docs/cloud/langgraph.mdx +0 -554
  152. package/.docs/raw/docs/copilots/assistant-frame.mdx +0 -400
  153. package/.docs/raw/docs/copilots/make-assistant-visible.mdx +0 -82
  154. package/.docs/raw/docs/copilots/model-context.mdx +0 -156
  155. package/.docs/raw/docs/copilots/motivation.mdx +0 -202
  156. package/.docs/raw/docs/copilots/use-assistant-instructions.mdx +0 -64
  157. package/.docs/raw/docs/guides/attachments.mdx +0 -619
  158. package/.docs/raw/docs/guides/branching.mdx +0 -76
  159. package/.docs/raw/docs/guides/chain-of-thought.mdx +0 -164
  160. package/.docs/raw/docs/guides/chatgpt-subscription.mdx +0 -108
  161. package/.docs/raw/docs/guides/context-api.mdx +0 -619
  162. package/.docs/raw/docs/guides/dictation.mdx +0 -298
  163. package/.docs/raw/docs/guides/editing.mdx +0 -102
  164. package/.docs/raw/docs/guides/electron.mdx +0 -369
  165. package/.docs/raw/docs/guides/headless-composer-input.mdx +0 -113
  166. package/.docs/raw/docs/guides/image-generation.mdx +0 -74
  167. package/.docs/raw/docs/guides/index.mdx +0 -117
  168. package/.docs/raw/docs/guides/input-history.mdx +0 -55
  169. package/.docs/raw/docs/guides/latex.mdx +0 -158
  170. package/.docs/raw/docs/guides/mentions.mdx +0 -575
  171. package/.docs/raw/docs/guides/message-timing.mdx +0 -209
  172. package/.docs/raw/docs/guides/quoting.mdx +0 -169
  173. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +0 -212
  174. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +0 -152
  175. package/.docs/raw/docs/guides/resumable-streams.mdx +0 -292
  176. package/.docs/raw/docs/guides/slash-commands.mdx +0 -358
  177. package/.docs/raw/docs/guides/speech.mdx +0 -172
  178. package/.docs/raw/docs/guides/suggestions.mdx +0 -384
  179. package/.docs/raw/docs/guides/virtualization.mdx +0 -133
  180. package/.docs/raw/docs/guides/voice.mdx +0 -310
  181. package/.docs/raw/docs/ink/adapters.mdx +0 -99
  182. package/.docs/raw/docs/ink/custom-backend.mdx +0 -254
  183. package/.docs/raw/docs/ink/hooks.mdx +0 -469
  184. package/.docs/raw/docs/ink/index.mdx +0 -236
  185. package/.docs/raw/docs/ink/migration.mdx +0 -138
  186. package/.docs/raw/docs/ink/primitives.mdx +0 -1259
  187. package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +0 -528
  188. package/.docs/raw/docs/integrations/auth/better-auth.mdx +0 -188
  189. package/.docs/raw/docs/integrations/auth/clerk.mdx +0 -166
  190. package/.docs/raw/docs/integrations/auth/next-auth.mdx +0 -191
  191. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +0 -88
  192. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +0 -282
  193. package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +0 -188
  194. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +0 -57
  195. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +0 -201
  196. package/.docs/raw/docs/integrations/gateways/index.mdx +0 -162
  197. package/.docs/raw/docs/integrations/index.mdx +0 -178
  198. package/.docs/raw/docs/integrations/observability/helicone.mdx +0 -129
  199. package/.docs/raw/docs/integrations/observability/langfuse.mdx +0 -161
  200. package/.docs/raw/docs/integrations/observability/langsmith.mdx +0 -151
  201. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +0 -773
  202. package/.docs/raw/docs/migrations/deprecation-policy.mdx +0 -42
  203. package/.docs/raw/docs/migrations/index.mdx +0 -50
  204. package/.docs/raw/docs/migrations/react-compatibility.mdx +0 -74
  205. package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +0 -328
  206. package/.docs/raw/docs/migrations/toolkit-tools.mdx +0 -236
  207. package/.docs/raw/docs/migrations/v0-11.mdx +0 -172
  208. package/.docs/raw/docs/migrations/v0-12.mdx +0 -302
  209. package/.docs/raw/docs/migrations/v0-14.mdx +0 -297
  210. package/.docs/raw/docs/migrations/v0-15.mdx +0 -270
  211. package/.docs/raw/docs/primitives/action-bar.mdx +0 -352
  212. package/.docs/raw/docs/primitives/assistant-modal.mdx +0 -216
  213. package/.docs/raw/docs/primitives/attachment.mdx +0 -217
  214. package/.docs/raw/docs/primitives/branch-picker.mdx +0 -222
  215. package/.docs/raw/docs/primitives/chain-of-thought.mdx +0 -315
  216. package/.docs/raw/docs/primitives/composer.mdx +0 -659
  217. package/.docs/raw/docs/primitives/error.mdx +0 -142
  218. package/.docs/raw/docs/primitives/index.mdx +0 -99
  219. package/.docs/raw/docs/primitives/message.mdx +0 -618
  220. package/.docs/raw/docs/primitives/selection-toolbar.mdx +0 -191
  221. package/.docs/raw/docs/primitives/suggestion.mdx +0 -254
  222. package/.docs/raw/docs/primitives/thread-list.mdx +0 -467
  223. package/.docs/raw/docs/primitives/thread.mdx +0 -509
  224. package/.docs/raw/docs/react-native/adapters.mdx +0 -94
  225. package/.docs/raw/docs/react-native/custom-backend.mdx +0 -207
  226. package/.docs/raw/docs/react-native/hooks.mdx +0 -339
  227. package/.docs/raw/docs/react-native/index.mdx +0 -289
  228. package/.docs/raw/docs/react-native/migration.mdx +0 -142
  229. package/.docs/raw/docs/react-native/primitives.mdx +0 -839
  230. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +0 -399
  231. package/.docs/raw/docs/runtimes/a2a/overview.mdx +0 -60
  232. package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +0 -216
  233. package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +0 -124
  234. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +0 -70
  235. package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +0 -243
  236. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +0 -255
  237. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +0 -61
  238. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -122
  239. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +0 -135
  240. package/.docs/raw/docs/runtimes/ai-sdk/v6-legacy.mdx +0 -636
  241. package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +0 -716
  242. package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +0 -118
  243. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +0 -265
  244. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +0 -167
  245. package/.docs/raw/docs/runtimes/concepts/stability.mdx +0 -68
  246. package/.docs/raw/docs/runtimes/concepts/threads.mdx +0 -513
  247. package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +0 -763
  248. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +0 -339
  249. package/.docs/raw/docs/runtimes/custom/external-store.mdx +0 -957
  250. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +0 -902
  251. package/.docs/raw/docs/runtimes/custom/overview.mdx +0 -71
  252. package/.docs/raw/docs/runtimes/eve/overview.mdx +0 -151
  253. package/.docs/raw/docs/runtimes/eve/quickstart.mdx +0 -192
  254. package/.docs/raw/docs/runtimes/google-adk/api.mdx +0 -256
  255. package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +0 -784
  256. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +0 -69
  257. package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +0 -229
  258. package/.docs/raw/docs/runtimes/langchain.mdx +0 -901
  259. package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +0 -181
  260. package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +0 -305
  261. package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +0 -104
  262. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +0 -84
  263. package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +0 -496
  264. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +0 -144
  265. package/.docs/raw/docs/runtimes/langgraph/threads.mdx +0 -113
  266. package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +0 -29
  267. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -93
  268. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +0 -347
  269. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -393
  270. package/.docs/raw/docs/runtimes/opencode/hooks.mdx +0 -194
  271. package/.docs/raw/docs/runtimes/opencode/overview.mdx +0 -58
  272. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +0 -119
  273. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +0 -133
  274. package/.docs/raw/docs/tools/a2ui.mdx +0 -107
  275. package/.docs/raw/docs/tools/backend.mdx +0 -147
  276. package/.docs/raw/docs/tools/defining-tools.mdx +0 -574
  277. package/.docs/raw/docs/tools/dynamic-tools.mdx +0 -112
  278. package/.docs/raw/docs/tools/generative-ui-primitive.mdx +0 -180
  279. package/.docs/raw/docs/tools/generative-ui-slack.mdx +0 -167
  280. package/.docs/raw/docs/tools/generative-ui-teams.mdx +0 -160
  281. package/.docs/raw/docs/tools/generative-ui.mdx +0 -322
  282. package/.docs/raw/docs/tools/index.mdx +0 -72
  283. package/.docs/raw/docs/tools/interactables.mdx +0 -1084
  284. package/.docs/raw/docs/tools/mcp-apps.mdx +0 -346
  285. package/.docs/raw/docs/tools/mcp.mdx +0 -466
  286. package/.docs/raw/docs/tools/multi-agent.mdx +0 -237
  287. package/.docs/raw/docs/tools/openui.mdx +0 -175
  288. package/.docs/raw/docs/tools/tool-ui.mdx +0 -1008
  289. package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
  290. package/.docs/raw/docs/ui/accordion.mdx +0 -266
  291. package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
  292. package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
  293. package/.docs/raw/docs/ui/attachment.mdx +0 -259
  294. package/.docs/raw/docs/ui/badge.mdx +0 -150
  295. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -212
  296. package/.docs/raw/docs/ui/context-display.mdx +0 -148
  297. package/.docs/raw/docs/ui/diff-viewer.mdx +0 -280
  298. package/.docs/raw/docs/ui/directive-text.mdx +0 -114
  299. package/.docs/raw/docs/ui/dot-matrix.mdx +0 -133
  300. package/.docs/raw/docs/ui/file.mdx +0 -159
  301. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
  302. package/.docs/raw/docs/ui/image.mdx +0 -102
  303. package/.docs/raw/docs/ui/markdown.mdx +0 -64
  304. package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
  305. package/.docs/raw/docs/ui/mermaid.mdx +0 -92
  306. package/.docs/raw/docs/ui/message-timing.mdx +0 -93
  307. package/.docs/raw/docs/ui/model-selector.mdx +0 -455
  308. package/.docs/raw/docs/ui/number-roll.mdx +0 -154
  309. package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
  310. package/.docs/raw/docs/ui/quote.mdx +0 -211
  311. package/.docs/raw/docs/ui/reasoning.mdx +0 -186
  312. package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
  313. package/.docs/raw/docs/ui/select.mdx +0 -254
  314. package/.docs/raw/docs/ui/sources.mdx +0 -177
  315. package/.docs/raw/docs/ui/streamdown.mdx +0 -392
  316. package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
  317. package/.docs/raw/docs/ui/tabs.mdx +0 -271
  318. package/.docs/raw/docs/ui/thread-list.mdx +0 -372
  319. package/.docs/raw/docs/ui/thread.mdx +0 -512
  320. package/.docs/raw/docs/ui/tool-fallback.mdx +0 -127
  321. package/.docs/raw/docs/ui/tool-group.mdx +0 -240
  322. package/.docs/raw/docs/ui/voice.mdx +0 -173
  323. package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
  324. package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
  325. package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
  326. package/dist/constants.d.ts +0 -14
  327. package/dist/constants.d.ts.map +0 -1
  328. package/dist/constants.js +0 -19
  329. package/dist/constants.js.map +0 -1
  330. package/dist/prepare-docs/code-examples.d.ts +0 -5
  331. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  332. package/dist/prepare-docs/code-examples.js +0 -117
  333. package/dist/prepare-docs/code-examples.js.map +0 -1
  334. package/dist/prepare-docs/copy-raw.d.ts +0 -5
  335. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  336. package/dist/prepare-docs/copy-raw.js +0 -49
  337. package/dist/prepare-docs/copy-raw.js.map +0 -1
  338. package/dist/prepare-docs/prepare.d.ts +0 -1
  339. package/dist/prepare-docs/prepare.js +0 -22
  340. package/dist/prepare-docs/prepare.js.map +0 -1
  341. package/dist/prompts/xulux-playground.d.ts +0 -12
  342. package/dist/prompts/xulux-playground.d.ts.map +0 -1
  343. package/dist/prompts/xulux-playground.js +0 -33
  344. package/dist/prompts/xulux-playground.js.map +0 -1
  345. package/dist/tools/docs.d.ts +0 -22
  346. package/dist/tools/docs.d.ts.map +0 -1
  347. package/dist/tools/docs.js +0 -177
  348. package/dist/tools/docs.js.map +0 -1
  349. package/dist/tools/examples.d.ts +0 -24
  350. package/dist/tools/examples.d.ts.map +0 -1
  351. package/dist/tools/examples.js +0 -87
  352. package/dist/tools/examples.js.map +0 -1
  353. package/dist/tools/resources.d.ts +0 -6
  354. package/dist/tools/resources.d.ts.map +0 -1
  355. package/dist/tools/resources.js +0 -75
  356. package/dist/tools/resources.js.map +0 -1
  357. package/dist/tools/search.d.ts +0 -24
  358. package/dist/tools/search.d.ts.map +0 -1
  359. package/dist/tools/search.js +0 -39
  360. package/dist/tools/search.js.map +0 -1
  361. package/dist/tools/tests/mcp-test-client.d.ts +0 -15
  362. package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
  363. package/dist/tools/tests/mcp-test-client.js +0 -68
  364. package/dist/tools/tests/mcp-test-client.js.map +0 -1
  365. package/dist/tools/tests/test-setup.d.ts +0 -7
  366. package/dist/tools/tests/test-setup.d.ts.map +0 -1
  367. package/dist/tools/tests/test-setup.js +0 -36
  368. package/dist/tools/tests/test-setup.js.map +0 -1
  369. package/dist/tools/xulux-templates.d.ts +0 -58
  370. package/dist/tools/xulux-templates.d.ts.map +0 -1
  371. package/dist/tools/xulux-templates.js +0 -84
  372. package/dist/tools/xulux-templates.js.map +0 -1
  373. package/dist/utils/cache.d.ts +0 -5
  374. package/dist/utils/cache.d.ts.map +0 -1
  375. package/dist/utils/cache.js +0 -18
  376. package/dist/utils/cache.js.map +0 -1
  377. package/dist/utils/logger.d.ts +0 -10
  378. package/dist/utils/logger.d.ts.map +0 -1
  379. package/dist/utils/logger.js +0 -20
  380. package/dist/utils/logger.js.map +0 -1
  381. package/dist/utils/mcp-format.d.ts +0 -11
  382. package/dist/utils/mcp-format.d.ts.map +0 -1
  383. package/dist/utils/mcp-format.js +0 -14
  384. package/dist/utils/mcp-format.js.map +0 -1
  385. package/dist/utils/mdx.d.ts +0 -12
  386. package/dist/utils/mdx.d.ts.map +0 -1
  387. package/dist/utils/mdx.js +0 -45
  388. package/dist/utils/mdx.js.map +0 -1
  389. package/dist/utils/paths.d.ts +0 -12
  390. package/dist/utils/paths.d.ts.map +0 -1
  391. package/dist/utils/paths.js +0 -93
  392. package/dist/utils/paths.js.map +0 -1
  393. package/dist/utils/search.d.ts +0 -10
  394. package/dist/utils/search.d.ts.map +0 -1
  395. package/dist/utils/search.js +0 -97
  396. package/dist/utils/search.js.map +0 -1
  397. package/dist/utils/security.d.ts +0 -5
  398. package/dist/utils/security.d.ts.map +0 -1
  399. package/dist/utils/security.js +0 -22
  400. package/dist/utils/security.js.map +0 -1
  401. package/dist/xulux/catalog-client.d.ts +0 -14
  402. package/dist/xulux/catalog-client.d.ts.map +0 -1
  403. package/dist/xulux/catalog-client.js +0 -67
  404. package/dist/xulux/catalog-client.js.map +0 -1
  405. package/dist/xulux/fallback-catalog.d.ts +0 -7
  406. package/dist/xulux/fallback-catalog.d.ts.map +0 -1
  407. package/dist/xulux/fallback-catalog.js +0 -47
  408. package/dist/xulux/fallback-catalog.js.map +0 -1
  409. package/dist/xulux/fetch-sandbox.d.ts +0 -5
  410. package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
  411. package/dist/xulux/fetch-sandbox.js +0 -40
  412. package/dist/xulux/fetch-sandbox.js.map +0 -1
  413. package/dist/xulux/template-service.d.ts +0 -84
  414. package/dist/xulux/template-service.d.ts.map +0 -1
  415. package/dist/xulux/template-service.js +0 -223
  416. package/dist/xulux/template-service.js.map +0 -1
  417. package/dist/xulux/types.d.ts +0 -55
  418. package/dist/xulux/types.d.ts.map +0 -1
  419. package/dist/xulux/types.js +0 -6
  420. package/dist/xulux/types.js.map +0 -1
  421. package/src/constants.ts +0 -24
  422. package/src/prepare-docs/code-examples.ts +0 -158
  423. package/src/prepare-docs/copy-raw.ts +0 -50
  424. package/src/prepare-docs/prepare.ts +0 -24
  425. package/src/prompts/xulux-playground.ts +0 -36
  426. package/src/tools/docs.ts +0 -255
  427. package/src/tools/examples.ts +0 -114
  428. package/src/tools/resources.ts +0 -111
  429. package/src/tools/search.ts +0 -46
  430. package/src/tools/tests/completions.test.ts +0 -60
  431. package/src/tools/tests/directory-size-cap.test.ts +0 -50
  432. package/src/tools/tests/docs.test.ts +0 -144
  433. package/src/tools/tests/examples.test.ts +0 -94
  434. package/src/tools/tests/integration.test.ts +0 -45
  435. package/src/tools/tests/json-parsing.test.ts +0 -23
  436. package/src/tools/tests/listings-cache.test.ts +0 -19
  437. package/src/tools/tests/mcp-protocol.test.ts +0 -216
  438. package/src/tools/tests/mcp-test-client.ts +0 -111
  439. package/src/tools/tests/path-traversal.test.ts +0 -81
  440. package/src/tools/tests/resources.test.ts +0 -133
  441. package/src/tools/tests/search.test.ts +0 -37
  442. package/src/tools/tests/test-setup.ts +0 -50
  443. package/src/tools/tests/xulux-templates.test.ts +0 -262
  444. package/src/tools/xulux-templates.ts +0 -141
  445. package/src/utils/cache.ts +0 -20
  446. package/src/utils/logger.ts +0 -20
  447. package/src/utils/mcp-format.ts +0 -14
  448. package/src/utils/mdx.ts +0 -59
  449. package/src/utils/paths.ts +0 -139
  450. package/src/utils/search.ts +0 -131
  451. package/src/utils/security.ts +0 -52
  452. package/src/utils/tests/cache.test.ts +0 -51
  453. package/src/utils/tests/mcp-format.test.ts +0 -22
  454. package/src/utils/tests/security.test.ts +0 -119
  455. package/src/xulux/catalog-client.ts +0 -105
  456. package/src/xulux/fallback-catalog.ts +0 -63
  457. package/src/xulux/fetch-sandbox.ts +0 -56
  458. package/src/xulux/template-service.ts +0 -406
  459. package/src/xulux/types.ts +0 -60
@@ -1,828 +0,0 @@
1
- # Example: with-ffmpeg
2
-
3
- ## app/api/chat/route.ts
4
-
5
- ```typescript
6
- import { openai } from "@ai-sdk/openai";
7
- import { frontendTools } from "@assistant-ui/react-ai-sdk";
8
- import { convertToModelMessages, streamText } from "ai";
9
-
10
- export const maxDuration = 30;
11
-
12
- export async function POST(req: Request) {
13
- const { messages, system, tools } = await req.json();
14
-
15
- const result = streamText({
16
- model: openai("gpt-5.6-luna"),
17
- messages: await convertToModelMessages(messages),
18
- system,
19
- tools: {
20
- ...frontendTools(tools),
21
- // add backend tools here
22
- },
23
- });
24
-
25
- return result.toUIMessageStreamResponse();
26
- }
27
-
28
- ```
29
-
30
- ## app/globals.css
31
-
32
- ```css
33
- @import "tailwindcss";
34
- @import "tw-animate-css";
35
-
36
- @source "../../../packages/ui/src";
37
-
38
- @custom-variant dark (&:is(.dark *));
39
-
40
- @theme inline {
41
- --radius-sm: calc(var(--radius) - 4px);
42
- --radius-md: calc(var(--radius) - 2px);
43
- --radius-lg: var(--radius);
44
- --radius-xl: calc(var(--radius) + 4px);
45
- --color-background: var(--background);
46
- --color-foreground: var(--foreground);
47
- --color-card: var(--card);
48
- --color-card-foreground: var(--card-foreground);
49
- --color-popover: var(--popover);
50
- --color-popover-foreground: var(--popover-foreground);
51
- --color-primary: var(--primary);
52
- --color-primary-foreground: var(--primary-foreground);
53
- --color-secondary: var(--secondary);
54
- --color-secondary-foreground: var(--secondary-foreground);
55
- --color-muted: var(--muted);
56
- --color-muted-foreground: var(--muted-foreground);
57
- --color-accent: var(--accent);
58
- --color-accent-foreground: var(--accent-foreground);
59
- --color-destructive: var(--destructive);
60
- --color-border: var(--border);
61
- --color-input: var(--input);
62
- --color-ring: var(--ring);
63
- --color-chart-1: var(--chart-1);
64
- --color-chart-2: var(--chart-2);
65
- --color-chart-3: var(--chart-3);
66
- --color-chart-4: var(--chart-4);
67
- --color-chart-5: var(--chart-5);
68
- --color-sidebar: var(--sidebar);
69
- --color-sidebar-foreground: var(--sidebar-foreground);
70
- --color-sidebar-primary: var(--sidebar-primary);
71
- --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
72
- --color-sidebar-accent: var(--sidebar-accent);
73
- --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
74
- --color-sidebar-border: var(--sidebar-border);
75
- --color-sidebar-ring: var(--sidebar-ring);
76
- }
77
-
78
- :root {
79
- --radius: 0.625rem;
80
- --background: oklch(1 0 0);
81
- --foreground: oklch(0.141 0.005 285.823);
82
- --card: oklch(1 0 0);
83
- --card-foreground: oklch(0.141 0.005 285.823);
84
- --popover: oklch(1 0 0);
85
- --popover-foreground: oklch(0.141 0.005 285.823);
86
- --primary: oklch(0.21 0.006 285.885);
87
- --primary-foreground: oklch(0.985 0 0);
88
- --secondary: oklch(0.967 0.001 286.375);
89
- --secondary-foreground: oklch(0.21 0.006 285.885);
90
- --muted: oklch(0.967 0.001 286.375);
91
- --muted-foreground: oklch(0.552 0.016 285.938);
92
- --accent: oklch(0.967 0.001 286.375);
93
- --accent-foreground: oklch(0.21 0.006 285.885);
94
- --destructive: oklch(0.577 0.245 27.325);
95
- --border: oklch(0.92 0.004 286.32);
96
- --input: oklch(0.92 0.004 286.32);
97
- --ring: oklch(0.705 0.015 286.067);
98
- --chart-1: oklch(0.646 0.222 41.116);
99
- --chart-2: oklch(0.6 0.118 184.704);
100
- --chart-3: oklch(0.398 0.07 227.392);
101
- --chart-4: oklch(0.828 0.189 84.429);
102
- --chart-5: oklch(0.769 0.188 70.08);
103
- --sidebar: oklch(0.985 0 0);
104
- --sidebar-foreground: oklch(0.141 0.005 285.823);
105
- --sidebar-primary: oklch(0.21 0.006 285.885);
106
- --sidebar-primary-foreground: oklch(0.985 0 0);
107
- --sidebar-accent: oklch(0.967 0.001 286.375);
108
- --sidebar-accent-foreground: oklch(0.21 0.006 285.885);
109
- --sidebar-border: oklch(0.92 0.004 286.32);
110
- --sidebar-ring: oklch(0.705 0.015 286.067);
111
- }
112
-
113
- .dark {
114
- --background: oklch(0.141 0.005 285.823);
115
- --foreground: oklch(0.985 0 0);
116
- --card: oklch(0.21 0.006 285.885);
117
- --card-foreground: oklch(0.985 0 0);
118
- --popover: oklch(0.21 0.006 285.885);
119
- --popover-foreground: oklch(0.985 0 0);
120
- --primary: oklch(0.92 0.004 286.32);
121
- --primary-foreground: oklch(0.21 0.006 285.885);
122
- --secondary: oklch(0.274 0.006 286.033);
123
- --secondary-foreground: oklch(0.985 0 0);
124
- --muted: oklch(0.274 0.006 286.033);
125
- --muted-foreground: oklch(0.705 0.015 286.067);
126
- --accent: oklch(0.274 0.006 286.033);
127
- --accent-foreground: oklch(0.985 0 0);
128
- --destructive: oklch(0.704 0.191 22.216);
129
- --border: oklch(1 0 0 / 10%);
130
- --input: oklch(1 0 0 / 15%);
131
- --ring: oklch(0.552 0.016 285.938);
132
- --chart-1: oklch(0.488 0.243 264.376);
133
- --chart-2: oklch(0.696 0.17 162.48);
134
- --chart-3: oklch(0.769 0.188 70.08);
135
- --chart-4: oklch(0.627 0.265 303.9);
136
- --chart-5: oklch(0.645 0.246 16.439);
137
- --sidebar: oklch(0.21 0.006 285.885);
138
- --sidebar-foreground: oklch(0.985 0 0);
139
- --sidebar-primary: oklch(0.488 0.243 264.376);
140
- --sidebar-primary-foreground: oklch(0.985 0 0);
141
- --sidebar-accent: oklch(0.274 0.006 286.033);
142
- --sidebar-accent-foreground: oklch(0.985 0 0);
143
- --sidebar-border: oklch(1 0 0 / 10%);
144
- --sidebar-ring: oklch(0.552 0.016 285.938);
145
- }
146
-
147
- @layer base {
148
- * {
149
- @apply border-border outline-ring/50;
150
- }
151
- body {
152
- @apply bg-background text-foreground;
153
- }
154
- }
155
-
156
- ```
157
-
158
- ## app/layout.tsx
159
-
160
- ```tsx
161
- import type { Metadata } from "next";
162
- import "./globals.css";
163
- import { MyRuntimeProvider } from "./MyRuntimeProvider";
164
-
165
- export const metadata: Metadata = {
166
- title: "ConvertGPT with assistant-ui",
167
- description: "FFmpeg integration with assistant-ui",
168
- };
169
-
170
- export default function RootLayout({
171
- children,
172
- }: Readonly<{
173
- children: React.ReactNode;
174
- }>) {
175
- return (
176
- <MyRuntimeProvider>
177
- <html lang="en" className="h-dvh">
178
- <body className="h-dvh font-sans">{children}</body>
179
- </html>
180
- </MyRuntimeProvider>
181
- );
182
- }
183
-
184
- ```
185
-
186
- ## app/MyRuntimeProvider.tsx
187
-
188
- ```tsx
189
- "use client";
190
-
191
- import { AssistantRuntimeProvider, generateId } from "@assistant-ui/react";
192
- import type { AttachmentAdapter } from "@assistant-ui/react";
193
- import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
194
- import { lastAssistantMessageIsCompleteWithToolCalls } from "ai";
195
-
196
- const attachmentAdapter: AttachmentAdapter = {
197
- accept: "image/*,video/*,audio/*",
198
- async add({ file }) {
199
- return {
200
- id: generateId(),
201
- file,
202
- type: "file",
203
- name: file.name,
204
- contentType: file.type,
205
- status: { type: "requires-action", reason: "composer-send" },
206
- };
207
- },
208
- async send(attachment) {
209
- return {
210
- ...attachment,
211
- content: [
212
- {
213
- type: "text",
214
- text: `[User attached a file: ${attachment.name}]`,
215
- },
216
- ],
217
- status: { type: "complete" },
218
- };
219
- },
220
- async remove() {
221
- // noop
222
- },
223
- };
224
-
225
- export function MyRuntimeProvider({
226
- children,
227
- }: Readonly<{
228
- children: React.ReactNode;
229
- }>) {
230
- const runtime = useChatRuntime({
231
- sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
232
- adapters: {
233
- attachments: attachmentAdapter,
234
- },
235
- });
236
-
237
- return (
238
- <AssistantRuntimeProvider runtime={runtime}>
239
- {children}
240
- </AssistantRuntimeProvider>
241
- );
242
- }
243
-
244
- ```
245
-
246
- ## app/NoSSRWrapper.tsx
247
-
248
- ```tsx
249
- import dynamic from "next/dynamic";
250
- import type { FC, PropsWithChildren } from "react";
251
-
252
- const NoSSRWrapper: FC<PropsWithChildren> = (props) => <>{props.children}</>;
253
-
254
- export default dynamic(() => Promise.resolve(NoSSRWrapper), {
255
- ssr: false,
256
- });
257
-
258
- ```
259
-
260
- ## app/page.tsx
261
-
262
- ```tsx
263
- "use client";
264
-
265
- import {
266
- useAssistantInstructions,
267
- useAui,
268
- useAuiState,
269
- AuiProvider,
270
- AuiConfig,
271
- Suggestions,
272
- Tools,
273
- } from "@assistant-ui/react";
274
- import { FFmpeg } from "@ffmpeg/ffmpeg";
275
- import { toBlobURL } from "@ffmpeg/util";
276
- import { type FC, type ReactNode, useEffect, useRef, useState } from "react";
277
- import { Thread } from "@/components/assistant-ui/thread";
278
- import { useFfmpegToolkit } from "./toolkit";
279
-
280
- // MVP: upload file, enter command
281
- // MVP: convert command to tool call
282
- // MVP: tool call: ffmpeg
283
-
284
- const FfmpegToolsProvider: FC<{ file: File; children: ReactNode }> = ({
285
- file,
286
- children,
287
- }) => {
288
- const loadingRef = useRef(false);
289
- const ffmpegRef = useRef(new FFmpeg());
290
-
291
- useEffect(() => {
292
- if (loadingRef.current) return;
293
- loadingRef.current = true;
294
-
295
- const load = async () => {
296
- const baseURL = "https://unpkg.com/@ffmpeg/core@0.12.6/dist/umd";
297
- const ffmpeg = ffmpegRef.current;
298
- // toBlobURL is used to bypass CORS issue, urls with the same
299
- // domain can be used directly.
300
- await ffmpeg.load({
301
- coreURL: await toBlobURL(
302
- `${baseURL}/ffmpeg-core.js`,
303
- "text/javascript",
304
- ),
305
- wasmURL: await toBlobURL(
306
- `${baseURL}/ffmpeg-core.wasm`,
307
- "application/wasm",
308
- ),
309
- });
310
- };
311
- load();
312
- }, []);
313
-
314
- useAssistantInstructions(
315
- `The user has attached a file: ${file.name}. To add text overlays, use the render_overlay tool to render HTML to a PNG image, then use run_ffmpeg with the "overlay" filter to composite it onto the video. Do NOT use the drawtext filter.`,
316
- );
317
-
318
- const toolkit = useFfmpegToolkit(file, ffmpegRef);
319
-
320
- const aui = useAui();
321
- const config = AuiConfig({
322
- tools: Tools({ toolkit }),
323
- });
324
-
325
- return (
326
- <AuiProvider extends={aui} config={config}>
327
- {children}
328
- </AuiProvider>
329
- );
330
- };
331
-
332
- export default function Home() {
333
- const [lastFile, setLastFile] = useState<File | null>(null);
334
- const attachments = useAuiState((s) => s.thread.composer.attachments);
335
- useEffect(() => {
336
- const lastAttachment = attachments[attachments.length - 1];
337
- if (!lastAttachment) return;
338
- setLastFile(lastAttachment.file!);
339
- }, [attachments]);
340
-
341
- const aui = useAui();
342
- const config = AuiConfig({
343
- suggestions: Suggestions([
344
- {
345
- title: "Convert video to GIF",
346
- label: "attach a video file first",
347
- prompt: "Convert my video to an animated GIF.",
348
- },
349
- {
350
- title: "Compress an MP4",
351
- label: "to reduce file size",
352
- prompt: "Compress my video file to reduce its size.",
353
- },
354
- ]),
355
- });
356
-
357
- return (
358
- <div className="flex h-full flex-col">
359
- <AuiProvider extends={aui} config={config}>
360
- {lastFile ? (
361
- <FfmpegToolsProvider file={lastFile}>
362
- <Thread />
363
- </FfmpegToolsProvider>
364
- ) : (
365
- <Thread />
366
- )}
367
- </AuiProvider>
368
- </div>
369
- );
370
- }
371
-
372
- ```
373
-
374
- ## app/toolkit.tsx
375
-
376
- ```tsx
377
- "use client";
378
-
379
- import type { MutableRefObject } from "react";
380
- import { useCallback, useEffect, useMemo, useState } from "react";
381
- import { defineToolkit } from "@assistant-ui/react";
382
- import type { FFmpeg } from "@ffmpeg/ffmpeg";
383
- import {
384
- CircleCheckIcon,
385
- DownloadIcon,
386
- FileIcon,
387
- RefreshCcwIcon,
388
- TriangleAlertIcon,
389
- } from "lucide-react";
390
- import { z } from "zod";
391
-
392
- export function useFfmpegToolkit(
393
- file: File,
394
- ffmpegRef: MutableRefObject<FFmpeg>,
395
- ) {
396
- return useMemo(
397
- () =>
398
- defineToolkit({
399
- run_ffmpeg: {
400
- type: "frontend",
401
- parameters: z.object({
402
- command: z
403
- .string()
404
- .array()
405
- .describe("The ffmpeg command line arguments to provide"),
406
- }),
407
- execute: async ({ command }) => {
408
- const ffmpeg = ffmpegRef.current;
409
-
410
- const logs: string[] = [];
411
- const logger = ({ message }: { message: string }) => {
412
- logs.push(message);
413
- };
414
- ffmpeg.on("log", logger);
415
-
416
- await ffmpeg.writeFile(
417
- file.name,
418
- new Uint8Array(await file.arrayBuffer()),
419
- );
420
-
421
- const code = await ffmpeg.exec(command);
422
- ffmpeg.off("log", logger);
423
-
424
- return {
425
- success: code === 0,
426
- hint:
427
- code === 0
428
- ? "Success. Now call display_file to show the output to the user."
429
- : `some error happened, logs: ${logs.join("\n")}`,
430
- };
431
- },
432
- render: function RenderFfmpeg({
433
- args: { command },
434
- result: { success } = {},
435
- }) {
436
- return (
437
- <div className="mb-2 flex flex-col gap-2 rounded-lg border px-5 py-4">
438
- <div className="flex items-center gap-2">
439
- {success == null && (
440
- <RefreshCcwIcon className="size-4 animate-spin text-blue-600" />
441
- )}
442
- {success === false && (
443
- <TriangleAlertIcon className="size-4 text-red-600" />
444
- )}
445
- {success === true && (
446
- <CircleCheckIcon className="size-4 text-green-600" />
447
- )}
448
- <p>Running ffmpeg</p>
449
- </div>
450
- <pre className="font-sm overflow-y-scroll">
451
- ffmpeg {command?.join(" ")}
452
- </pre>
453
- {success === false && (
454
- <div className="mt-2 border-t border-dashed pt-3">
455
- Encountered an error.
456
- </div>
457
- )}
458
- </div>
459
- );
460
- },
461
- },
462
- render_overlay: {
463
- type: "frontend",
464
- parameters: z.object({
465
- html: z
466
- .string()
467
- .describe(
468
- "HTML content to render. Use inline styles for all styling. The background is transparent by default.",
469
- ),
470
- width: z.number().describe("Width of the output image in pixels"),
471
- height: z.number().describe("Height of the output image in pixels"),
472
- fileName: z
473
- .string()
474
- .describe(
475
- "Output filename in ffmpeg filesystem, e.g. overlay.png",
476
- ),
477
- }),
478
- execute: async ({ html, width, height, fileName }) => {
479
- const svg = `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}">
480
- <foreignObject width="100%" height="100%">
481
- <div xmlns="http://www.w3.org/1999/xhtml">${html}</div>
482
- </foreignObject>
483
- </svg>`;
484
-
485
- const img = new Image();
486
- img.src = `data:image/svg+xml;charset=utf-8,${encodeURIComponent(svg)}`;
487
-
488
- await new Promise<void>((resolve, reject) => {
489
- img.onload = () => resolve();
490
- img.onerror = () => reject(new Error("Failed to render HTML"));
491
- });
492
-
493
- const canvas = document.createElement("canvas");
494
- canvas.width = width;
495
- canvas.height = height;
496
- const ctx = canvas.getContext("2d")!;
497
- ctx.drawImage(img, 0, 0);
498
-
499
- const blob = await new Promise<Blob>((resolve) =>
500
- canvas.toBlob((b) => resolve(b!), "image/png"),
501
- );
502
- const data = new Uint8Array(await blob.arrayBuffer());
503
-
504
- const ffmpeg = ffmpegRef.current;
505
- await ffmpeg.writeFile(fileName, data);
506
-
507
- return {
508
- success: true,
509
- hint: `Overlay image "${fileName}" (${width}x${height}) written to ffmpeg filesystem. Use it with the overlay filter in run_ffmpeg, e.g. -i ${fileName} -filter_complex "overlay=x=0:y=0"`,
510
- };
511
- },
512
- render: function RenderOverlay({ args, result }) {
513
- return (
514
- <div className="mb-2 flex items-center gap-2 rounded-lg border px-5 py-4">
515
- {!result && (
516
- <RefreshCcwIcon className="size-4 animate-spin text-blue-600" />
517
- )}
518
- {result?.success && (
519
- <CircleCheckIcon className="size-4 text-green-600" />
520
- )}
521
- <p>
522
- {result?.success
523
- ? `Rendered overlay -> ${args.fileName}`
524
- : "Rendering overlay..."}
525
- </p>
526
- </div>
527
- );
528
- },
529
- },
530
- display_file: {
531
- type: "frontend",
532
- parameters: z.object({
533
- fileName: z
534
- .string()
535
- .describe(
536
- "The name of the file to display from the ffmpeg filesystem",
537
- ),
538
- mimeType: z
539
- .string()
540
- .describe("The mime type of the file, e.g. image/png, video/mp4"),
541
- }),
542
- execute: async ({ fileName }) => {
543
- const ffmpeg = ffmpegRef.current;
544
- try {
545
- const data = (await ffmpeg.readFile(
546
- fileName,
547
- )) as Uint8Array<ArrayBuffer>;
548
- return {
549
- success: true,
550
- size: data.byteLength,
551
- hint: "A file preview and download button is now visible to the user. Do not describe the file or repeat its contents.",
552
- };
553
- } catch {
554
- return {
555
- success: false,
556
- error: `File "${fileName}" not found in ffmpeg filesystem`,
557
- };
558
- }
559
- },
560
- render: function RenderDisplayFile({
561
- args: { fileName, mimeType },
562
- result,
563
- }) {
564
- const [blobUrl, setBlobUrl] = useState<string | null>(null);
565
-
566
- const readFile = useCallback(async () => {
567
- const ffmpeg = ffmpegRef.current;
568
- const data = (await ffmpeg.readFile(
569
- fileName,
570
- )) as Uint8Array<ArrayBuffer>;
571
- return URL.createObjectURL(
572
- new Blob([data.buffer], { type: mimeType }),
573
- );
574
- }, [fileName, mimeType]);
575
-
576
- useEffect(() => {
577
- if (!result?.success) return;
578
- let revoked = false;
579
- readFile().then((url) => {
580
- if (revoked) {
581
- URL.revokeObjectURL(url);
582
- return;
583
- }
584
- setBlobUrl(url);
585
- });
586
- return () => {
587
- revoked = true;
588
- setBlobUrl((prev) => {
589
- if (prev) URL.revokeObjectURL(prev);
590
- return null;
591
- });
592
- };
593
- }, [result?.success, readFile]);
594
-
595
- const handleDownload = () => {
596
- if (!blobUrl) return;
597
- const a = document.createElement("a");
598
- a.href = blobUrl;
599
- a.download = fileName;
600
- a.click();
601
- };
602
-
603
- if (!result) {
604
- return (
605
- <div className="flex items-center gap-2 rounded-lg border px-5 py-4">
606
- <RefreshCcwIcon className="size-4 animate-spin text-blue-600" />
607
- <p>Loading file...</p>
608
- </div>
609
- );
610
- }
611
-
612
- if (!result.success) {
613
- return (
614
- <div className="flex items-center gap-2 rounded-lg border px-5 py-4">
615
- <TriangleAlertIcon className="size-4 text-red-600" />
616
- <p>File not found</p>
617
- </div>
618
- );
619
- }
620
-
621
- const isImage = mimeType?.startsWith("image/");
622
- const isVideo = mimeType?.startsWith("video/");
623
- const isAudio = mimeType?.startsWith("audio/");
624
-
625
- return (
626
- <div className="mb-2 flex flex-col gap-3 rounded-lg border px-5 py-4">
627
- {blobUrl && isImage && (
628
- <img
629
- src={blobUrl}
630
- alt={fileName}
631
- className="max-h-64 w-fit rounded"
632
- />
633
- )}
634
- {blobUrl && isVideo && (
635
- <video
636
- src={blobUrl}
637
- controls
638
- className="max-h-64 w-fit rounded"
639
- />
640
- )}
641
- {blobUrl && isAudio && <audio src={blobUrl} controls />}
642
- {blobUrl && !isImage && !isVideo && !isAudio && (
643
- <div className="text-muted-foreground flex items-center gap-2">
644
- <FileIcon className="size-5" />
645
- <span>{fileName}</span>
646
- </div>
647
- )}
648
- <button
649
- type="button"
650
- onClick={handleDownload}
651
- className="bg-background hover:bg-accent flex w-fit items-center gap-2 rounded-md border px-4 py-2 text-sm"
652
- >
653
- <DownloadIcon className="size-4" />
654
- Download {fileName}
655
- </button>
656
- </div>
657
- );
658
- },
659
- },
660
- }),
661
- [ffmpegRef, file],
662
- );
663
- }
664
-
665
- ```
666
-
667
- ## components.json
668
-
669
- ```json
670
- {
671
- "$schema": "https://ui.shadcn.com/schema.json",
672
- "style": "new-york",
673
- "rsc": true,
674
- "tsx": true,
675
- "tailwind": {
676
- "config": "",
677
- "css": "app/globals.css",
678
- "baseColor": "zinc",
679
- "cssVariables": true,
680
- "prefix": ""
681
- },
682
- "aliases": {
683
- "components": "@/components",
684
- "utils": "@/lib/utils",
685
- "ui": "@/components/ui",
686
- "lib": "@/lib",
687
- "hooks": "@/hooks"
688
- },
689
- "iconLibrary": "lucide",
690
- "registries": {
691
- "@assistant-ui": "https://r.assistant-ui.com/{name}.json"
692
- }
693
- }
694
-
695
- ```
696
-
697
- ## next.config.ts
698
-
699
- ```typescript
700
- import { withAui } from "@assistant-ui/next";
701
- import type { NextConfig } from "next";
702
-
703
- const nextConfig: NextConfig = {/* config options here */};
704
-
705
- export default withAui(nextConfig);
706
-
707
- ```
708
-
709
- ## package.json
710
-
711
- ```json
712
- {
713
- "name": "with-ffmpeg",
714
- "version": "0.0.0",
715
- "private": true,
716
- "type": "module",
717
- "scripts": {
718
- "dev": "next dev",
719
- "build": "next build",
720
- "start": "next start"
721
- },
722
- "dependencies": {
723
- "@ai-sdk/openai": "^4.0.40",
724
- "@assistant-ui/react": "workspace:*",
725
- "@assistant-ui/react-ai-sdk": "workspace:*",
726
- "@assistant-ui/react-markdown": "workspace:*",
727
- "@assistant-ui/ui": "workspace:*",
728
- "@ffmpeg/ffmpeg": "^0.12.15",
729
- "@ffmpeg/util": "^0.12.2",
730
- "ai": "^7.0.62",
731
- "class-variance-authority": "^0.7.1",
732
- "clsx": "^2.1.1",
733
- "lucide-react": "^1.31.0",
734
- "next": "^16.3.0",
735
- "react": "^19.2.8",
736
- "react-dom": "^19.2.8",
737
- "tailwind-merge": "^3.6.0",
738
- "zod": "^4.4.3"
739
- },
740
- "devDependencies": {
741
- "@assistant-ui/next": "workspace:*",
742
- "@assistant-ui/x-buildutils": "workspace:*",
743
- "@tailwindcss/postcss": "^4.3.3",
744
- "@types/node": "^26.2.0",
745
- "@types/react": "^19.2.18",
746
- "@types/react-dom": "^19.2.4",
747
- "postcss": "^8.5.26",
748
- "tailwindcss": "^4.3.3",
749
- "tw-animate-css": "^1.4.0",
750
- "typescript": "^7.0.2"
751
- }
752
- }
753
-
754
- ```
755
-
756
- ## README.md
757
-
758
- ```markdown
759
- # FFmpeg Video Processing Tool
760
-
761
- This example demonstrates how to create a file conversion assistant using FFmpeg WebAssembly with assistant-ui.
762
-
763
- ## Quick Start
764
-
765
- ### Using CLI (Recommended)
766
-
767
- ```bash
768
- npx assistant-ui@latest create my-app --example with-ffmpeg
769
- cd my-app
770
- ```
771
-
772
- ### Environment Variables
773
-
774
- Create `.env.local`:
775
-
776
- ```
777
- OPENAI_API_KEY=sk-...
778
- ```
779
-
780
- ### Run
781
-
782
- ```bash
783
- npm run dev
784
- ```
785
-
786
- ## Features
787
-
788
- - FFmpeg WebAssembly integration
789
- - File attachment handling
790
- - Custom tool for running FFmpeg commands
791
- - Download button for converted files
792
- - Vercel AI SDK integration
793
-
794
- ## Related Documentation
795
-
796
- - [assistant-ui Documentation](https://www.assistant-ui.com/docs)
797
- - [Tool UI Guide](https://www.assistant-ui.com/docs/tools)
798
-
799
- ```
800
-
801
- ## tsconfig.json
802
-
803
- ```json
804
- {
805
- "extends": "@assistant-ui/x-buildutils/ts/next",
806
- "compilerOptions": {
807
- "paths": {
808
- "@/*": ["./*"],
809
- "@/components/assistant-ui/*": [
810
- "../../packages/ui/src/components/assistant-ui/*"
811
- ],
812
- "@/components/ui/*": [
813
- "../../packages/ui/src/components/ui/base/*",
814
- "../../packages/ui/src/components/ui/radix/*"
815
- ],
816
- "@/components/ui/radix/*": [
817
- "../../packages/ui/src/components/ui/radix/*"
818
- ],
819
- "@/lib/utils": ["../../packages/ui/src/lib/utils"],
820
- "@assistant-ui/ui/*": ["../../packages/ui/src/*"]
821
- }
822
- },
823
- "include": ["**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
824
- "exclude": ["node_modules"]
825
- }
826
-
827
- ```
828
-