@assistant-ui/mcp-docs-server 0.2.3 → 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 (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 +76 -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 +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 -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,813 +0,0 @@
1
- # Example: with-tap-runtime
2
-
3
- ## app/globals.css
4
-
5
- ```css
6
- @import "tailwindcss";
7
- @import "tw-animate-css";
8
-
9
- @source "../../../packages/ui/src";
10
-
11
- @custom-variant dark (&:is(.dark *));
12
-
13
- @theme inline {
14
- --radius-sm: calc(var(--radius) - 4px);
15
- --radius-md: calc(var(--radius) - 2px);
16
- --radius-lg: var(--radius);
17
- --radius-xl: calc(var(--radius) + 4px);
18
- --color-background: var(--background);
19
- --color-foreground: var(--foreground);
20
- --color-card: var(--card);
21
- --color-card-foreground: var(--card-foreground);
22
- --color-popover: var(--popover);
23
- --color-popover-foreground: var(--popover-foreground);
24
- --color-primary: var(--primary);
25
- --color-primary-foreground: var(--primary-foreground);
26
- --color-secondary: var(--secondary);
27
- --color-secondary-foreground: var(--secondary-foreground);
28
- --color-muted: var(--muted);
29
- --color-muted-foreground: var(--muted-foreground);
30
- --color-accent: var(--accent);
31
- --color-accent-foreground: var(--accent-foreground);
32
- --color-destructive: var(--destructive);
33
- --color-border: var(--border);
34
- --color-input: var(--input);
35
- --color-ring: var(--ring);
36
- --color-chart-1: var(--chart-1);
37
- --color-chart-2: var(--chart-2);
38
- --color-chart-3: var(--chart-3);
39
- --color-chart-4: var(--chart-4);
40
- --color-chart-5: var(--chart-5);
41
- --color-sidebar: var(--sidebar);
42
- --color-sidebar-foreground: var(--sidebar-foreground);
43
- --color-sidebar-primary: var(--sidebar-primary);
44
- --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
45
- --color-sidebar-accent: var(--sidebar-accent);
46
- --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
47
- --color-sidebar-border: var(--sidebar-border);
48
- --color-sidebar-ring: var(--sidebar-ring);
49
- }
50
-
51
- :root {
52
- --radius: 0.625rem;
53
- --background: oklch(1 0 0);
54
- --foreground: oklch(0.141 0.005 285.823);
55
- --card: oklch(1 0 0);
56
- --card-foreground: oklch(0.141 0.005 285.823);
57
- --popover: oklch(1 0 0);
58
- --popover-foreground: oklch(0.141 0.005 285.823);
59
- --primary: oklch(0.21 0.006 285.885);
60
- --primary-foreground: oklch(0.985 0 0);
61
- --secondary: oklch(0.967 0.001 286.375);
62
- --secondary-foreground: oklch(0.21 0.006 285.885);
63
- --muted: oklch(0.967 0.001 286.375);
64
- --muted-foreground: oklch(0.552 0.016 285.938);
65
- --accent: oklch(0.967 0.001 286.375);
66
- --accent-foreground: oklch(0.21 0.006 285.885);
67
- --destructive: oklch(0.577 0.245 27.325);
68
- --border: oklch(0.92 0.004 286.32);
69
- --input: oklch(0.92 0.004 286.32);
70
- --ring: oklch(0.705 0.015 286.067);
71
- --chart-1: oklch(0.646 0.222 41.116);
72
- --chart-2: oklch(0.6 0.118 184.704);
73
- --chart-3: oklch(0.398 0.07 227.392);
74
- --chart-4: oklch(0.828 0.189 84.429);
75
- --chart-5: oklch(0.769 0.188 70.08);
76
- --sidebar: oklch(0.985 0 0);
77
- --sidebar-foreground: oklch(0.141 0.005 285.823);
78
- --sidebar-primary: oklch(0.21 0.006 285.885);
79
- --sidebar-primary-foreground: oklch(0.985 0 0);
80
- --sidebar-accent: oklch(0.967 0.001 286.375);
81
- --sidebar-accent-foreground: oklch(0.21 0.006 285.885);
82
- --sidebar-border: oklch(0.92 0.004 286.32);
83
- --sidebar-ring: oklch(0.705 0.015 286.067);
84
- }
85
-
86
- .dark {
87
- --background: oklch(0.141 0.005 285.823);
88
- --foreground: oklch(0.985 0 0);
89
- --card: oklch(0.21 0.006 285.885);
90
- --card-foreground: oklch(0.985 0 0);
91
- --popover: oklch(0.21 0.006 285.885);
92
- --popover-foreground: oklch(0.985 0 0);
93
- --primary: oklch(0.92 0.004 286.32);
94
- --primary-foreground: oklch(0.21 0.006 285.885);
95
- --secondary: oklch(0.274 0.006 286.033);
96
- --secondary-foreground: oklch(0.985 0 0);
97
- --muted: oklch(0.274 0.006 286.033);
98
- --muted-foreground: oklch(0.705 0.015 286.067);
99
- --accent: oklch(0.274 0.006 286.033);
100
- --accent-foreground: oklch(0.985 0 0);
101
- --destructive: oklch(0.704 0.191 22.216);
102
- --border: oklch(1 0 0 / 10%);
103
- --input: oklch(1 0 0 / 15%);
104
- --ring: oklch(0.552 0.016 285.938);
105
- --chart-1: oklch(0.488 0.243 264.376);
106
- --chart-2: oklch(0.696 0.17 162.48);
107
- --chart-3: oklch(0.769 0.188 70.08);
108
- --chart-4: oklch(0.627 0.265 303.9);
109
- --chart-5: oklch(0.645 0.246 16.439);
110
- --sidebar: oklch(0.21 0.006 285.885);
111
- --sidebar-foreground: oklch(0.985 0 0);
112
- --sidebar-primary: oklch(0.488 0.243 264.376);
113
- --sidebar-primary-foreground: oklch(0.985 0 0);
114
- --sidebar-accent: oklch(0.274 0.006 286.033);
115
- --sidebar-accent-foreground: oklch(0.985 0 0);
116
- --sidebar-border: oklch(1 0 0 / 10%);
117
- --sidebar-ring: oklch(0.552 0.016 285.938);
118
- }
119
-
120
- @layer base {
121
- * {
122
- @apply border-border outline-ring/50;
123
- }
124
- body {
125
- @apply bg-background text-foreground;
126
- }
127
- }
128
-
129
- ```
130
-
131
- ## app/layout.tsx
132
-
133
- ```tsx
134
- import type { Metadata } from "next";
135
- import { MyRuntimeProvider } from "./MyRuntimeProvider";
136
-
137
- import "./globals.css";
138
-
139
- export const metadata: Metadata = {
140
- title: "Tap-Native Runtime Example",
141
- description:
142
- "Example of tap-native runtime with ExternalThread and InMemoryThreadList",
143
- };
144
-
145
- export default function RootLayout({
146
- children,
147
- }: Readonly<{
148
- children: React.ReactNode;
149
- }>) {
150
- return (
151
- <MyRuntimeProvider>
152
- <html lang="en" className="h-dvh">
153
- <body className="h-dvh font-sans">{children}</body>
154
- </html>
155
- </MyRuntimeProvider>
156
- );
157
- }
158
-
159
- ```
160
-
161
- ## app/MyRuntimeProvider.tsx
162
-
163
- ```tsx
164
- "use client";
165
-
166
- import { useState } from "react";
167
- import {
168
- AuiProvider,
169
- AuiConfig,
170
- useAuiState,
171
- ExternalThread,
172
- InMemoryThreadList,
173
- unstable_createMessageConverter,
174
- type ExternalThreadMessage,
175
- ThreadListPrimitive,
176
- ThreadListItemPrimitive,
177
- } from "@assistant-ui/react";
178
-
179
- type SimpleMessage = {
180
- id: string;
181
- role: "user" | "assistant" | "system";
182
- content: string;
183
- status?: { type: "complete"; reason: "stop" };
184
- };
185
-
186
- const converter = unstable_createMessageConverter<SimpleMessage>(
187
- (message: SimpleMessage) => ({
188
- role: message.role,
189
- content: message.content,
190
- id: message.id,
191
- status: message.status,
192
- }),
193
- );
194
-
195
- const SIMPLE_MESSAGES: SimpleMessage[] = [
196
- {
197
- id: "1",
198
- role: "user",
199
- content: "Hello! What is tap-native runtime?",
200
- },
201
- {
202
- id: "2",
203
- role: "assistant",
204
- content:
205
- "Hi! Tap-native runtime is a new way to build assistant-ui runtimes using @assistant-ui/tap and @assistant-ui/store. It provides:\n\n• Reactive state management with hooks-like API\n• Type-safe client definitions\n• Composable resource architecture\n• Minimal implementation for external state\n\nThis example demonstrates ExternalThread and InMemoryThreadList - the first tap-native runtime clients!",
206
- status: { type: "complete", reason: "stop" },
207
- },
208
- {
209
- id: "3",
210
- role: "user",
211
- content: "That sounds great! Can you show me an example?",
212
- },
213
- {
214
- id: "4",
215
- role: "assistant",
216
- content:
217
- 'Sure! Here\'s how to use the tap-native runtime:\n\n```typescript\nconst messages = [\n { id: "1", role: "user", content: [{ type: "text", text: "Hello!" }] }\n];\n\nconst config = AuiConfig({\n threads: InMemoryThreadList({\n thread: (threadId) => ExternalThread({ messages, isRunning: false })\n })\n});\n\n<AuiProvider config={config}>{children}</AuiProvider>\n```\n\nTry using the thread list on the left to create and switch between threads!',
218
- status: { type: "complete", reason: "stop" },
219
- },
220
- ];
221
-
222
- export function MyRuntimeProvider({ children }: { children: React.ReactNode }) {
223
- const [threadMessages, setThreadMessages] = useState<
224
- Map<string, SimpleMessage[]>
225
- >(() => new Map([["main", SIMPLE_MESSAGES]]));
226
- const [currentThreadId, setCurrentThreadId] = useState("main");
227
- const [isRunning, setIsRunning] = useState(false);
228
-
229
- const currentMessages = threadMessages.get(currentThreadId) || [];
230
-
231
- const handleSwitchToThread = (threadId: string) => {
232
- setCurrentThreadId(threadId);
233
- setIsRunning(false);
234
- };
235
-
236
- const handleSwitchToNewThread = () => {
237
- const newId = `thread-${Date.now()}`;
238
- setThreadMessages((prev) => new Map(prev).set(newId, []));
239
- setCurrentThreadId(newId);
240
- setIsRunning(false);
241
- };
242
-
243
- const updateCurrentThreadMessages = (
244
- updater: (prev: SimpleMessage[]) => SimpleMessage[],
245
- ) => {
246
- setThreadMessages((prev) => {
247
- const newMap = new Map(prev);
248
- newMap.set(currentThreadId, updater(prev.get(currentThreadId) || []));
249
- return newMap;
250
- });
251
- };
252
-
253
- const messages = converter.useThreadMessages({
254
- messages: currentMessages,
255
- isRunning,
256
- }) as ExternalThreadMessage[];
257
-
258
- const config = AuiConfig({
259
- threads: InMemoryThreadList({
260
- thread: (threadId) =>
261
- ExternalThread({
262
- messages: threadId === currentThreadId ? messages : [],
263
- isRunning: threadId === currentThreadId ? isRunning : false,
264
- onNew: (message) => {
265
- console.log("New message:", message);
266
- const textContent = message.content
267
- .filter((part: any) => part.type === "text")
268
- .map((part: any) => part.text)
269
- .join("\n\n");
270
-
271
- updateCurrentThreadMessages((prev) => [
272
- ...prev,
273
- {
274
- id: String(Date.now()),
275
- role: message.role,
276
- content: textContent,
277
- ...(message.role === "assistant" && {
278
- status: {
279
- type: "complete" as const,
280
- reason: "stop" as const,
281
- },
282
- }),
283
- },
284
- ]);
285
- },
286
- onEdit: (message) => {
287
- console.log("Edit message:", message);
288
- updateCurrentThreadMessages((prev) => {
289
- const index = prev.findIndex((m) => m.id === message.sourceId);
290
- if (index === -1) return prev;
291
-
292
- const textContent = message.content
293
- .filter((part: any) => part.type === "text")
294
- .map((part: any) => part.text)
295
- .join("\n\n");
296
-
297
- const newMessages = [...prev];
298
- newMessages[index] = {
299
- ...newMessages[index]!,
300
- content: textContent,
301
- };
302
- return newMessages;
303
- });
304
- },
305
- onReload: (parentId) => {
306
- console.log("Reload from:", parentId);
307
- updateCurrentThreadMessages((prev) => {
308
- let cutMessages: SimpleMessage[];
309
- let sourceRole: "user" | "assistant" | "system" = "assistant";
310
-
311
- if (parentId === null) {
312
- cutMessages = [];
313
- sourceRole = prev[0]?.role || "assistant";
314
- } else {
315
- const parentIndex = prev.findIndex((m) => m.id === parentId);
316
- if (parentIndex === -1) {
317
- cutMessages = [];
318
- sourceRole = "assistant";
319
- } else {
320
- cutMessages = prev.slice(0, parentIndex + 1);
321
- const sourceMessage = prev[parentIndex + 1];
322
- sourceRole = sourceMessage?.role || "assistant";
323
- }
324
- }
325
-
326
- const reloadMessage: SimpleMessage = {
327
- id: String(Date.now()),
328
- role: sourceRole,
329
- content: "This message was reloaded",
330
- ...(sourceRole === "assistant" && {
331
- status: {
332
- type: "complete" as const,
333
- reason: "stop" as const,
334
- },
335
- }),
336
- };
337
-
338
- return [...cutMessages, reloadMessage];
339
- });
340
- },
341
- onStartRun: () => {
342
- console.log("Start run");
343
- setIsRunning(true);
344
- },
345
- onCancel: () => {
346
- console.log("Cancel run");
347
- setIsRunning(false);
348
- },
349
- }),
350
- onSwitchToThread: handleSwitchToThread,
351
- onSwitchToNewThread: handleSwitchToNewThread,
352
- }),
353
- });
354
-
355
- return (
356
- <AuiProvider config={config}>
357
- <div className="flex h-full">
358
- {/* Thread List Sidebar */}
359
- <ThreadListSidebar />
360
-
361
- {/* Main Content */}
362
- <div className="flex flex-1 flex-col">
363
- {children}
364
-
365
- {/* Control panel */}
366
- <div className="bg-card border-t p-4">
367
- <div className="mx-auto flex max-w-2xl flex-col gap-2">
368
- <div className="flex items-center gap-2">
369
- <span className="text-muted-foreground text-sm">Controls:</span>
370
- <button
371
- type="button"
372
- onClick={() => {
373
- updateCurrentThreadMessages((prev) => [
374
- ...prev,
375
- {
376
- id: String(Date.now()),
377
- role: "user",
378
- content: "New user message",
379
- },
380
- ]);
381
- }}
382
- className="bg-primary text-primary-foreground hover:bg-primary/90 rounded-md px-3 py-1 text-sm font-medium"
383
- >
384
- Add User Message
385
- </button>
386
- <button
387
- type="button"
388
- onClick={() => {
389
- updateCurrentThreadMessages((prev) => [
390
- ...prev,
391
- {
392
- id: String(Date.now()),
393
- role: "assistant",
394
- content:
395
- "New assistant message with some helpful information!",
396
- status: { type: "complete", reason: "stop" },
397
- },
398
- ]);
399
- }}
400
- className="bg-secondary text-secondary-foreground hover:bg-secondary/80 rounded-md px-3 py-1 text-sm font-medium"
401
- >
402
- Add Assistant Message
403
- </button>
404
- <button
405
- type="button"
406
- onClick={() => setIsRunning(!isRunning)}
407
- className="bg-accent text-accent-foreground hover:bg-accent/80 rounded-md px-3 py-1 text-sm font-medium"
408
- >
409
- {isRunning ? "Stop" : "Start"} Running
410
- </button>
411
- <button
412
- type="button"
413
- onClick={() => updateCurrentThreadMessages(() => [])}
414
- className="bg-destructive hover:bg-destructive/90 rounded-md px-3 py-1 text-sm font-medium text-white"
415
- >
416
- Clear
417
- </button>
418
- </div>
419
- <div className="text-muted-foreground text-xs">
420
- {currentMessages.length} message
421
- {currentMessages.length !== 1 ? "s" : ""} •{" "}
422
- {isRunning ? "Running" : "Idle"}
423
- </div>
424
- </div>
425
- </div>
426
- </div>
427
- </div>
428
- </AuiProvider>
429
- );
430
- }
431
-
432
- function ThreadListSidebar() {
433
- return (
434
- <ThreadListPrimitive.Root className="bg-muted/30 flex w-64 flex-col border-r">
435
- <div className="border-b p-4">
436
- <h2 className="text-lg font-semibold">Threads</h2>
437
- </div>
438
-
439
- <div className="flex-1 overflow-y-auto p-2">
440
- <ThreadListPrimitive.Items>
441
- {() => <ThreadListItem />}
442
- </ThreadListPrimitive.Items>
443
- </div>
444
-
445
- <div className="border-t p-2">
446
- <ThreadListPrimitive.New className="bg-primary text-primary-foreground hover:bg-primary/90 w-full rounded-md px-3 py-2 text-sm font-medium">
447
- + New Thread
448
- </ThreadListPrimitive.New>
449
- </div>
450
- </ThreadListPrimitive.Root>
451
- );
452
- }
453
-
454
- function ThreadListItem() {
455
- return (
456
- <ThreadListItemPrimitive.Root className="hover:bg-muted data-active:bg-primary data-active:text-primary-foreground mb-1 w-full rounded-md p-3 text-left transition-colors">
457
- <ThreadListItemPrimitive.Trigger className="w-full text-left">
458
- <div className="font-medium">
459
- <ThreadListItemPrimitive.Title fallback="New Thread" />
460
- </div>
461
- <div className="text-xs opacity-70">
462
- <ThreadListItemId />
463
- </div>
464
- </ThreadListItemPrimitive.Trigger>
465
- </ThreadListItemPrimitive.Root>
466
- );
467
- }
468
-
469
- function ThreadListItemId() {
470
- const id = useAuiState((s) => s.threadListItem.id);
471
- return <>{id}</>;
472
- }
473
-
474
- ```
475
-
476
- ## app/page.tsx
477
-
478
- ```tsx
479
- "use client";
480
-
481
- import { Thread } from "@/components/assistant-ui/thread";
482
- import { useAuiState } from "@assistant-ui/react";
483
-
484
- export default function Home() {
485
- const isEmpty = useAuiState((s) => s.threads.main.isEmpty);
486
-
487
- return (
488
- <div className="flex h-full flex-col">
489
- <header className="bg-card border-b px-6 py-4">
490
- <h1 className="text-2xl font-bold">Tap-Native Runtime Example</h1>
491
- <p className="text-muted-foreground text-sm">
492
- Built with ExternalThread and InMemoryThreadList
493
- </p>
494
- </header>
495
-
496
- <main className="flex-1 overflow-hidden p-4">
497
- {isEmpty ? (
498
- <div className="flex h-full items-center justify-center">
499
- <div className="text-center">
500
- <h2 className="mb-2 text-xl font-semibold">No messages yet</h2>
501
- <p className="text-muted-foreground text-sm">
502
- Use the controls below to add messages
503
- </p>
504
- </div>
505
- </div>
506
- ) : (
507
- <>
508
- <Thread />
509
- <div className="mx-auto mt-4 max-w-2xl space-y-2">
510
- <div className="bg-card rounded-lg border p-4">
511
- <h3 className="mb-2 text-sm font-semibold">
512
- About This Example
513
- </h3>
514
- <ul className="text-muted-foreground space-y-1 text-sm">
515
- <li>
516
- • Uses{" "}
517
- <code className="bg-muted rounded px-1">
518
- ExternalThread
519
- </code>{" "}
520
- to display messages
521
- </li>
522
- <li>• Messages are stored in React state</li>
523
- <li>• Fully reactive - updates automatically</li>
524
- <li>• No backend needed - pure client-side</li>
525
- </ul>
526
- </div>
527
-
528
- <div className="text-muted-foreground text-center text-xs">
529
- This is a minimal implementation. Features like editing,
530
- branching, and attachments can be added.
531
- </div>
532
- </div>
533
- </>
534
- )}
535
- </main>
536
- </div>
537
- );
538
- }
539
-
540
- ```
541
-
542
- ## components.json
543
-
544
- ```json
545
- {
546
- "$schema": "https://ui.shadcn.com/schema.json",
547
- "style": "new-york",
548
- "rsc": true,
549
- "tsx": true,
550
- "tailwind": {
551
- "config": "",
552
- "css": "app/globals.css",
553
- "baseColor": "zinc",
554
- "cssVariables": true,
555
- "prefix": ""
556
- },
557
- "aliases": {
558
- "components": "@/components",
559
- "utils": "@/lib/utils",
560
- "ui": "@/components/ui",
561
- "lib": "@/lib",
562
- "hooks": "@/hooks"
563
- },
564
- "iconLibrary": "lucide",
565
- "registries": {
566
- "@assistant-ui": "https://r.assistant-ui.com/{name}.json"
567
- }
568
- }
569
-
570
- ```
571
-
572
- ## next.config.ts
573
-
574
- ```typescript
575
- import { withAui } from "@assistant-ui/next";
576
- import type { NextConfig } from "next";
577
-
578
- const nextConfig: NextConfig = {/* config options here */};
579
-
580
- export default withAui(nextConfig);
581
-
582
- ```
583
-
584
- ## package.json
585
-
586
- ```json
587
- {
588
- "name": "with-tap-runtime",
589
- "version": "0.0.0",
590
- "private": true,
591
- "type": "module",
592
- "scripts": {
593
- "dev": "next dev",
594
- "build": "next build",
595
- "start": "next start"
596
- },
597
- "dependencies": {
598
- "@assistant-ui/react": "workspace:*",
599
- "@assistant-ui/react-markdown": "workspace:*",
600
- "@assistant-ui/ui": "workspace:*",
601
- "class-variance-authority": "^0.7.1",
602
- "clsx": "^2.1.1",
603
- "lucide-react": "^1.33.0",
604
- "next": "^16.3.2",
605
- "react": "^19.2.8",
606
- "react-dom": "^19.2.8",
607
- "tailwind-merge": "^3.6.0"
608
- },
609
- "devDependencies": {
610
- "@assistant-ui/next": "workspace:*",
611
- "@assistant-ui/x-buildutils": "workspace:*",
612
- "@tailwindcss/postcss": "^4.3.3",
613
- "@types/node": "^26.2.0",
614
- "@types/react": "^19.2.18",
615
- "@types/react-dom": "^19.2.5",
616
- "postcss": "^8.5.26",
617
- "tailwindcss": "^4.3.3",
618
- "tw-animate-css": "^1.4.0",
619
- "typescript": "^7.0.2"
620
- }
621
- }
622
-
623
- ```
624
-
625
- ## README.md
626
-
627
- ```markdown
628
- # Tap-Native Runtime Example
629
-
630
- This example demonstrates the first tap-native runtime implementation for assistant-ui using `@assistant-ui/tap` and `@assistant-ui/store`.
631
-
632
- ## Features
633
-
634
- - ✅ **ExternalThread**: Display messages from external state
635
- - ✅ **InMemoryThreadList**: Simple thread list management
636
- - ✅ **Reactive Updates**: State changes automatically update the UI
637
- - ✅ **Type-Safe**: Full TypeScript support with client registry
638
- - ✅ **No Backend**: Pure client-side implementation
639
-
640
- ## Getting Started
641
-
642
- ```bash
643
- # From the monorepo root, install dependencies
644
- pnpm install
645
-
646
- # Navigate to this example
647
- cd examples/with-tap-runtime
648
-
649
- # Run the development server
650
- pnpm dev
651
- ```
652
-
653
- Open [http://localhost:3000](http://localhost:3000) to see the example.
654
-
655
- ## How It Works
656
-
657
- ### 1. Define Messages
658
-
659
- ```typescript
660
- const messages: ExternalThreadMessage[] = [
661
- {
662
- id: "1",
663
- role: "user",
664
- content: [{ type: "text", text: "Hello!" }],
665
- },
666
- {
667
- id: "2",
668
- role: "assistant",
669
- content: [{ type: "text", text: "Hi there!" }],
670
- },
671
- ];
672
- ```
673
-
674
- ### 2. Create Config
675
-
676
- ```typescript
677
- const config = AuiConfig({
678
- threads: InMemoryThreadList({
679
- thread: () => ExternalThread({ messages, isRunning: false }),
680
- }),
681
- });
682
- ```
683
-
684
- ### 3. Provide to App
685
-
686
- ```typescript
687
- <AuiProvider config={config}>
688
- <Thread.Root>
689
- <Thread.Messages />
690
- </Thread.Root>
691
- </AuiProvider>
692
- ```
693
-
694
- ## Architecture
695
-
696
- ```
697
- ┌─────────────────────────────────────┐
698
- │ React State (messages, isRunning) │
699
- └──────────────┬──────────────────────┘
700
- │
701
- ▼
702
- ┌─────────────────────────────────────┐
703
- │ useAui (tap-native runtime) │
704
- │ ┌───────────────────────────────┐ │
705
- │ │ InMemoryThreadList │ │
706
- │ │ └─ ExternalThread │ │
707
- │ │ └─ MessageClient │ │
708
- │ │ └─ ComposerClient │ │
709
- │ └───────────────────────────────┘ │
710
- └──────────────┬──────────────────────┘
711
- │
712
- ▼
713
- ┌─────────────────────────────────────┐
714
- │ Assistant UI Components │
715
- │ <Thread.Messages /> │
716
- └─────────────────────────────────────┘
717
- ```
718
-
719
- ## Key Concepts
720
-
721
- ### ExternalThread
722
-
723
- A client that accepts messages from external state:
724
-
725
- ```typescript
726
- ExternalThread({
727
- messages: ExternalThreadMessage[],
728
- isRunning?: boolean
729
- })
730
- ```
731
-
732
- ### InMemoryThreadList
733
-
734
- A client that manages thread list state:
735
-
736
- ```typescript
737
- InMemoryThreadList({
738
- thread: () => ResourceElement<ClientOutput<"thread">>
739
- })
740
- ```
741
-
742
- ### Client Registry
743
-
744
- Type-safe client definitions via module augmentation (defined in `@assistant-ui/react`):
745
-
746
- ```typescript
747
- declare module "@assistant-ui/store" {
748
- interface ScopeRegistry {
749
- threads: ThreadsClientSchema;
750
- thread: ThreadClientSchema;
751
- message: MessageClientSchema;
752
- // ...
753
- }
754
- }
755
- ```
756
-
757
- ## Extending This Example
758
-
759
- You can extend this example to:
760
-
761
- 1. **Add persistence**: Save messages to localStorage or a database
762
- 2. **Implement streaming**: Update messages as they stream in
763
- 3. **Add branching**: Allow users to explore different conversation paths
764
- 4. **Enable editing**: Let users edit messages
765
- 5. **Add attachments**: Support file uploads and images
766
- 6. **Connect to AI**: Integrate with OpenAI, Anthropic, or other AI providers
767
-
768
- ## Learn More
769
-
770
- - [Tap Documentation](https://github.com/assistant-ui/assistant-ui/tree/main/packages/tap)
771
- - [Store Documentation](https://github.com/assistant-ui/assistant-ui/tree/main/packages/store)
772
- - [Client Implementation](https://github.com/assistant-ui/assistant-ui/tree/main/packages/react/src/client)
773
- - [Assistant UI Docs](https://assistant-ui.com)
774
-
775
- ```
776
-
777
- ## tsconfig.json
778
-
779
- ```json
780
- {
781
- "extends": "@assistant-ui/x-buildutils/ts/next",
782
- "compilerOptions": {
783
- "paths": {
784
- "@/*": ["./*"],
785
- "@/components/assistant-ui/*": [
786
- "../../packages/ui/src/components/assistant-ui/*"
787
- ],
788
- "@/hooks/*": ["../../packages/ui/src/hooks/*"],
789
- "@/components/ui/*": [
790
- "../../packages/ui/src/components/ui/base/*",
791
- "../../packages/ui/src/components/ui/radix/*"
792
- ],
793
- "@/components/ui/radix/*": [
794
- "../../packages/ui/src/components/ui/radix/*"
795
- ],
796
- "@/lib/utils": ["../../packages/ui/src/lib/utils"],
797
- "@assistant-ui/ui/*": ["../../packages/ui/src/*"],
798
- "@assistant-ui/store/client": ["../../packages/store/src/client"],
799
- "@assistant-ui/*": ["../../packages/*/src"],
800
- "@assistant-ui/core/*": ["../../packages/core/src/*"],
801
- "@assistant-ui/react/*": ["../../packages/react/src/*"],
802
- "@assistant-ui/tap": ["../../packages/tap/src"],
803
- "@assistant-ui/tap/*": ["../../packages/tap/src/*"],
804
- "@assistant-ui/store": ["../../packages/store/src"],
805
- "@assistant-ui/store/*": ["../../packages/store/src/*"]
806
- }
807
- },
808
- "include": ["**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
809
- "exclude": ["node_modules"]
810
- }
811
-
812
- ```
813
-