@mastra/client-js 0.0.0-error-handler-fix-20251020202607 → 0.0.0-esbuild-bundle-worker-20260807182016

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 (127) hide show
  1. package/CHANGELOG.md +9405 -3
  2. package/LICENSE.md +15 -0
  3. package/README.md +11 -13
  4. package/dist/_types/@ai-sdk_provider/dist/index.d.ts +1587 -0
  5. package/dist/_types/@ai-sdk_provider-utils/dist/index.d.ts +379 -0
  6. package/dist/_types/@ai-sdk_ui-utils/dist/index.d.ts +820 -0
  7. package/dist/agent-learning.d.ts +182 -0
  8. package/dist/agent-learning.d.ts.map +1 -0
  9. package/dist/client.d.ts +767 -80
  10. package/dist/client.d.ts.map +1 -1
  11. package/dist/docs/SKILL.md +52 -0
  12. package/dist/docs/assets/SOURCE_MAP.json +6 -0
  13. package/dist/docs/references/docs-agents-a2a.md +340 -0
  14. package/dist/docs/references/docs-editor-overview.md +349 -0
  15. package/dist/docs/references/docs-long-running-agents-schedules.md +201 -0
  16. package/dist/docs/references/docs-long-running-agents-signals.md +426 -0
  17. package/dist/docs/references/docs-server-auth-auth0.md +262 -0
  18. package/dist/docs/references/docs-server-auth-clerk.md +154 -0
  19. package/dist/docs/references/docs-server-auth-firebase.md +294 -0
  20. package/dist/docs/references/docs-server-auth-jwt.md +116 -0
  21. package/dist/docs/references/docs-server-auth-supabase.md +139 -0
  22. package/dist/docs/references/docs-server-auth-workos.md +271 -0
  23. package/dist/docs/references/docs-server-mastra-client.md +323 -0
  24. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-messages.md +97 -0
  25. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +282 -0
  26. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v4-messages.md +81 -0
  27. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v5-messages.md +78 -0
  28. package/dist/docs/references/reference-client-js-agents.md +959 -0
  29. package/dist/docs/references/reference-client-js-conversations.md +137 -0
  30. package/dist/docs/references/reference-client-js-error-handling.md +18 -0
  31. package/dist/docs/references/reference-client-js-logs.md +26 -0
  32. package/dist/docs/references/reference-client-js-mastra-client.md +96 -0
  33. package/dist/docs/references/reference-client-js-memory.md +237 -0
  34. package/dist/docs/references/reference-client-js-observability.md +183 -0
  35. package/dist/docs/references/reference-client-js-responses.md +219 -0
  36. package/dist/docs/references/reference-client-js-telemetry.md +22 -0
  37. package/dist/docs/references/reference-client-js-tools.md +46 -0
  38. package/dist/docs/references/reference-client-js-vectors.md +81 -0
  39. package/dist/docs/references/reference-client-js-workflows.md +393 -0
  40. package/dist/docs/references/reference-editor-versioning.md +130 -0
  41. package/dist/index.cjs +7638 -3257
  42. package/dist/index.cjs.map +1 -1
  43. package/dist/index.d.ts +9 -0
  44. package/dist/index.d.ts.map +1 -1
  45. package/dist/index.js +7606 -3252
  46. package/dist/index.js.map +1 -1
  47. package/dist/observability/collector.d.ts +45 -0
  48. package/dist/observability/collector.d.ts.map +1 -0
  49. package/dist/observability/index.d.ts +14 -0
  50. package/dist/observability/index.d.ts.map +1 -0
  51. package/dist/observability/types.d.ts +27 -0
  52. package/dist/observability/types.d.ts.map +1 -0
  53. package/dist/resources/a2a.d.ts +80 -11
  54. package/dist/resources/a2a.d.ts.map +1 -1
  55. package/dist/resources/agent-builder.d.ts +57 -72
  56. package/dist/resources/agent-builder.d.ts.map +1 -1
  57. package/dist/resources/agent-controller.d.ts +589 -0
  58. package/dist/resources/agent-controller.d.ts.map +1 -0
  59. package/dist/resources/agent.d.ts +368 -59
  60. package/dist/resources/agent.d.ts.map +1 -1
  61. package/dist/resources/base.d.ts +2 -1
  62. package/dist/resources/base.d.ts.map +1 -1
  63. package/dist/resources/channels.d.ts +63 -0
  64. package/dist/resources/channels.d.ts.map +1 -0
  65. package/dist/resources/conversations.d.ts +15 -0
  66. package/dist/resources/conversations.d.ts.map +1 -0
  67. package/dist/resources/index.d.ts +14 -0
  68. package/dist/resources/index.d.ts.map +1 -1
  69. package/dist/resources/mcp-tool.d.ts +5 -5
  70. package/dist/resources/mcp-tool.d.ts.map +1 -1
  71. package/dist/resources/memory-thread.d.ts +51 -16
  72. package/dist/resources/memory-thread.d.ts.map +1 -1
  73. package/dist/resources/observability.d.ts +222 -19
  74. package/dist/resources/observability.d.ts.map +1 -1
  75. package/dist/resources/processor-provider.d.ts +15 -0
  76. package/dist/resources/processor-provider.d.ts.map +1 -0
  77. package/dist/resources/processor.d.ts +20 -0
  78. package/dist/resources/processor.d.ts.map +1 -0
  79. package/dist/resources/responses.d.ts +22 -0
  80. package/dist/resources/responses.d.ts.map +1 -0
  81. package/dist/resources/run.d.ts +256 -0
  82. package/dist/resources/run.d.ts.map +1 -0
  83. package/dist/resources/stored-agent.d.ts +112 -0
  84. package/dist/resources/stored-agent.d.ts.map +1 -0
  85. package/dist/resources/stored-mcp-client.d.ts +30 -0
  86. package/dist/resources/stored-mcp-client.d.ts.map +1 -0
  87. package/dist/resources/stored-prompt-block.d.ts +83 -0
  88. package/dist/resources/stored-prompt-block.d.ts.map +1 -0
  89. package/dist/resources/stored-scorer.d.ts +83 -0
  90. package/dist/resources/stored-scorer.d.ts.map +1 -0
  91. package/dist/resources/stored-skill.d.ts +40 -0
  92. package/dist/resources/stored-skill.d.ts.map +1 -0
  93. package/dist/resources/stored-workflow.d.ts +18 -0
  94. package/dist/resources/stored-workflow.d.ts.map +1 -0
  95. package/dist/resources/tool-provider.d.ts +80 -0
  96. package/dist/resources/tool-provider.d.ts.map +1 -0
  97. package/dist/resources/tool.d.ts +4 -4
  98. package/dist/resources/vector.d.ts +9 -9
  99. package/dist/resources/vector.d.ts.map +1 -1
  100. package/dist/resources/workflow.d.ts +32 -231
  101. package/dist/resources/workflow.d.ts.map +1 -1
  102. package/dist/resources/workspace.d.ts +129 -0
  103. package/dist/resources/workspace.d.ts.map +1 -0
  104. package/dist/route-types.generated.d.ts +18087 -0
  105. package/dist/route-types.generated.d.ts.map +1 -0
  106. package/dist/tools.d.ts +3 -6
  107. package/dist/tools.d.ts.map +1 -1
  108. package/dist/types.d.ts +2740 -197
  109. package/dist/types.d.ts.map +1 -1
  110. package/dist/utils/client-tool-model-output.d.ts +16 -0
  111. package/dist/utils/client-tool-model-output.d.ts.map +1 -0
  112. package/dist/utils/index.d.ts +65 -4
  113. package/dist/utils/index.d.ts.map +1 -1
  114. package/dist/utils/process-a2a-stream.d.ts +4 -0
  115. package/dist/utils/process-a2a-stream.d.ts.map +1 -0
  116. package/dist/utils/process-client-tools.d.ts.map +1 -1
  117. package/dist/utils/process-mastra-stream.d.ts +8 -7
  118. package/dist/utils/process-mastra-stream.d.ts.map +1 -1
  119. package/dist/utils/stream-transforms.d.ts +9 -0
  120. package/dist/utils/stream-transforms.d.ts.map +1 -0
  121. package/dist/utils/verify-agent-card-signature.d.ts +21 -0
  122. package/dist/utils/verify-agent-card-signature.d.ts.map +1 -0
  123. package/dist/utils/zod-to-json-schema.d.ts +11 -2
  124. package/dist/utils/zod-to-json-schema.d.ts.map +1 -1
  125. package/package.json +26 -19
  126. package/dist/resources/network-memory-thread.d.ts +0 -47
  127. package/dist/resources/network-memory-thread.d.ts.map +0 -1
@@ -0,0 +1,282 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
3
+ # toAISdkStream()
4
+
5
+ Converts Mastra streams (agent, network, or workflow) to AI SDK-compatible streams. Use this function when you need to manually transform Mastra streams for use with AI SDK's `createUIMessageStream()` and `createUIMessageStreamResponse()`.
6
+
7
+ This is useful when building custom streaming endpoints outside Mastra's provided route helpers such as [`chatRoute()`](https://mastra.ai/reference/ai-sdk/chat-route) or [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route).
8
+
9
+ `toAISdkStream()` keeps the existing AI SDK v5/default behavior. If your app is typed against AI SDK v6, pass `version: 'v6'` in the options object.
10
+
11
+ ## Structured output in UI streams
12
+
13
+ When the source agent stream includes a final structured output object, `toAISdkStream()` emits it as a custom AI SDK UI data part:
14
+
15
+ ```json
16
+ {
17
+ "type": "data-structured-output",
18
+ "data": {
19
+ "object": {}
20
+ }
21
+ }
22
+ ```
23
+
24
+ The `object` field contains your full structured output value. This maps Mastra's final structured output chunk into the AI SDK UI stream. Partial structured output chunks aren't emitted.
25
+
26
+ ## Usage example
27
+
28
+ Next.js App Router example:
29
+
30
+ ```typescript
31
+ import { mastra } from '../../mastra'
32
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
33
+ import { toAISdkStream } from '@mastra/ai-sdk'
34
+
35
+ export async function POST(req: Request) {
36
+ const { messages } = await req.json()
37
+ const myAgent = mastra.getAgent('weatherAgent')
38
+ const stream = await myAgent.stream(messages)
39
+
40
+ const uiMessageStream = createUIMessageStream({
41
+ originalMessages: messages,
42
+ execute: async ({ writer }) => {
43
+ for await (const part of toAISdkStream(stream, { from: 'agent' })) {
44
+ await writer.write(part)
45
+ }
46
+ },
47
+ })
48
+
49
+ return createUIMessageStreamResponse({
50
+ stream: uiMessageStream,
51
+ })
52
+ }
53
+ ```
54
+
55
+ > **Tip:** Pass `messages` to `originalMessages` in `createUIMessageStream()` to avoid duplicated assistant messages in the UI. See [Troubleshooting: Repeated Assistant Messages](https://ai-sdk.dev/docs/troubleshooting/repeated-assistant-messages) for details.
56
+
57
+ ## Parameters
58
+
59
+ The first parameter is the Mastra stream to convert. It can be one of:
60
+
61
+ - `MastraModelOutput` - An agent stream from `agent.stream()`
62
+ - `MastraAgentNetworkStream` - A network stream from `agent.network()`
63
+ - `MastraWorkflowStream` or `WorkflowRunOutput` - A workflow stream
64
+
65
+ The second parameter is an options object:
66
+
67
+ **version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
68
+
69
+ **from** (`'agent' | 'network' | 'workflow'`): The type of Mastra stream being converted. (Default: `'agent'`)
70
+
71
+ **lastMessageId** (`string`): (Agent only) The ID of the last message in the conversation.
72
+
73
+ **sendStart** (`boolean`): (Agent only) Whether to send start events in the stream. (Default: `true`)
74
+
75
+ **sendFinish** (`boolean`): (Agent only) Whether to send finish events in the stream. (Default: `true`)
76
+
77
+ **sendReasoning** (`boolean`): (Agent only) Whether to include reasoning-delta chunks in the stream. Set to true to stream reasoning content from models that support extended thinking. (Default: `false`)
78
+
79
+ **sendSources** (`boolean`): (Agent only) Whether to include source citations in the output. (Default: `false`)
80
+
81
+ **includeTextStreamParts** (`boolean`): (Workflow only) Whether to include text stream parts in the output. (Default: `true`)
82
+
83
+ **messageMetadata** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): (Agent only) A function that receives the current stream part and returns metadata to attach to start and finish chunks.
84
+
85
+ **onError** (`(error: unknown) => string`): (Agent only) A function to handle errors during stream conversion. Receives the error and should return a string representation.
86
+
87
+ ## Examples
88
+
89
+ ### Converting a workflow stream
90
+
91
+ ```typescript
92
+ import { mastra } from '../../mastra'
93
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
94
+ import { toAISdkStream } from '@mastra/ai-sdk'
95
+
96
+ export async function POST(req: Request) {
97
+ const { input } = await req.json()
98
+ const workflow = mastra.getWorkflow('myWorkflow')
99
+ const run = workflow.createRun()
100
+ const stream = await run.stream({ inputData: input })
101
+
102
+ const uiMessageStream = createUIMessageStream({
103
+ execute: async ({ writer }) => {
104
+ for await (const part of toAISdkStream(stream, { from: 'workflow' })) {
105
+ await writer.write(part)
106
+ }
107
+ },
108
+ })
109
+
110
+ return createUIMessageStreamResponse({
111
+ stream: uiMessageStream,
112
+ })
113
+ }
114
+ ```
115
+
116
+ ### Converting a network stream
117
+
118
+ ```typescript
119
+ import { mastra } from '../../mastra'
120
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
121
+ import { toAISdkStream } from '@mastra/ai-sdk'
122
+
123
+ export async function POST(req: Request) {
124
+ const { messages } = await req.json()
125
+ const routingAgent = mastra.getAgent('routingAgent')
126
+ const stream = await routingAgent.network(messages)
127
+
128
+ const uiMessageStream = createUIMessageStream({
129
+ execute: async ({ writer }) => {
130
+ for await (const part of toAISdkStream(stream, { from: 'network' })) {
131
+ await writer.write(part)
132
+ }
133
+ },
134
+ })
135
+
136
+ return createUIMessageStreamResponse({
137
+ stream: uiMessageStream,
138
+ })
139
+ }
140
+ ```
141
+
142
+ ### Converting an agent stream with reasoning enabled
143
+
144
+ ```typescript
145
+ import { mastra } from '../../mastra'
146
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
147
+ import { toAISdkStream } from '@mastra/ai-sdk'
148
+
149
+ export async function POST(req: Request) {
150
+ const { messages } = await req.json()
151
+ const reasoningAgent = mastra.getAgent('reasoningAgent')
152
+ const stream = await reasoningAgent.stream(messages, {
153
+ providerOptions: {
154
+ openai: { reasoningEffort: 'high' },
155
+ },
156
+ })
157
+
158
+ const uiMessageStream = createUIMessageStream({
159
+ originalMessages: messages,
160
+ execute: async ({ writer }) => {
161
+ for await (const part of toAISdkStream(stream, {
162
+ from: 'agent',
163
+ sendReasoning: true,
164
+ })) {
165
+ await writer.write(part)
166
+ }
167
+ },
168
+ })
169
+
170
+ return createUIMessageStreamResponse({
171
+ stream: uiMessageStream,
172
+ })
173
+ }
174
+ ```
175
+
176
+ ### Converting an agent stream for AI SDK v6
177
+
178
+ ```typescript
179
+ import { mastra } from '../../mastra'
180
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
181
+ import { toAISdkStream } from '@mastra/ai-sdk'
182
+
183
+ export async function POST(req: Request) {
184
+ const { messages } = await req.json()
185
+ const myAgent = mastra.getAgent('weatherAgent')
186
+ const stream = await myAgent.stream(messages)
187
+
188
+ const uiMessageStream = createUIMessageStream({
189
+ originalMessages: messages,
190
+ execute: async ({ writer }) => {
191
+ for await (const part of toAISdkStream(stream, {
192
+ from: 'agent',
193
+ version: 'v6',
194
+ })) {
195
+ await writer.write(part)
196
+ }
197
+ },
198
+ })
199
+
200
+ return createUIMessageStreamResponse({
201
+ stream: uiMessageStream,
202
+ })
203
+ }
204
+ ```
205
+
206
+ ### Using `messageMetadata`
207
+
208
+ ```typescript
209
+ import { mastra } from '../../mastra'
210
+ import { createUIMessageStream, createUIMessageStreamResponse } from 'ai'
211
+ import { toAISdkStream } from '@mastra/ai-sdk'
212
+
213
+ export async function POST(req: Request) {
214
+ const { messages } = await req.json()
215
+ const myAgent = mastra.getAgent('weatherAgent')
216
+ const stream = await myAgent.stream(messages)
217
+
218
+ const uiMessageStream = createUIMessageStream({
219
+ originalMessages: messages,
220
+ execute: async ({ writer }) => {
221
+ for await (const part of toAISdkStream(stream, {
222
+ from: 'agent',
223
+ messageMetadata: ({ part }) => ({
224
+ timestamp: Date.now(),
225
+ partType: part.type,
226
+ }),
227
+ })) {
228
+ await writer.write(part)
229
+ }
230
+ },
231
+ })
232
+
233
+ return createUIMessageStreamResponse({
234
+ stream: uiMessageStream,
235
+ })
236
+ }
237
+ ```
238
+
239
+ ### Client-side stream transformation
240
+
241
+ If you're using the Mastra client SDK (`@mastra/client-js`) on the client side and want to convert streams to AI SDK format:
242
+
243
+ ```typescript
244
+ import { MastraClient } from '@mastra/client-js'
245
+ import { createUIMessageStream } from 'ai'
246
+ import { toAISdkStream } from '@mastra/ai-sdk'
247
+ import type { ChunkType, MastraModelOutput } from '@mastra/core/stream'
248
+
249
+ const client = new MastraClient({
250
+ baseUrl: 'http://localhost:4111',
251
+ })
252
+
253
+ const agent = client.getAgent('weatherAgent')
254
+ const response = await agent.stream('What is the weather in Tokyo?')
255
+
256
+ // Convert the client SDK stream to a ReadableStream<ChunkType>
257
+ const chunkStream = new ReadableStream<ChunkType>({
258
+ async start(controller) {
259
+ await response.processDataStream({
260
+ onChunk: async chunk => {
261
+ controller.enqueue(chunk)
262
+ },
263
+ })
264
+ controller.close()
265
+ },
266
+ })
267
+
268
+ // Transform to AI SDK format
269
+ const uiMessageStream = createUIMessageStream({
270
+ execute: async ({ writer }) => {
271
+ for await (const part of toAISdkStream(chunkStream as unknown as MastraModelOutput, {
272
+ from: 'agent',
273
+ })) {
274
+ await writer.write(part)
275
+ }
276
+ },
277
+ })
278
+
279
+ for await (const part of uiMessageStream) {
280
+ console.log(part)
281
+ }
282
+ ```
@@ -0,0 +1,81 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
3
+ # toAISdkV4Messages()
4
+
5
+ Converts messages from input formats to AI SDK V4 UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V4 `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
6
+
7
+ ## Usage example
8
+
9
+ ```typescript
10
+ import { toAISdkV4Messages } from '@mastra/ai-sdk'
11
+ import { useChat } from 'ai/react' // AI SDK V4
12
+
13
+ // Stored messages from your database, memory or API
14
+ const storedMessages = [
15
+ { id: '1', role: 'user', parts: [{ type: 'text', text: 'Hello' }] },
16
+ { id: '2', role: 'assistant', parts: [{ type: 'text', text: 'Hi there!' }] },
17
+ ]
18
+
19
+ export default function Chat() {
20
+ const { messages } = useChat({
21
+ initialMessages: toAISdkV4Messages(storedMessages),
22
+ })
23
+
24
+ return (
25
+ <div>
26
+ {messages.map(message => (
27
+ <div key={message.id}>
28
+ {message.role}: {message.content}
29
+ </div>
30
+ ))}
31
+ </div>
32
+ )
33
+ }
34
+ ```
35
+
36
+ ## Parameters
37
+
38
+ **messages** (`MessageListInput`): Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.
39
+
40
+ ## Returns
41
+
42
+ Returns an array of AI SDK V4 `UIMessage` objects with the following structure:
43
+
44
+ **id** (`string`): Unique message identifier.
45
+
46
+ **role** (`'user' | 'assistant' | 'system'`): The role of the message sender.
47
+
48
+ **content** (`string`): Text content of the message.
49
+
50
+ **parts** (`UIMessagePart[]`): Array of UI parts including text, tool-invocation, file, reasoning, source, and step markers.
51
+
52
+ **createdAt** (`Date`): Message creation timestamp.
53
+
54
+ **toolInvocations** (`ToolInvocation[]`): Array of tool invocations for assistant messages.
55
+
56
+ **experimental\_attachments** (`Attachment[]`): File attachments on the message.
57
+
58
+ **metadata** (`Record<string, unknown>`): Custom metadata attached to the message.
59
+
60
+ ## Examples
61
+
62
+ ### Converting text messages
63
+
64
+ ```typescript
65
+ import { toAISdkV4Messages } from '@mastra/ai-sdk'
66
+
67
+ const messages = toAISdkV4Messages(['Hello', 'How can I help you today?'])
68
+ // Returns array of UIMessage objects with user role and content string
69
+ ```
70
+
71
+ ### Loading messages with Mastra client
72
+
73
+ ```typescript
74
+ import { MastraClient } from '@mastra/client-js'
75
+ import { toAISdkV4Messages } from '@mastra/ai-sdk'
76
+
77
+ const client = new MastraClient()
78
+
79
+ const { messages } = await client.listThreadMessages('thread-id', { agentId: 'myAgent' })
80
+ const uiMessages = toAISdkV4Messages(messages)
81
+ ```
@@ -0,0 +1,78 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
3
+ # toAISdkV5Messages()
4
+
5
+ Converts messages from input formats to AI SDK V5 (and later) UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V5+ `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
6
+
7
+ ## Usage example
8
+
9
+ ```typescript
10
+ import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'
11
+ import { useChat } from 'ai/react'
12
+
13
+ // Stored messages from your database, memory or API
14
+ const storedMessages = [
15
+ { id: '1', role: 'user', content: 'Hello', parts: [{ type: 'text', text: 'Hello' }] },
16
+ {
17
+ id: '2',
18
+ role: 'assistant',
19
+ content: 'Hi there!',
20
+ parts: [{ type: 'text', text: 'Hi there!' }],
21
+ },
22
+ ]
23
+
24
+ export default function Chat() {
25
+ const { messages } = useChat({
26
+ initialMessages: toAISdkV5Messages(storedMessages),
27
+ })
28
+
29
+ return (
30
+ <div>
31
+ {messages.map(message => (
32
+ <div key={message.id}>
33
+ {message.role}: {message.parts.map(part => (part.type === 'text' ? part.text : null))}
34
+ </div>
35
+ ))}
36
+ </div>
37
+ )
38
+ }
39
+ ```
40
+
41
+ ## Parameters
42
+
43
+ **messages** (`MessageListInput`): Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.
44
+
45
+ ## Returns
46
+
47
+ Returns an array of AI SDK V5+ `UIMessage` objects with the following structure:
48
+
49
+ **id** (`string`): Unique message identifier.
50
+
51
+ **role** (`'user' | 'assistant' | 'system'`): The role of the message sender.
52
+
53
+ **parts** (`UIMessagePart[]`): Array of UI parts including text, tool results, files, reasoning, sources, and step markers.
54
+
55
+ **metadata** (`Record<string, unknown>`): Optional metadata including createdAt, threadId, resourceId, and custom fields.
56
+
57
+ ## Examples
58
+
59
+ ### Converting text messages
60
+
61
+ ```typescript
62
+ import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'
63
+
64
+ const messages = toAISdkV5Messages(['Hello', 'How can I help you today?'])
65
+ // Returns array of UIMessage objects with user role
66
+ ```
67
+
68
+ ### Loading messages with Mastra client
69
+
70
+ ```typescript
71
+ import { MastraClient } from '@mastra/client-js'
72
+ import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'
73
+
74
+ const client = new MastraClient()
75
+
76
+ const { messages } = await client.listThreadMessages('thread-id', { agentId: 'myAgent' })
77
+ const uiMessages = toAISdkV5Messages(messages)
78
+ ```