@mastra/client-js 1.13.1 → 1.13.2-alpha.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/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @mastra/client-js
2
2
 
3
+ ## 1.13.2-alpha.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Fixed the client JS Responses types to allow omitting the model override. ([#15140](https://github.com/mastra-ai/mastra/pull/15140))
8
+
9
+ - Updated dependencies [[`153e864`](https://github.com/mastra-ai/mastra/commit/153e86476b425db7cd0dc8490050096e92964a38)]:
10
+ - @mastra/core@1.23.1-alpha.0
11
+
3
12
  ## 1.13.1
4
13
 
5
14
  ### Patch Changes
@@ -3,7 +3,7 @@ name: mastra-client-js
3
3
  description: Documentation for @mastra/client-js. Use when working with @mastra/client-js APIs, configuration, or implementation.
4
4
  metadata:
5
5
  package: "@mastra/client-js"
6
- version: "1.13.1"
6
+ version: "1.13.2-alpha.0"
7
7
  ---
8
8
 
9
9
  ## When to use
@@ -26,6 +26,7 @@ Read the individual reference documents for detailed explanations and code examp
26
26
 
27
27
  ### Reference
28
28
 
29
+ - [Reference: toAISdkMessages()](references/reference-ai-sdk-to-ai-sdk-messages.md) - API reference for toAISdkMessages(), a function to convert Mastra messages to AI SDK UI messages for AI SDK v5 or v6.
29
30
  - [Reference: toAISdkStream()](references/reference-ai-sdk-to-ai-sdk-stream.md) - API reference for toAISdkStream(), a function to convert Mastra streams to AI SDK-compatible streams.
30
31
  - [Reference: toAISdkV4Messages()](references/reference-ai-sdk-to-ai-sdk-v4-messages.md) - API reference for toAISdkV4Messages(), a function to convert Mastra messages to AI SDK v4 UI messages.
31
32
  - [Reference: toAISdkV5Messages()](references/reference-ai-sdk-to-ai-sdk-v5-messages.md) - API reference for toAISdkV5Messages(), a function to convert Mastra messages to AI SDK v5 UI messages.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.13.1",
2
+ "version": "1.13.2-alpha.0",
3
3
  "package": "@mastra/client-js",
4
4
  "exports": {},
5
5
  "modules": {}
@@ -0,0 +1,95 @@
1
+ # toAISdkMessages()
2
+
3
+ Converts messages from various input formats to AI SDK UI message format. `toAISdkMessages()` keeps the existing AI SDK v5/default behavior. If your app is typed against AI SDK v6, pass `version: 'v6'`.
4
+
5
+ `version: 'v6'` uses the MessageList AI SDK v6 UI output path. MessageList input detection and ingestion remain unchanged.
6
+
7
+ ## Usage example
8
+
9
+ ```typescript
10
+ import { toAISdkMessages } 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: toAISdkMessages(storedMessages, { version: 'v6' }),
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
+ **options.version** (`'v5' | 'v6'`): Selects the AI SDK message type to return. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 \`useChat()\` message types.
46
+
47
+ ## Returns
48
+
49
+ Returns an array of AI SDK `UIMessage` objects typed for the selected version.
50
+
51
+ **id** (`string`): Unique message identifier.
52
+
53
+ **role** (`'user' | 'assistant' | 'system'`): The role of the message sender.
54
+
55
+ **parts** (`UIMessagePart[]`): Array of UI parts including text, tool results, files, reasoning, sources, and step markers.
56
+
57
+ **metadata** (`Record<string, unknown>`): Optional metadata including createdAt, threadId, resourceId, and custom fields.
58
+
59
+ ## Examples
60
+
61
+ ### Using the default AI SDK v5 types
62
+
63
+ ```typescript
64
+ import { toAISdkMessages } from '@mastra/ai-sdk/ui'
65
+
66
+ const messages = toAISdkMessages(['Hello', 'How can I help you today?'])
67
+ ```
68
+
69
+ ### Returning AI SDK v6 message types
70
+
71
+ ```typescript
72
+ import { toAISdkMessages } from '@mastra/ai-sdk/ui'
73
+
74
+ const messages = toAISdkMessages(['Hello', 'How can I help you today?'], {
75
+ version: 'v6',
76
+ })
77
+ ```
78
+
79
+ ### Loading messages with Mastra client
80
+
81
+ ```typescript
82
+ import { MastraClient } from '@mastra/client-js'
83
+ import { toAISdkMessages } from '@mastra/ai-sdk/ui'
84
+
85
+ const client = new MastraClient()
86
+
87
+ const { messages } = await client.listThreadMessages('thread-id', { agentId: 'myAgent' })
88
+ const uiMessages = toAISdkMessages(messages)
89
+ ```
90
+
91
+ ## Related
92
+
93
+ - [`toAISdkStream()`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-stream)
94
+ - [`toAISdkV5Messages()`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages)
95
+ - [`toAISdkV4Messages()`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v4-messages)