@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.
- package/README.md +16 -43
- package/dist/index.d.ts +2 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -91
- package/dist/index.js.map +1 -1
- package/dist/proxy.d.ts +9 -0
- package/dist/proxy.d.ts.map +1 -0
- package/dist/proxy.js +76 -0
- package/dist/proxy.js.map +1 -0
- package/package.json +8 -12
- package/src/index.ts +3 -115
- package/src/proxy.test.ts +250 -0
- package/src/proxy.ts +111 -0
- package/.docs/organized/code-examples/waterfall.md +0 -807
- package/.docs/organized/code-examples/with-a2a.md +0 -675
- package/.docs/organized/code-examples/with-ag-ui.md +0 -553
- package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -466
- package/.docs/organized/code-examples/with-artifacts.md +0 -815
- package/.docs/organized/code-examples/with-assistant-transport.md +0 -576
- package/.docs/organized/code-examples/with-browser-extension.md +0 -371
- package/.docs/organized/code-examples/with-chain-of-thought.md +0 -962
- package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
- package/.docs/organized/code-examples/with-cloud.md +0 -439
- package/.docs/organized/code-examples/with-custom-thread-list.md +0 -569
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -527
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -697
- package/.docs/organized/code-examples/with-eve.md +0 -405
- package/.docs/organized/code-examples/with-expo.md +0 -2246
- package/.docs/organized/code-examples/with-external-store.md +0 -421
- package/.docs/organized/code-examples/with-ffmpeg.md +0 -829
- package/.docs/organized/code-examples/with-generative-ui.md +0 -1810
- package/.docs/organized/code-examples/with-google-adk.md +0 -368
- package/.docs/organized/code-examples/with-heat-graph.md +0 -304
- package/.docs/organized/code-examples/with-image-generation.md +0 -463
- package/.docs/organized/code-examples/with-interactables.md +0 -733
- package/.docs/organized/code-examples/with-langchain.md +0 -446
- package/.docs/organized/code-examples/with-langgraph.md +0 -855
- package/.docs/organized/code-examples/with-livekit.md +0 -643
- package/.docs/organized/code-examples/with-mcp.md +0 -782
- package/.docs/organized/code-examples/with-nuxt.md +0 -2428
- package/.docs/organized/code-examples/with-opencode.md +0 -1974
- package/.docs/organized/code-examples/with-openui.md +0 -450
- package/.docs/organized/code-examples/with-pi.md +0 -2084
- package/.docs/organized/code-examples/with-react-hook-form.md +0 -727
- package/.docs/organized/code-examples/with-react-ink-web.md +0 -740
- package/.docs/organized/code-examples/with-react-ink.md +0 -473
- package/.docs/organized/code-examples/with-react-router.md +0 -936
- package/.docs/organized/code-examples/with-resumable-stream.md +0 -668
- package/.docs/organized/code-examples/with-store.md +0 -679
- package/.docs/organized/code-examples/with-svelte.md +0 -415
- package/.docs/organized/code-examples/with-sveltekit.md +0 -1061
- package/.docs/organized/code-examples/with-tanstack.md +0 -812
- package/.docs/organized/code-examples/with-tap-runtime.md +0 -813
- package/.docs/organized/code-examples/with-virtualized-thread.md +0 -681
- package/.docs/organized/code-examples/with-vue.md +0 -408
- package/.docs/raw/docs/(getting-started)/architecture.mdx +0 -146
- package/.docs/raw/docs/(getting-started)/base-ui.mdx +0 -39
- package/.docs/raw/docs/(getting-started)/cli.mdx +0 -542
- package/.docs/raw/docs/(getting-started)/devtools.mdx +0 -79
- package/.docs/raw/docs/(getting-started)/index.mdx +0 -23
- package/.docs/raw/docs/(getting-started)/installation.mdx +0 -483
- package/.docs/raw/docs/(getting-started)/llm.mdx +0 -211
- package/.docs/raw/docs/(getting-started)/rtl.mdx +0 -78
- package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +0 -36
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +0 -34
- package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +0 -44
- package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +0 -59
- package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +0 -26
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -84
- package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +0 -64
- package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +0 -57
- package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +0 -49
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/a2ui.mdx +0 -40
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +0 -56
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +0 -86
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +0 -39
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +0 -42
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +0 -84
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +0 -85
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +0 -45
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +0 -93
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +0 -129
- package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +0 -31
- package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +0 -34
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +0 -350
- package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +0 -28
- package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +0 -97
- package/.docs/raw/docs/(reference)/api-reference/integrations/ai-sdk.mdx +0 -200
- package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -118
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -37
- package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +0 -50
- package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/overview.mdx +0 -566
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +0 -152
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +0 -239
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -208
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +0 -108
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -99
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -145
- package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +0 -82
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +0 -637
- package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -65
- package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +0 -73
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +0 -117
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -339
- package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +0 -77
- package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +0 -88
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -81
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -129
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +0 -138
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +0 -122
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -289
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +0 -32
- package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +0 -43
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +0 -43
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +0 -20
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -24
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +0 -36
- package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +0 -85
- package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +0 -45
- package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx +0 -55
- package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +0 -151
- package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +0 -106
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +0 -178
- package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +0 -48
- package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +0 -62
- package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +0 -19
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +0 -152
- package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +0 -22
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +0 -54
- package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +0 -36
- package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +0 -527
- package/.docs/raw/docs/cloud/ai-sdk.mdx +0 -604
- package/.docs/raw/docs/cloud/authorization.mdx +0 -252
- package/.docs/raw/docs/cloud/index.mdx +0 -46
- package/.docs/raw/docs/cloud/langgraph.mdx +0 -554
- package/.docs/raw/docs/copilots/assistant-frame.mdx +0 -411
- package/.docs/raw/docs/copilots/make-assistant-visible.mdx +0 -82
- package/.docs/raw/docs/copilots/model-context.mdx +0 -156
- package/.docs/raw/docs/copilots/motivation.mdx +0 -202
- package/.docs/raw/docs/copilots/use-assistant-instructions.mdx +0 -64
- package/.docs/raw/docs/guides/attachments.mdx +0 -619
- package/.docs/raw/docs/guides/branching.mdx +0 -76
- package/.docs/raw/docs/guides/chain-of-thought.mdx +0 -164
- package/.docs/raw/docs/guides/chatgpt-subscription.mdx +0 -108
- package/.docs/raw/docs/guides/context-api.mdx +0 -619
- package/.docs/raw/docs/guides/dictation.mdx +0 -298
- package/.docs/raw/docs/guides/editing.mdx +0 -102
- package/.docs/raw/docs/guides/electron.mdx +0 -369
- package/.docs/raw/docs/guides/headless-composer-input.mdx +0 -113
- package/.docs/raw/docs/guides/image-generation.mdx +0 -74
- package/.docs/raw/docs/guides/index.mdx +0 -117
- package/.docs/raw/docs/guides/input-history.mdx +0 -55
- package/.docs/raw/docs/guides/latex.mdx +0 -158
- package/.docs/raw/docs/guides/mentions.mdx +0 -575
- package/.docs/raw/docs/guides/message-timing.mdx +0 -215
- package/.docs/raw/docs/guides/quoting.mdx +0 -169
- package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +0 -212
- package/.docs/raw/docs/guides/resumable-stream-stores.mdx +0 -152
- package/.docs/raw/docs/guides/resumable-streams.mdx +0 -292
- package/.docs/raw/docs/guides/slash-commands.mdx +0 -358
- package/.docs/raw/docs/guides/speech.mdx +0 -172
- package/.docs/raw/docs/guides/suggestions.mdx +0 -384
- package/.docs/raw/docs/guides/virtualization.mdx +0 -133
- package/.docs/raw/docs/guides/voice.mdx +0 -310
- package/.docs/raw/docs/ink/adapters.mdx +0 -99
- package/.docs/raw/docs/ink/custom-backend.mdx +0 -254
- package/.docs/raw/docs/ink/hooks.mdx +0 -469
- package/.docs/raw/docs/ink/index.mdx +0 -237
- package/.docs/raw/docs/ink/migration.mdx +0 -138
- package/.docs/raw/docs/ink/primitives.mdx +0 -1259
- package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +0 -528
- package/.docs/raw/docs/integrations/auth/better-auth.mdx +0 -188
- package/.docs/raw/docs/integrations/auth/clerk.mdx +0 -166
- package/.docs/raw/docs/integrations/auth/next-auth.mdx +0 -191
- package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +0 -88
- package/.docs/raw/docs/integrations/frameworks/cloudflare-agents.mdx +0 -283
- package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +0 -188
- package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +0 -57
- package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +0 -201
- package/.docs/raw/docs/integrations/gateways/index.mdx +0 -162
- package/.docs/raw/docs/integrations/index.mdx +0 -178
- package/.docs/raw/docs/integrations/observability/helicone.mdx +0 -129
- package/.docs/raw/docs/integrations/observability/langfuse.mdx +0 -161
- package/.docs/raw/docs/integrations/observability/langsmith.mdx +0 -151
- package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +0 -773
- package/.docs/raw/docs/migrations/deprecation-policy.mdx +0 -42
- package/.docs/raw/docs/migrations/index.mdx +0 -50
- package/.docs/raw/docs/migrations/react-compatibility.mdx +0 -74
- package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +0 -328
- package/.docs/raw/docs/migrations/toolkit-tools.mdx +0 -236
- package/.docs/raw/docs/migrations/v0-11.mdx +0 -172
- package/.docs/raw/docs/migrations/v0-12.mdx +0 -302
- package/.docs/raw/docs/migrations/v0-14.mdx +0 -297
- package/.docs/raw/docs/migrations/v0-15.mdx +0 -270
- package/.docs/raw/docs/primitives/action-bar.mdx +0 -352
- package/.docs/raw/docs/primitives/assistant-modal.mdx +0 -216
- package/.docs/raw/docs/primitives/attachment.mdx +0 -217
- package/.docs/raw/docs/primitives/branch-picker.mdx +0 -222
- package/.docs/raw/docs/primitives/chain-of-thought.mdx +0 -315
- package/.docs/raw/docs/primitives/composer.mdx +0 -659
- package/.docs/raw/docs/primitives/error.mdx +0 -142
- package/.docs/raw/docs/primitives/index.mdx +0 -99
- package/.docs/raw/docs/primitives/message.mdx +0 -618
- package/.docs/raw/docs/primitives/selection-toolbar.mdx +0 -191
- package/.docs/raw/docs/primitives/suggestion.mdx +0 -254
- package/.docs/raw/docs/primitives/thread-list.mdx +0 -467
- package/.docs/raw/docs/primitives/thread.mdx +0 -509
- package/.docs/raw/docs/react-native/adapters.mdx +0 -94
- package/.docs/raw/docs/react-native/custom-backend.mdx +0 -207
- package/.docs/raw/docs/react-native/hooks.mdx +0 -339
- package/.docs/raw/docs/react-native/index.mdx +0 -289
- package/.docs/raw/docs/react-native/migration.mdx +0 -142
- package/.docs/raw/docs/react-native/primitives.mdx +0 -976
- package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +0 -399
- package/.docs/raw/docs/runtimes/a2a/overview.mdx +0 -60
- package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +0 -216
- package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +0 -124
- package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +0 -70
- package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +0 -243
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +0 -267
- package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +0 -61
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -122
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +0 -135
- package/.docs/raw/docs/runtimes/ai-sdk/v6-legacy.mdx +0 -636
- package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +0 -731
- package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +0 -118
- package/.docs/raw/docs/runtimes/concepts/adapters.mdx +0 -265
- package/.docs/raw/docs/runtimes/concepts/architecture.mdx +0 -167
- package/.docs/raw/docs/runtimes/concepts/stability.mdx +0 -68
- package/.docs/raw/docs/runtimes/concepts/threads.mdx +0 -513
- package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +0 -763
- package/.docs/raw/docs/runtimes/custom/data-stream.mdx +0 -339
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +0 -957
- package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +0 -902
- package/.docs/raw/docs/runtimes/custom/overview.mdx +0 -71
- package/.docs/raw/docs/runtimes/eve/overview.mdx +0 -151
- package/.docs/raw/docs/runtimes/eve/quickstart.mdx +0 -192
- package/.docs/raw/docs/runtimes/google-adk/api.mdx +0 -256
- package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +0 -784
- package/.docs/raw/docs/runtimes/google-adk/overview.mdx +0 -69
- package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +0 -229
- package/.docs/raw/docs/runtimes/langchain.mdx +0 -901
- package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +0 -181
- package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +0 -305
- package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +0 -104
- package/.docs/raw/docs/runtimes/langgraph/overview.mdx +0 -84
- package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +0 -496
- package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +0 -144
- package/.docs/raw/docs/runtimes/langgraph/threads.mdx +0 -113
- package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +0 -29
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -93
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +0 -347
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -393
- package/.docs/raw/docs/runtimes/opencode/hooks.mdx +0 -194
- package/.docs/raw/docs/runtimes/opencode/overview.mdx +0 -58
- package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +0 -119
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +0 -133
- package/.docs/raw/docs/tools/a2ui.mdx +0 -107
- package/.docs/raw/docs/tools/backend.mdx +0 -147
- package/.docs/raw/docs/tools/defining-tools.mdx +0 -574
- package/.docs/raw/docs/tools/dynamic-tools.mdx +0 -112
- package/.docs/raw/docs/tools/generative-ui-primitive.mdx +0 -180
- package/.docs/raw/docs/tools/generative-ui-slack.mdx +0 -167
- package/.docs/raw/docs/tools/generative-ui-teams.mdx +0 -160
- package/.docs/raw/docs/tools/generative-ui.mdx +0 -322
- package/.docs/raw/docs/tools/index.mdx +0 -72
- package/.docs/raw/docs/tools/interactables.mdx +0 -1084
- package/.docs/raw/docs/tools/mcp-apps.mdx +0 -363
- package/.docs/raw/docs/tools/mcp.mdx +0 -466
- package/.docs/raw/docs/tools/multi-agent.mdx +0 -237
- package/.docs/raw/docs/tools/openui.mdx +0 -175
- package/.docs/raw/docs/tools/tool-ui.mdx +0 -1020
- package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
- package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
- package/.docs/raw/docs/ui/attachment.mdx +0 -279
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -247
- package/.docs/raw/docs/ui/context-display.mdx +0 -148
- package/.docs/raw/docs/ui/directive-text.mdx +0 -114
- package/.docs/raw/docs/ui/file.mdx +0 -159
- package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
- package/.docs/raw/docs/ui/image.mdx +0 -102
- package/.docs/raw/docs/ui/markdown.mdx +0 -103
- package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
- package/.docs/raw/docs/ui/mermaid.mdx +0 -92
- package/.docs/raw/docs/ui/message-timing.mdx +0 -93
- package/.docs/raw/docs/ui/model-selector.mdx +0 -455
- package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
- package/.docs/raw/docs/ui/quote.mdx +0 -211
- package/.docs/raw/docs/ui/reasoning.mdx +0 -214
- package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
- package/.docs/raw/docs/ui/sources.mdx +0 -186
- package/.docs/raw/docs/ui/streamdown.mdx +0 -392
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
- package/.docs/raw/docs/ui/thread-list.mdx +0 -411
- package/.docs/raw/docs/ui/thread.mdx +0 -559
- package/.docs/raw/docs/ui/tool-fallback.mdx +0 -141
- package/.docs/raw/docs/ui/tool-group.mdx +0 -240
- package/.docs/raw/docs/ui/voice.mdx +0 -173
- package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
- package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
- package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
- package/dist/constants.d.ts +0 -14
- package/dist/constants.d.ts.map +0 -1
- package/dist/constants.js +0 -19
- package/dist/constants.js.map +0 -1
- package/dist/prepare-docs/code-examples.d.ts +0 -5
- package/dist/prepare-docs/code-examples.d.ts.map +0 -1
- package/dist/prepare-docs/code-examples.js +0 -117
- package/dist/prepare-docs/code-examples.js.map +0 -1
- package/dist/prepare-docs/copy-raw.d.ts +0 -5
- package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
- package/dist/prepare-docs/copy-raw.js +0 -49
- package/dist/prepare-docs/copy-raw.js.map +0 -1
- package/dist/prepare-docs/prepare.d.ts +0 -1
- package/dist/prepare-docs/prepare.js +0 -22
- package/dist/prepare-docs/prepare.js.map +0 -1
- package/dist/prompts/xulux-playground.d.ts +0 -12
- package/dist/prompts/xulux-playground.d.ts.map +0 -1
- package/dist/prompts/xulux-playground.js +0 -33
- package/dist/prompts/xulux-playground.js.map +0 -1
- package/dist/tools/docs.d.ts +0 -22
- package/dist/tools/docs.d.ts.map +0 -1
- package/dist/tools/docs.js +0 -177
- package/dist/tools/docs.js.map +0 -1
- package/dist/tools/examples.d.ts +0 -24
- package/dist/tools/examples.d.ts.map +0 -1
- package/dist/tools/examples.js +0 -87
- package/dist/tools/examples.js.map +0 -1
- package/dist/tools/resources.d.ts +0 -6
- package/dist/tools/resources.d.ts.map +0 -1
- package/dist/tools/resources.js +0 -75
- package/dist/tools/resources.js.map +0 -1
- package/dist/tools/search.d.ts +0 -24
- package/dist/tools/search.d.ts.map +0 -1
- package/dist/tools/search.js +0 -39
- package/dist/tools/search.js.map +0 -1
- package/dist/tools/tests/mcp-test-client.d.ts +0 -15
- package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
- package/dist/tools/tests/mcp-test-client.js +0 -68
- package/dist/tools/tests/mcp-test-client.js.map +0 -1
- package/dist/tools/tests/test-setup.d.ts +0 -7
- package/dist/tools/tests/test-setup.d.ts.map +0 -1
- package/dist/tools/tests/test-setup.js +0 -36
- package/dist/tools/tests/test-setup.js.map +0 -1
- package/dist/tools/xulux-templates.d.ts +0 -58
- package/dist/tools/xulux-templates.d.ts.map +0 -1
- package/dist/tools/xulux-templates.js +0 -84
- package/dist/tools/xulux-templates.js.map +0 -1
- package/dist/utils/cache.d.ts +0 -5
- package/dist/utils/cache.d.ts.map +0 -1
- package/dist/utils/cache.js +0 -18
- package/dist/utils/cache.js.map +0 -1
- package/dist/utils/logger.d.ts +0 -10
- package/dist/utils/logger.d.ts.map +0 -1
- package/dist/utils/logger.js +0 -20
- package/dist/utils/logger.js.map +0 -1
- package/dist/utils/mcp-format.d.ts +0 -11
- package/dist/utils/mcp-format.d.ts.map +0 -1
- package/dist/utils/mcp-format.js +0 -14
- package/dist/utils/mcp-format.js.map +0 -1
- package/dist/utils/mdx.d.ts +0 -12
- package/dist/utils/mdx.d.ts.map +0 -1
- package/dist/utils/mdx.js +0 -45
- package/dist/utils/mdx.js.map +0 -1
- package/dist/utils/paths.d.ts +0 -12
- package/dist/utils/paths.d.ts.map +0 -1
- package/dist/utils/paths.js +0 -93
- package/dist/utils/paths.js.map +0 -1
- package/dist/utils/search.d.ts +0 -10
- package/dist/utils/search.d.ts.map +0 -1
- package/dist/utils/search.js +0 -97
- package/dist/utils/search.js.map +0 -1
- package/dist/utils/security.d.ts +0 -5
- package/dist/utils/security.d.ts.map +0 -1
- package/dist/utils/security.js +0 -22
- package/dist/utils/security.js.map +0 -1
- package/dist/xulux/catalog-client.d.ts +0 -14
- package/dist/xulux/catalog-client.d.ts.map +0 -1
- package/dist/xulux/catalog-client.js +0 -112
- package/dist/xulux/catalog-client.js.map +0 -1
- package/dist/xulux/fallback-catalog.d.ts +0 -7
- package/dist/xulux/fallback-catalog.d.ts.map +0 -1
- package/dist/xulux/fallback-catalog.js +0 -47
- package/dist/xulux/fallback-catalog.js.map +0 -1
- package/dist/xulux/fetch-sandbox.d.ts +0 -5
- package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
- package/dist/xulux/fetch-sandbox.js +0 -40
- package/dist/xulux/fetch-sandbox.js.map +0 -1
- package/dist/xulux/template-service.d.ts +0 -84
- package/dist/xulux/template-service.d.ts.map +0 -1
- package/dist/xulux/template-service.js +0 -223
- package/dist/xulux/template-service.js.map +0 -1
- package/dist/xulux/types.d.ts +0 -55
- package/dist/xulux/types.d.ts.map +0 -1
- package/dist/xulux/types.js +0 -6
- package/dist/xulux/types.js.map +0 -1
- package/src/constants.ts +0 -24
- package/src/prepare-docs/code-examples.ts +0 -158
- package/src/prepare-docs/copy-raw.ts +0 -50
- package/src/prepare-docs/prepare.ts +0 -24
- package/src/prompts/xulux-playground.ts +0 -36
- package/src/tools/docs.ts +0 -255
- package/src/tools/examples.ts +0 -114
- package/src/tools/resources.ts +0 -111
- package/src/tools/search.ts +0 -46
- package/src/tools/tests/completions.test.ts +0 -60
- package/src/tools/tests/directory-size-cap.test.ts +0 -50
- package/src/tools/tests/docs.test.ts +0 -147
- package/src/tools/tests/examples.test.ts +0 -94
- package/src/tools/tests/integration.test.ts +0 -45
- package/src/tools/tests/json-parsing.test.ts +0 -23
- package/src/tools/tests/listings-cache.test.ts +0 -19
- package/src/tools/tests/mcp-protocol.test.ts +0 -216
- package/src/tools/tests/mcp-test-client.ts +0 -111
- package/src/tools/tests/path-traversal.test.ts +0 -84
- package/src/tools/tests/resources.test.ts +0 -133
- package/src/tools/tests/search.test.ts +0 -37
- package/src/tools/tests/test-setup.ts +0 -50
- package/src/tools/tests/xulux-templates.test.ts +0 -325
- package/src/tools/xulux-templates.ts +0 -141
- package/src/utils/cache.ts +0 -20
- package/src/utils/logger.ts +0 -20
- package/src/utils/mcp-format.ts +0 -14
- package/src/utils/mdx.ts +0 -59
- package/src/utils/paths.ts +0 -139
- package/src/utils/search.ts +0 -131
- package/src/utils/security.ts +0 -52
- package/src/utils/tests/cache.test.ts +0 -51
- package/src/utils/tests/mcp-format.test.ts +0 -22
- package/src/utils/tests/security.test.ts +0 -119
- package/src/xulux/catalog-client.ts +0 -150
- package/src/xulux/fallback-catalog.ts +0 -63
- package/src/xulux/fetch-sandbox.ts +0 -56
- package/src/xulux/template-service.ts +0 -406
- package/src/xulux/types.ts +0 -64
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: RTL Support
|
|
3
|
-
description: Use assistant-ui with right-to-left languages like Arabic, Hebrew, and Persian.
|
|
4
|
-
platforms: ["react"]
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Components shipped through `@assistant-ui/ui` (npm) and the shadcn registry (`npx shadcn@latest add @assistant-ui/<name>`) use logical Tailwind classes (`ms-*`, `pe-*`, `text-start`, `end-*`, `border-s`, ...). They flip automatically under `dir="rtl"` and render byte-identically under `dir="ltr"` (the default) — there is nothing to opt out of.
|
|
8
|
-
|
|
9
|
-
If you scaffolded from one of our templates (e.g. `npx assistant-ui@latest create -t default`), the generated `components/` folder still uses physical classes (`ml-*`, `text-left`, ...). Run shadcn's built-in migration **once** to convert both the shadcn primitives and assistant-ui's wrappers:
|
|
10
|
-
|
|
11
|
-
```sh
|
|
12
|
-
# shadcn primitives under components/ui/
|
|
13
|
-
npx shadcn@latest migrate rtl
|
|
14
|
-
|
|
15
|
-
# assistant-ui wrappers (pass a custom glob)
|
|
16
|
-
npx shadcn@latest migrate rtl 'components/assistant-ui/**/*.tsx'
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Commit the diff and do not re-run. The upstream migration is not fully idempotent on repeat runs ([#9891](https://github.com/shadcn-ui/ui/pull/9891)); you may end up with duplicated `rtl:translate-x-*` classes.
|
|
20
|
-
|
|
21
|
-
After migrating, follow the setup below.
|
|
22
|
-
|
|
23
|
-
## Setup
|
|
24
|
-
|
|
25
|
-
### 1. Install the `direction` component
|
|
26
|
-
|
|
27
|
-
<InstallCommand shadcn={["direction"]} />
|
|
28
|
-
|
|
29
|
-
This adds `components/ui/direction.tsx`, a thin re-export of Radix UI's `DirectionProvider` and `useDirection`. It ensures Radix popovers, dropdowns, and menus pick up the current direction.
|
|
30
|
-
|
|
31
|
-
### 2. Set `dir` on your root element
|
|
32
|
-
|
|
33
|
-
```tsx title="app/layout.tsx"
|
|
34
|
-
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
35
|
-
return (
|
|
36
|
-
<html lang="ar" dir="rtl">
|
|
37
|
-
<body>{children}</body>
|
|
38
|
-
</html>
|
|
39
|
-
);
|
|
40
|
-
}
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### 3. Wrap your app with `DirectionProvider`
|
|
44
|
-
|
|
45
|
-
```tsx title="app/providers.tsx"
|
|
46
|
-
"use client";
|
|
47
|
-
|
|
48
|
-
import { DirectionProvider } from "@/components/ui/direction";
|
|
49
|
-
|
|
50
|
-
export function Providers({ children }: { children: React.ReactNode }) {
|
|
51
|
-
return <DirectionProvider dir="rtl">{children}</DirectionProvider>;
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
For apps that need to switch direction at runtime, drive `dir` from state and also update `document.documentElement.dir` to keep Tailwind's `[dir=rtl]` selector in sync.
|
|
56
|
-
|
|
57
|
-
## How it works
|
|
58
|
-
|
|
59
|
-
Every physical class (`ml-4`, `text-left`, `right-3`, `border-l`, ...) in `@assistant-ui/ui` is authored in logical form (`ms-4`, `text-start`, `end-3`, `border-s`, ...). Logical properties resolve to the matching physical side based on the ancestor with a `dir` attribute:
|
|
60
|
-
|
|
61
|
-
| Class | `dir="ltr"` | `dir="rtl"` |
|
|
62
|
-
| ----- | ----------- | ----------- |
|
|
63
|
-
| `ms-4` | `margin-left: 1rem` | `margin-right: 1rem` |
|
|
64
|
-
| `pe-2` | `padding-right: 0.5rem` | `padding-left: 0.5rem` |
|
|
65
|
-
| `end-3` | `right: 0.75rem` | `left: 0.75rem` |
|
|
66
|
-
| `text-start` | `text-align: left` | `text-align: right` |
|
|
67
|
-
| `border-s` | `border-left` | `border-right` |
|
|
68
|
-
|
|
69
|
-
A handful of Tailwind utilities have no logical equivalent, so we ship both the LTR value and an `rtl:` override:
|
|
70
|
-
|
|
71
|
-
- `translate-x-*`: emits `-translate-x-*` plus `rtl:translate-x-*` (sign-flipped).
|
|
72
|
-
- `space-x-*` / `divide-x-*`: emits the original plus `rtl:space-x-reverse` / `rtl:divide-x-reverse`.
|
|
73
|
-
|
|
74
|
-
## Known edges
|
|
75
|
-
|
|
76
|
-
- **Radix `data-[side=left|right]:slide-in-from-*`** animations are intentionally preserved as physical. Radix's `DirectionProvider` already flips the emitted `data-side` value, so no rewrite is needed.
|
|
77
|
-
- **Third-party components and template scaffolds** may still use physical classes. Run `npx shadcn@latest migrate rtl` once per project (optionally with a path glob) to convert them. Do not re-run — see the note about upstream idempotency in the intro.
|
|
78
|
-
- **Text that mixes LTR and RTL content** (e.g., English code inside Arabic prose) relies on the browser's bidi algorithm. Wrap unambiguous spans with `<bdi>` or `dir="ltr"` if you need to pin direction locally.
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Attachment Adapters
|
|
3
|
-
description: Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { AttachmentAdapter, CloudFileAttachmentAdapter, CompositeAttachmentAdapter, SimpleImageAttachmentAdapter, SimpleTextAttachmentAdapter } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### AttachmentAdapter
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...AttachmentAdapter} />
|
|
20
|
-
|
|
21
|
-
### CloudFileAttachmentAdapter
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...CloudFileAttachmentAdapter} />
|
|
24
|
-
|
|
25
|
-
### CompositeAttachmentAdapter
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...CompositeAttachmentAdapter} />
|
|
28
|
-
|
|
29
|
-
### SimpleImageAttachmentAdapter
|
|
30
|
-
|
|
31
|
-
<ParametersTable {...SimpleImageAttachmentAdapter} />
|
|
32
|
-
|
|
33
|
-
### SimpleTextAttachmentAdapter
|
|
34
|
-
|
|
35
|
-
<ParametersTable {...SimpleTextAttachmentAdapter} />
|
|
36
|
-
{/* api-reference:end */}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Feedback Adapter
|
|
3
|
-
description: Capture and respond to message feedback submitted through action primitives or runtime actions.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { FeedbackAdapter } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### FeedbackAdapter
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...FeedbackAdapter} />
|
|
20
|
-
{/* api-reference:end */}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Adapters API Reference
|
|
3
|
-
description: Adapter interfaces for connecting chat models, persistence, file attachments, feedback, and suggestions to assistant-ui React runtimes.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
7
|
-
{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
|
|
8
|
-
|
|
9
|
-
{/* api-manual:start */}
|
|
10
|
-
Adapters define the boundaries between assistant-ui and the systems around it. Use them when you need custom model execution, attachment handling, persistence, feedback collection, or prompt suggestions.
|
|
11
|
-
{/* api-manual:end */}
|
|
12
|
-
|
|
13
|
-
## Pages
|
|
14
|
-
|
|
15
|
-
<Cards>
|
|
16
|
-
<Card title={"Attachment Adapters"} href={"/docs/api-reference/adapters/attachments"}>
|
|
17
|
-
{"Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages."}
|
|
18
|
-
</Card>
|
|
19
|
-
<Card title={"Feedback Adapter"} href={"/docs/api-reference/adapters/feedback"}>
|
|
20
|
-
{"Capture and respond to message feedback submitted through action primitives or runtime actions."}
|
|
21
|
-
</Card>
|
|
22
|
-
<Card title={"Model Adapters"} href={"/docs/api-reference/adapters/model"}>
|
|
23
|
-
{"Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes."}
|
|
24
|
-
</Card>
|
|
25
|
-
<Card title={"Persistence Adapters"} href={"/docs/api-reference/adapters/persistence"}>
|
|
26
|
-
{"Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads."}
|
|
27
|
-
</Card>
|
|
28
|
-
<Card title={"Runtime Adapter Context"} href={"/docs/api-reference/adapters/runtime"}>
|
|
29
|
-
{"Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior."}
|
|
30
|
-
</Card>
|
|
31
|
-
<Card title={"Suggestion Adapters"} href={"/docs/api-reference/adapters/suggestions"}>
|
|
32
|
-
{"Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes."}
|
|
33
|
-
</Card>
|
|
34
|
-
</Cards>
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Model Adapters
|
|
3
|
-
description: Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { ChatModelAdapter, ChatModelRunOptions, ChatModelRunResult, ChatModelRunUpdate, CreateResumeRunConfig, CreateStartRunConfig, LanguageModelConfig } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### ChatModelAdapter
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...ChatModelAdapter} />
|
|
20
|
-
|
|
21
|
-
### ChatModelRunOptions
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...ChatModelRunOptions} />
|
|
24
|
-
|
|
25
|
-
### ChatModelRunResult
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...ChatModelRunResult} />
|
|
28
|
-
|
|
29
|
-
### ChatModelRunUpdate
|
|
30
|
-
|
|
31
|
-
<ParametersTable {...ChatModelRunUpdate} />
|
|
32
|
-
|
|
33
|
-
### CreateResumeRunConfig
|
|
34
|
-
|
|
35
|
-
<ParametersTable {...CreateResumeRunConfig} />
|
|
36
|
-
|
|
37
|
-
### CreateStartRunConfig
|
|
38
|
-
|
|
39
|
-
<ParametersTable {...CreateStartRunConfig} />
|
|
40
|
-
|
|
41
|
-
### LanguageModelConfig
|
|
42
|
-
|
|
43
|
-
<ParametersTable {...LanguageModelConfig} />
|
|
44
|
-
{/* api-reference:end */}
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Persistence Adapters
|
|
3
|
-
description: Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { ExportedMessageRepository, GenericThreadHistoryAdapter, InMemoryThreadListAdapter, MessageFormatAdapter, RemoteThreadListAdapter, ThreadHistoryAdapter } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### ExportedMessageRepository
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...ExportedMessageRepository} />
|
|
20
|
-
|
|
21
|
-
### GenericThreadHistoryAdapter
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...GenericThreadHistoryAdapter} />
|
|
24
|
-
|
|
25
|
-
### InMemoryThreadListAdapter
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...InMemoryThreadListAdapter} />
|
|
28
|
-
|
|
29
|
-
### MessageFormatAdapter
|
|
30
|
-
|
|
31
|
-
<ParametersTable {...MessageFormatAdapter} />
|
|
32
|
-
|
|
33
|
-
### RemoteThreadListAdapter
|
|
34
|
-
|
|
35
|
-
{/* api-example:RemoteThreadListAdapter:start */}
|
|
36
|
-
```tsx
|
|
37
|
-
const runtime = useRemoteThreadListRuntime({
|
|
38
|
-
adapter: myRemoteThreadListAdapter,
|
|
39
|
-
runtimeHook: () => useLocalRuntime(chatModelAdapter),
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
{/* api-example:RemoteThreadListAdapter:end */}
|
|
43
|
-
|
|
44
|
-
<ParametersTable {...RemoteThreadListAdapter} />
|
|
45
|
-
|
|
46
|
-
### ThreadHistoryAdapter
|
|
47
|
-
|
|
48
|
-
{/* api-example:ThreadHistoryAdapter:start */}
|
|
49
|
-
```tsx
|
|
50
|
-
const runtime = useLocalRuntime(chatModelAdapter, {
|
|
51
|
-
adapters: {
|
|
52
|
-
history: myHistoryAdapter,
|
|
53
|
-
},
|
|
54
|
-
});
|
|
55
|
-
```
|
|
56
|
-
{/* api-example:ThreadHistoryAdapter:end */}
|
|
57
|
-
|
|
58
|
-
<ParametersTable {...ThreadHistoryAdapter} />
|
|
59
|
-
{/* api-reference:end */}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Runtime Adapter Context
|
|
3
|
-
description: Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { RuntimeAdapters } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### RuntimeAdapters
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...RuntimeAdapters} />
|
|
20
|
-
{/* api-reference:end */}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Suggestion Adapters
|
|
3
|
-
description: Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { SuggestionAdapter } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### createSuggestionAdapter
|
|
18
|
-
|
|
19
|
-
```ts
|
|
20
|
-
const createSuggestionAdapter: (options: CreateSuggestionAdapterOptions) => SuggestionAdapter;
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
### SuggestionAdapter
|
|
24
|
-
|
|
25
|
-
<ParametersTable {...SuggestionAdapter} />
|
|
26
|
-
{/* api-reference:end */}
|
package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx
DELETED
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: AssistantRuntimeProvider
|
|
3
|
-
description: Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { AssistantRuntimeProvider, AuiProvider } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### AssistantRuntimeProvider
|
|
18
|
-
|
|
19
|
-
{/* api-example:AssistantRuntimeProvider:start */}
|
|
20
|
-
```tsx {1, 8, 10}
|
|
21
|
-
import { AssistantRuntimeProvider } from "@assistant-ui/react";
|
|
22
|
-
import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/ai-sdk";
|
|
23
|
-
|
|
24
|
-
const MyApp = () => {
|
|
25
|
-
const runtime = useChatRuntime({
|
|
26
|
-
transport: new AssistantChatTransport({
|
|
27
|
-
api: "/api/chat",
|
|
28
|
-
}),
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
return (
|
|
32
|
-
<AssistantRuntimeProvider runtime={runtime}>
|
|
33
|
-
{/* your app */}
|
|
34
|
-
</AssistantRuntimeProvider>
|
|
35
|
-
);
|
|
36
|
-
};
|
|
37
|
-
```
|
|
38
|
-
{/* api-example:AssistantRuntimeProvider:end */}
|
|
39
|
-
|
|
40
|
-
<ParametersTable {...AssistantRuntimeProvider} />
|
|
41
|
-
|
|
42
|
-
### AuiProvider
|
|
43
|
-
|
|
44
|
-
Supplies an `AssistantClient` to the React tree.
|
|
45
|
-
|
|
46
|
-
Place near the root of any subtree that uses [useAui](/docs/api-reference/hooks/state#useaui) or the
|
|
47
|
-
primitives built on it. Components rendered outside an `AuiProvider`
|
|
48
|
-
receive a default client whose scope accessors throw on use, so
|
|
49
|
-
missing-provider mistakes surface at the point of use.
|
|
50
|
-
|
|
51
|
-
`config` is required and must be built with [AuiConfig](/docs/api-reference/utilities/miscellaneous#auiconfig). At the top
|
|
52
|
-
level, `config` alone creates this subtree's own client. Under a parent
|
|
53
|
-
provider, `extends` is mandatory: pass `extends={aui}` to extend the parent
|
|
54
|
-
client or `extends={null}` to isolate from it (enforced with a dev error).
|
|
55
|
-
Configs are identity-insensitive — a fresh object per render is safe.
|
|
56
|
-
A config whose scopes are all Derived keeps its scope set fixed
|
|
57
|
-
at mount (dev-enforced); configs with a root scope, and empty configs,
|
|
58
|
-
may grow and shrink scopes across renders. `ref` receives the resulting
|
|
59
|
-
client after mount.
|
|
60
|
-
|
|
61
|
-
When mounting a runtime built with one of the runtime hooks, use
|
|
62
|
-
[AssistantRuntimeProvider](/docs/api-reference/context-providers/assistant-runtime-provider#assistantruntimeprovider) — it installs an `AuiProvider`
|
|
63
|
-
internally — rather than wiring `AuiProvider` yourself.
|
|
64
|
-
|
|
65
|
-
```tsx
|
|
66
|
-
function MessageScope({ index, children }) {
|
|
67
|
-
const aui = useAui();
|
|
68
|
-
const config = AuiConfig({
|
|
69
|
-
message: Derived({
|
|
70
|
-
source: "thread",
|
|
71
|
-
query: { index },
|
|
72
|
-
get: (aui) => aui.thread.message({ index }),
|
|
73
|
-
}),
|
|
74
|
-
});
|
|
75
|
-
return (
|
|
76
|
-
<AuiProvider extends={aui} config={config}>
|
|
77
|
-
{children}
|
|
78
|
-
</AuiProvider>
|
|
79
|
-
);
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
<ParametersTable {...AuiProvider} />
|
|
84
|
-
{/* api-reference:end */}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Context Providers API Reference
|
|
3
|
-
description: React context providers including AssistantRuntimeProvider that scope assistant-ui runtime, thread, message part, and attachment state for primitives, hooks, and custom chat components.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
7
|
-
{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
|
|
8
|
-
|
|
9
|
-
{/* api-manual:start */}
|
|
10
|
-
Context providers define where assistant-ui primitives and hooks read their state. Most apps only need `AssistantRuntimeProvider`, while scoped providers support custom renderers, isolated message parts, and advanced composition.
|
|
11
|
-
{/* api-manual:end */}
|
|
12
|
-
|
|
13
|
-
## Pages
|
|
14
|
-
|
|
15
|
-
<Cards>
|
|
16
|
-
<Card title={"AssistantRuntimeProvider"} href={"/docs/api-reference/context-providers/assistant-runtime-provider"}>
|
|
17
|
-
{"Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state."}
|
|
18
|
-
</Card>
|
|
19
|
-
<Card title={"Scoped Providers"} href={"/docs/api-reference/context-providers/scoped-providers"}>
|
|
20
|
-
{"Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition."}
|
|
21
|
-
</Card>
|
|
22
|
-
</Cards>
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Scoped Providers
|
|
3
|
-
description: Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { ChainOfThoughtByIndicesProvider, ComposerAttachmentByIndexProvider, MessageAttachmentByIndexProvider, MessageByIndexProvider, MessageProvider, PartByIndexProvider, ReadonlyThreadProvider, RuntimeAdapterProvider, SuggestionByIndexProvider, TextMessagePartProvider, ThreadListItemByIndexProvider, ThreadListItemRuntimeProvider } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### ChainOfThoughtByIndicesProvider
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...ChainOfThoughtByIndicesProvider} />
|
|
20
|
-
|
|
21
|
-
### ComposerAttachmentByIndexProvider
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...ComposerAttachmentByIndexProvider} />
|
|
24
|
-
|
|
25
|
-
### MessageAttachmentByIndexProvider
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...MessageAttachmentByIndexProvider} />
|
|
28
|
-
|
|
29
|
-
### MessageByIndexProvider
|
|
30
|
-
|
|
31
|
-
<ParametersTable {...MessageByIndexProvider} />
|
|
32
|
-
|
|
33
|
-
### MessageProvider
|
|
34
|
-
|
|
35
|
-
<ParametersTable {...MessageProvider} />
|
|
36
|
-
|
|
37
|
-
### PartByIndexProvider
|
|
38
|
-
|
|
39
|
-
<ParametersTable {...PartByIndexProvider} />
|
|
40
|
-
|
|
41
|
-
### ReadonlyThreadProvider
|
|
42
|
-
|
|
43
|
-
<ParametersTable {...ReadonlyThreadProvider} />
|
|
44
|
-
|
|
45
|
-
### RuntimeAdapterProvider
|
|
46
|
-
|
|
47
|
-
<ParametersTable {...RuntimeAdapterProvider} />
|
|
48
|
-
|
|
49
|
-
### SuggestionByIndexProvider
|
|
50
|
-
|
|
51
|
-
<ParametersTable {...SuggestionByIndexProvider} />
|
|
52
|
-
|
|
53
|
-
### TextMessagePartProvider
|
|
54
|
-
|
|
55
|
-
<ParametersTable {...TextMessagePartProvider} />
|
|
56
|
-
|
|
57
|
-
### ThreadListItemByIndexProvider
|
|
58
|
-
|
|
59
|
-
<ParametersTable {...ThreadListItemByIndexProvider} />
|
|
60
|
-
|
|
61
|
-
### ThreadListItemRuntimeProvider
|
|
62
|
-
|
|
63
|
-
<ParametersTable {...ThreadListItemRuntimeProvider} />
|
|
64
|
-
{/* api-reference:end */}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: External Store API Reference
|
|
3
|
-
description: External store runtime, message conversion helpers, and adapters for assistant-ui React apps that own their chat state outside the runtime.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
7
|
-
{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
|
|
8
|
-
|
|
9
|
-
{/* api-manual:start */}
|
|
10
|
-
External store APIs are for applications that already have their own message, thread, or persistence model. They let assistant-ui render and control that state without forcing the app to adopt the built-in runtime storage shape.
|
|
11
|
-
{/* api-manual:end */}
|
|
12
|
-
|
|
13
|
-
## Pages
|
|
14
|
-
|
|
15
|
-
<Cards>
|
|
16
|
-
<Card title={"Message Conversion"} href={"/docs/api-reference/external-store/message-conversion"}>
|
|
17
|
-
{"Convert external message formats into assistant-ui's message and thread state for the external store runtime."}
|
|
18
|
-
</Card>
|
|
19
|
-
<Card title={"External Store Runtime"} href={"/docs/api-reference/external-store/runtime"}>
|
|
20
|
-
{"Runtime components, options, and adapters for using assistant-ui with externally owned chat state."}
|
|
21
|
-
</Card>
|
|
22
|
-
</Cards>
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Message Conversion
|
|
3
|
-
description: Convert external message formats into assistant-ui's message and thread state for the external store runtime.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { useExternalMessageConverter } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### getExternalStoreMessages
|
|
18
|
-
|
|
19
|
-
```ts
|
|
20
|
-
const getExternalStoreMessages: <T>(input: { messages: readonly ThreadMessage[]; } | ThreadMessage | ThreadMessage["content"][number]) => T[];
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
### unstable_convertExternalMessages
|
|
24
|
-
|
|
25
|
-
```ts
|
|
26
|
-
const unstable_convertExternalMessages: <T extends WeakKey>(
|
|
27
|
-
messages: T[],
|
|
28
|
-
callback: useExternalMessageConverter.Callback<T>,
|
|
29
|
-
isRunning: boolean,
|
|
30
|
-
metadata: useExternalMessageConverter.Metadata,
|
|
31
|
-
) => ThreadMessage[];
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### unstable_createMessageConverter
|
|
35
|
-
|
|
36
|
-
```ts
|
|
37
|
-
const unstable_createMessageConverter: <T extends object>(callback: useExternalMessageConverter.Callback<T>) => { useThreadMessages: ({ messages, isRunning, joinStrategy, metadata, }: { messages: T[]; isRunning: boolean; joinStrategy?: JoinStrategy | undefined; metadata?: useExternalMessageConverter.Metadata; }) => ThreadMessage[]; toThreadMessages: (messages: T[], isRunning?: boolean, metadata?: useExternalMessageConverter.Metadata) => ThreadMessage[]; toOriginalMessages: (input: ThreadState | ThreadMessage | ThreadMessage["content"][number]) => unknown[]; toOriginalMessage: (input: ThreadState | ThreadMessage | ThreadMessage["content"][number]) => {}; useOriginalMessage: () => {}; useOriginalMessages: () => unknown[]; };
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### useExternalMessageConverter
|
|
41
|
-
|
|
42
|
-
<ParametersTable {...useExternalMessageConverter} />
|
|
43
|
-
|
|
44
|
-
### bindExternalStoreMessage
|
|
45
|
-
|
|
46
|
-
<Callout type="tip">
|
|
47
|
-
<strong>Experimental.</strong> This API is experimental and may change without notice.
|
|
48
|
-
</Callout>
|
|
49
|
-
|
|
50
|
-
Attach the original external store message(s) to a ThreadMessage or message part.
|
|
51
|
-
This is a no-op if the target already has a bound message.
|
|
52
|
-
Use `getExternalStoreMessages` to retrieve the bound messages later.
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
const bindExternalStoreMessage: <T>(target: object, message: T | T[]) => void;
|
|
56
|
-
```
|
|
57
|
-
{/* api-reference:end */}
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: External Store Runtime
|
|
3
|
-
description: Runtime components, options, and adapters for using assistant-ui with externally owned chat state.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { ExternalStoreAdapter, ExternalThread, ExternalThreadProps, ExternalThreadQueueAdapter, useExternalStoreRuntime, useExternalStoreSharedOptions } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### ExternalStoreAdapter
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...ExternalStoreAdapter} />
|
|
20
|
-
|
|
21
|
-
### ExternalThread
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...ExternalThread} />
|
|
24
|
-
|
|
25
|
-
### ExternalThreadProps
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...ExternalThreadProps} />
|
|
28
|
-
|
|
29
|
-
### ExternalThreadQueueAdapter
|
|
30
|
-
|
|
31
|
-
The queue surface a runtime exposes so the composer can stay usable during a
|
|
32
|
-
run and render the pending messages.
|
|
33
|
-
|
|
34
|
-
<ParametersTable {...ExternalThreadQueueAdapter} />
|
|
35
|
-
|
|
36
|
-
### pickExternalStoreSharedOptions
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
const pickExternalStoreSharedOptions: (options: ExternalStoreSharedOptions) => ExternalStoreSharedOptions;
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### useExternalStoreRuntime
|
|
43
|
-
|
|
44
|
-
<ParametersTable {...useExternalStoreRuntime} />
|
|
45
|
-
|
|
46
|
-
### useExternalStoreSharedOptions
|
|
47
|
-
|
|
48
|
-
<ParametersTable {...useExternalStoreSharedOptions} />
|
|
49
|
-
{/* api-reference:end */}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: A2UI
|
|
3
|
-
description: Convert A2UI surface operations into generative UI specs.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { A2uiOperation, A2uiOperationResult, A2uiState, A2uiSurfaceState, applyA2uiOperations, convertSurfaceToUISpec } from "@/generated/typeDocs";
|
|
7
|
-
|
|
8
|
-
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
-
{/* Do not edit manually. */}
|
|
10
|
-
|
|
11
|
-
{/* api-reference:start */}
|
|
12
|
-
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
-
{/* Do not edit this block manually. */}
|
|
14
|
-
|
|
15
|
-
## API Reference
|
|
16
|
-
|
|
17
|
-
### A2uiOperation
|
|
18
|
-
|
|
19
|
-
<ParametersTable {...A2uiOperation} />
|
|
20
|
-
|
|
21
|
-
### A2uiOperationResult
|
|
22
|
-
|
|
23
|
-
<ParametersTable {...A2uiOperationResult} />
|
|
24
|
-
|
|
25
|
-
### A2uiState
|
|
26
|
-
|
|
27
|
-
<ParametersTable {...A2uiState} />
|
|
28
|
-
|
|
29
|
-
### A2uiSurfaceState
|
|
30
|
-
|
|
31
|
-
<ParametersTable {...A2uiSurfaceState} />
|
|
32
|
-
|
|
33
|
-
### applyA2uiOperations
|
|
34
|
-
|
|
35
|
-
<ParametersTable {...applyA2uiOperations} />
|
|
36
|
-
|
|
37
|
-
### convertSurfaceToUISpec
|
|
38
|
-
|
|
39
|
-
<ParametersTable {...convertSurfaceToUISpec} />
|
|
40
|
-
{/* api-reference:end */}
|