@mastra/client-js 0.0.0-vnextWorkflows-20250422081019 → 0.0.0-workflow-deno-20250616115451

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.
@@ -1,8 +1,9 @@
1
- import type { GenerateReturn } from '@mastra/core';
1
+ import { processDataStream } from '@ai-sdk/ui-utils';
2
+ import { type GenerateReturn } from '@mastra/core';
2
3
  import type { JSONSchema7 } from 'json-schema';
3
4
  import { ZodSchema } from 'zod';
4
- import { zodToJsonSchema } from 'zod-to-json-schema';
5
- import { processDataStream } from '@ai-sdk/ui-utils';
5
+ import { zodToJsonSchema } from '../utils/zod-to-json-schema';
6
+ import { processClientTools } from '../utils/process-client-tools';
6
7
 
7
8
  import type {
8
9
  GenerateParams,
@@ -14,29 +15,8 @@ import type {
14
15
  } from '../types';
15
16
 
16
17
  import { BaseResource } from './base';
17
-
18
- export class AgentTool extends BaseResource {
19
- constructor(
20
- options: ClientOptions,
21
- private agentId: string,
22
- private toolId: string,
23
- ) {
24
- super(options);
25
- }
26
-
27
- /**
28
- * Executes a specific tool for an agent
29
- * @param params - Parameters required for tool execution
30
- * @returns Promise containing tool execution results
31
- */
32
- /** @deprecated use CreateRun/startRun */
33
- execute(params: { data: any }): Promise<any> {
34
- return this.request(`/api/agents/${this.agentId}/tools/${this.toolId}/execute`, {
35
- method: 'POST',
36
- body: params,
37
- });
38
- }
39
- }
18
+ import type { RuntimeContext } from '@mastra/core/runtime-context';
19
+ import { parseClientRuntimeContext } from '../utils';
40
20
 
41
21
  export class AgentVoice extends BaseResource {
42
22
  constructor(
@@ -70,7 +50,7 @@ export class AgentVoice extends BaseResource {
70
50
  * @param options - Optional provider-specific options
71
51
  * @returns Promise containing the transcribed text
72
52
  */
73
- listen(audio: Blob, options?: Record<string, any>): Promise<Response> {
53
+ listen(audio: Blob, options?: Record<string, any>): Promise<{ text: string }> {
74
54
  const formData = new FormData();
75
55
  formData.append('audio', audio);
76
56
 
@@ -91,6 +71,14 @@ export class AgentVoice extends BaseResource {
91
71
  getSpeakers(): Promise<Array<{ voiceId: string; [key: string]: any }>> {
92
72
  return this.request(`/api/agents/${this.agentId}/voice/speakers`);
93
73
  }
74
+
75
+ /**
76
+ * Get the listener configuration for the agent's voice provider
77
+ * @returns Promise containing a check if the agent has listening capabilities
78
+ */
79
+ getListener(): Promise<{ enabled: boolean }> {
80
+ return this.request(`/api/agents/${this.agentId}/voice/listener`);
81
+ }
94
82
  }
95
83
 
96
84
  export class Agent extends BaseResource {
@@ -117,16 +105,24 @@ export class Agent extends BaseResource {
117
105
  * @param params - Generation parameters including prompt
118
106
  * @returns Promise containing the generated response
119
107
  */
108
+ generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
109
+ params: GenerateParams<T> & { output?: never; experimental_output?: never },
110
+ ): Promise<GenerateReturn<T>>;
111
+ generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
112
+ params: GenerateParams<T> & { output: T; experimental_output?: never },
113
+ ): Promise<GenerateReturn<T>>;
114
+ generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
115
+ params: GenerateParams<T> & { output?: never; experimental_output: T },
116
+ ): Promise<GenerateReturn<T>>;
120
117
  generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
121
118
  params: GenerateParams<T>,
122
119
  ): Promise<GenerateReturn<T>> {
123
120
  const processedParams = {
124
121
  ...params,
125
- output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
126
- experimental_output:
127
- params.experimental_output instanceof ZodSchema
128
- ? zodToJsonSchema(params.experimental_output)
129
- : params.experimental_output,
122
+ output: params.output ? zodToJsonSchema(params.output) : undefined,
123
+ experimental_output: params.experimental_output ? zodToJsonSchema(params.experimental_output) : undefined,
124
+ runtimeContext: parseClientRuntimeContext(params.runtimeContext),
125
+ clientTools: processClientTools(params.clientTools),
130
126
  };
131
127
 
132
128
  return this.request(`/api/agents/${this.agentId}/generate`, {
@@ -149,11 +145,10 @@ export class Agent extends BaseResource {
149
145
  > {
150
146
  const processedParams = {
151
147
  ...params,
152
- output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
153
- experimental_output:
154
- params.experimental_output instanceof ZodSchema
155
- ? zodToJsonSchema(params.experimental_output)
156
- : params.experimental_output,
148
+ output: params.output ? zodToJsonSchema(params.output) : undefined,
149
+ experimental_output: params.experimental_output ? zodToJsonSchema(params.experimental_output) : undefined,
150
+ runtimeContext: parseClientRuntimeContext(params.runtimeContext),
151
+ clientTools: processClientTools(params.clientTools),
157
152
  };
158
153
 
159
154
  const response: Response & {
@@ -187,6 +182,23 @@ export class Agent extends BaseResource {
187
182
  return this.request(`/api/agents/${this.agentId}/tools/${toolId}`);
188
183
  }
189
184
 
185
+ /**
186
+ * Executes a tool for the agent
187
+ * @param toolId - ID of the tool to execute
188
+ * @param params - Parameters required for tool execution
189
+ * @returns Promise containing the tool execution results
190
+ */
191
+ executeTool(toolId: string, params: { data: any; runtimeContext?: RuntimeContext }): Promise<any> {
192
+ const body = {
193
+ data: params.data,
194
+ runtimeContext: params.runtimeContext ? Object.fromEntries(params.runtimeContext.entries()) : undefined,
195
+ };
196
+ return this.request(`/api/agents/${this.agentId}/tools/${toolId}/execute`, {
197
+ method: 'POST',
198
+ body,
199
+ });
200
+ }
201
+
190
202
  /**
191
203
  * Retrieves evaluation results for the agent
192
204
  * @returns Promise containing agent evaluations
@@ -1,4 +1,4 @@
1
- import type { RequestFunction, RequestOptions, ClientOptions } from '../types';
1
+ import type { RequestOptions, ClientOptions } from '../types';
2
2
 
3
3
  export class BaseResource {
4
4
  readonly options: ClientOptions;
@@ -21,7 +21,7 @@ export class BaseResource {
21
21
 
22
22
  for (let attempt = 0; attempt <= retries; attempt++) {
23
23
  try {
24
- const response = await fetch(`${baseUrl}${path}`, {
24
+ const response = await fetch(`${baseUrl.replace(/\/$/, '')}${path}`, {
25
25
  ...options,
26
26
  headers: {
27
27
  ...headers,
@@ -2,6 +2,9 @@ export * from './agent';
2
2
  export * from './network';
3
3
  export * from './memory-thread';
4
4
  export * from './vector';
5
- export * from './workflow';
5
+ export * from './legacy-workflow';
6
6
  export * from './tool';
7
7
  export * from './base';
8
+ export * from './workflow';
9
+ export * from './a2a';
10
+ export * from './mcp-tool';
@@ -0,0 +1,242 @@
1
+ import type {
2
+ ClientOptions,
3
+ LegacyWorkflowRunResult,
4
+ GetLegacyWorkflowRunsResponse,
5
+ GetWorkflowRunsParams,
6
+ GetLegacyWorkflowResponse,
7
+ } from '../types';
8
+
9
+ import { BaseResource } from './base';
10
+
11
+ const RECORD_SEPARATOR = '\x1E';
12
+
13
+ export class LegacyWorkflow extends BaseResource {
14
+ constructor(
15
+ options: ClientOptions,
16
+ private workflowId: string,
17
+ ) {
18
+ super(options);
19
+ }
20
+
21
+ /**
22
+ * Retrieves details about the legacy workflow
23
+ * @returns Promise containing legacy workflow details including steps and graphs
24
+ */
25
+ details(): Promise<GetLegacyWorkflowResponse> {
26
+ return this.request(`/api/workflows/legacy/${this.workflowId}`);
27
+ }
28
+
29
+ /**
30
+ * Retrieves all runs for a legacy workflow
31
+ * @param params - Parameters for filtering runs
32
+ * @returns Promise containing legacy workflow runs array
33
+ */
34
+ runs(params?: GetWorkflowRunsParams): Promise<GetLegacyWorkflowRunsResponse> {
35
+ const searchParams = new URLSearchParams();
36
+ if (params?.fromDate) {
37
+ searchParams.set('fromDate', params.fromDate.toISOString());
38
+ }
39
+ if (params?.toDate) {
40
+ searchParams.set('toDate', params.toDate.toISOString());
41
+ }
42
+ if (params?.limit) {
43
+ searchParams.set('limit', String(params.limit));
44
+ }
45
+ if (params?.offset) {
46
+ searchParams.set('offset', String(params.offset));
47
+ }
48
+ if (params?.resourceId) {
49
+ searchParams.set('resourceId', params.resourceId);
50
+ }
51
+
52
+ if (searchParams.size) {
53
+ return this.request(`/api/workflows/legacy/${this.workflowId}/runs?${searchParams}`);
54
+ } else {
55
+ return this.request(`/api/workflows/legacy/${this.workflowId}/runs`);
56
+ }
57
+ }
58
+
59
+ /**
60
+ * Creates a new legacy workflow run
61
+ * @returns Promise containing the generated run ID
62
+ */
63
+ createRun(params?: { runId?: string }): Promise<{ runId: string }> {
64
+ const searchParams = new URLSearchParams();
65
+
66
+ if (!!params?.runId) {
67
+ searchParams.set('runId', params.runId);
68
+ }
69
+
70
+ return this.request(`/api/workflows/legacy/${this.workflowId}/create-run?${searchParams.toString()}`, {
71
+ method: 'POST',
72
+ });
73
+ }
74
+
75
+ /**
76
+ * Starts a legacy workflow run synchronously without waiting for the workflow to complete
77
+ * @param params - Object containing the runId and triggerData
78
+ * @returns Promise containing success message
79
+ */
80
+ start(params: { runId: string; triggerData: Record<string, any> }): Promise<{ message: string }> {
81
+ return this.request(`/api/workflows/legacy/${this.workflowId}/start?runId=${params.runId}`, {
82
+ method: 'POST',
83
+ body: params?.triggerData,
84
+ });
85
+ }
86
+
87
+ /**
88
+ * Resumes a suspended legacy workflow step synchronously without waiting for the workflow to complete
89
+ * @param stepId - ID of the step to resume
90
+ * @param runId - ID of the legacy workflow run
91
+ * @param context - Context to resume the legacy workflow with
92
+ * @returns Promise containing the legacy workflow resume results
93
+ */
94
+ resume({
95
+ stepId,
96
+ runId,
97
+ context,
98
+ }: {
99
+ stepId: string;
100
+ runId: string;
101
+ context: Record<string, any>;
102
+ }): Promise<{ message: string }> {
103
+ return this.request(`/api/workflows/legacy/${this.workflowId}/resume?runId=${runId}`, {
104
+ method: 'POST',
105
+ body: {
106
+ stepId,
107
+ context,
108
+ },
109
+ });
110
+ }
111
+
112
+ /**
113
+ * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
114
+ * @param params - Object containing the optional runId and triggerData
115
+ * @returns Promise containing the workflow execution results
116
+ */
117
+ startAsync(params: { runId?: string; triggerData: Record<string, any> }): Promise<LegacyWorkflowRunResult> {
118
+ const searchParams = new URLSearchParams();
119
+
120
+ if (!!params?.runId) {
121
+ searchParams.set('runId', params.runId);
122
+ }
123
+
124
+ return this.request(`/api/workflows/legacy/${this.workflowId}/start-async?${searchParams.toString()}`, {
125
+ method: 'POST',
126
+ body: params?.triggerData,
127
+ });
128
+ }
129
+
130
+ /**
131
+ * Resumes a suspended legacy workflow step asynchronously and returns a promise that resolves when the workflow is complete
132
+ * @param params - Object containing the runId, stepId, and context
133
+ * @returns Promise containing the workflow resume results
134
+ */
135
+ resumeAsync(params: {
136
+ runId: string;
137
+ stepId: string;
138
+ context: Record<string, any>;
139
+ }): Promise<LegacyWorkflowRunResult> {
140
+ return this.request(`/api/workflows/legacy/${this.workflowId}/resume-async?runId=${params.runId}`, {
141
+ method: 'POST',
142
+ body: {
143
+ stepId: params.stepId,
144
+ context: params.context,
145
+ },
146
+ });
147
+ }
148
+
149
+ /**
150
+ * Creates an async generator that processes a readable stream and yields records
151
+ * separated by the Record Separator character (\x1E)
152
+ *
153
+ * @param stream - The readable stream to process
154
+ * @returns An async generator that yields parsed records
155
+ */
156
+ private async *streamProcessor(stream: ReadableStream): AsyncGenerator<LegacyWorkflowRunResult, void, unknown> {
157
+ const reader = stream.getReader();
158
+
159
+ // Track if we've finished reading from the stream
160
+ let doneReading = false;
161
+ // Buffer to accumulate partial chunks
162
+ let buffer = '';
163
+
164
+ try {
165
+ while (!doneReading) {
166
+ // Read the next chunk from the stream
167
+ const { done, value } = await reader.read();
168
+ doneReading = done;
169
+
170
+ // Skip processing if we're done and there's no value
171
+ if (done && !value) continue;
172
+
173
+ try {
174
+ // Decode binary data to text
175
+ const decoded = value ? new TextDecoder().decode(value) : '';
176
+
177
+ // Split the combined buffer and new data by record separator
178
+ const chunks = (buffer + decoded).split(RECORD_SEPARATOR);
179
+
180
+ // The last chunk might be incomplete, so save it for the next iteration
181
+ buffer = chunks.pop() || '';
182
+
183
+ // Process complete chunks
184
+ for (const chunk of chunks) {
185
+ if (chunk) {
186
+ // Only process non-empty chunks
187
+ if (typeof chunk === 'string') {
188
+ try {
189
+ const parsedChunk = JSON.parse(chunk);
190
+ yield parsedChunk;
191
+ } catch {
192
+ // Silently ignore parsing errors to maintain stream processing
193
+ // This allows the stream to continue even if one record is malformed
194
+ }
195
+ }
196
+ }
197
+ }
198
+ } catch {
199
+ // Silently ignore parsing errors to maintain stream processing
200
+ // This allows the stream to continue even if one record is malformed
201
+ }
202
+ }
203
+
204
+ // Process any remaining data in the buffer after stream is done
205
+ if (buffer) {
206
+ try {
207
+ yield JSON.parse(buffer);
208
+ } catch {
209
+ // Ignore parsing error for final chunk
210
+ }
211
+ }
212
+ } finally {
213
+ // Always ensure we clean up the reader
214
+ reader.cancel().catch(() => {
215
+ // Ignore cancel errors
216
+ });
217
+ }
218
+ }
219
+
220
+ /**
221
+ * Watches legacy workflow transitions in real-time
222
+ * @param runId - Optional run ID to filter the watch stream
223
+ * @returns AsyncGenerator that yields parsed records from the legacy workflow watch stream
224
+ */
225
+ async watch({ runId }: { runId?: string }, onRecord: (record: LegacyWorkflowRunResult) => void) {
226
+ const response: Response = await this.request(`/api/workflows/legacy/${this.workflowId}/watch?runId=${runId}`, {
227
+ stream: true,
228
+ });
229
+
230
+ if (!response.ok) {
231
+ throw new Error(`Failed to watch legacy workflow: ${response.statusText}`);
232
+ }
233
+
234
+ if (!response.body) {
235
+ throw new Error('Response body is null');
236
+ }
237
+
238
+ for await (const record of this.streamProcessor(response.body)) {
239
+ onRecord(record);
240
+ }
241
+ }
242
+ }
@@ -0,0 +1,48 @@
1
+ import type { RuntimeContext } from '@mastra/core/runtime-context';
2
+ import type { ClientOptions, McpToolInfo } from '../types';
3
+ import { BaseResource } from './base';
4
+
5
+ /**
6
+ * Represents a specific tool available on a specific MCP server.
7
+ * Provides methods to get details and execute the tool.
8
+ */
9
+ export class MCPTool extends BaseResource {
10
+ private serverId: string;
11
+ private toolId: string;
12
+
13
+ constructor(options: ClientOptions, serverId: string, toolId: string) {
14
+ super(options);
15
+ this.serverId = serverId;
16
+ this.toolId = toolId;
17
+ }
18
+
19
+ /**
20
+ * Retrieves details about this specific tool from the MCP server.
21
+ * @returns Promise containing the tool's information (name, description, schema).
22
+ */
23
+ details(): Promise<McpToolInfo> {
24
+ return this.request(`/api/mcp/${this.serverId}/tools/${this.toolId}`);
25
+ }
26
+
27
+ /**
28
+ * Executes this specific tool on the MCP server.
29
+ * @param params - Parameters for tool execution, including data/args and optional runtimeContext.
30
+ * @returns Promise containing the result of the tool execution.
31
+ */
32
+ execute(params: { data?: any; runtimeContext?: RuntimeContext }): Promise<any> {
33
+ const body: any = {};
34
+ if (params.data !== undefined) body.data = params.data;
35
+ // If none of data, args the body might be empty or just contain runtimeContext.
36
+ // The handler will look for these, so an empty args object might be appropriate if that's the intent.
37
+ // else body.data = {}; // Or let it be empty if no specific input fields are used
38
+
39
+ if (params.runtimeContext !== undefined) {
40
+ body.runtimeContext = params.runtimeContext;
41
+ }
42
+
43
+ return this.request(`/api/mcp/${this.serverId}/tools/${this.toolId}/execute`, {
44
+ method: 'POST',
45
+ body: Object.keys(body).length > 0 ? body : undefined,
46
+ });
47
+ }
48
+ }
@@ -1,12 +1,10 @@
1
1
  import type { StorageThreadType } from '@mastra/core';
2
2
 
3
3
  import type {
4
- CreateMemoryThreadParams,
5
4
  GetMemoryThreadMessagesResponse,
6
- GetMemoryThreadResponse,
7
5
  ClientOptions,
8
- SaveMessageToMemoryParams,
9
6
  UpdateMemoryThreadParams,
7
+ GetMemoryThreadMessagesParams,
10
8
  } from '../types';
11
9
 
12
10
  import { BaseResource } from './base';
@@ -52,9 +50,14 @@ export class MemoryThread extends BaseResource {
52
50
 
53
51
  /**
54
52
  * Retrieves messages associated with the thread
53
+ * @param params - Optional parameters including limit for number of messages to retrieve
55
54
  * @returns Promise containing thread messages and UI messages
56
55
  */
57
- getMessages(): Promise<GetMemoryThreadMessagesResponse> {
58
- return this.request(`/api/memory/threads/${this.threadId}/messages?agentId=${this.agentId}`);
56
+ getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse> {
57
+ const query = new URLSearchParams({
58
+ agentId: this.agentId,
59
+ ...(params?.limit ? { limit: params.limit.toString() } : {}),
60
+ });
61
+ return this.request(`/api/memory/threads/${this.threadId}/messages?${query.toString()}`);
59
62
  }
60
63
  }
@@ -1,12 +1,12 @@
1
+ import { processDataStream } from '@ai-sdk/ui-utils';
1
2
  import type { GenerateReturn } from '@mastra/core';
2
3
  import type { JSONSchema7 } from 'json-schema';
3
4
  import { ZodSchema } from 'zod';
4
- import { zodToJsonSchema } from 'zod-to-json-schema';
5
+ import { zodToJsonSchema } from '../utils/zod-to-json-schema';
5
6
 
6
7
  import type { GenerateParams, ClientOptions, StreamParams, GetNetworkResponse } from '../types';
7
8
 
8
9
  import { BaseResource } from './base';
9
- import { processDataStream } from '@ai-sdk/ui-utils';
10
10
 
11
11
  export class Network extends BaseResource {
12
12
  constructor(
@@ -34,11 +34,8 @@ export class Network extends BaseResource {
34
34
  ): Promise<GenerateReturn<T>> {
35
35
  const processedParams = {
36
36
  ...params,
37
- output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
38
- experimental_output:
39
- params.experimental_output instanceof ZodSchema
40
- ? zodToJsonSchema(params.experimental_output)
41
- : params.experimental_output,
37
+ output: zodToJsonSchema(params.output),
38
+ experimental_output: zodToJsonSchema(params.experimental_output),
42
39
  };
43
40
 
44
41
  return this.request(`/api/networks/${this.networkId}/generate`, {
@@ -61,11 +58,8 @@ export class Network extends BaseResource {
61
58
  > {
62
59
  const processedParams = {
63
60
  ...params,
64
- output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
65
- experimental_output:
66
- params.experimental_output instanceof ZodSchema
67
- ? zodToJsonSchema(params.experimental_output)
68
- : params.experimental_output,
61
+ output: zodToJsonSchema(params.output),
62
+ experimental_output: zodToJsonSchema(params.experimental_output),
69
63
  };
70
64
 
71
65
  const response: Response & {
@@ -1,6 +1,8 @@
1
+ import type { RuntimeContext } from '@mastra/core/runtime-context';
1
2
  import type { GetToolResponse, ClientOptions } from '../types';
2
3
 
3
4
  import { BaseResource } from './base';
5
+ import { parseClientRuntimeContext } from '../utils';
4
6
 
5
7
  export class Tool extends BaseResource {
6
8
  constructor(
@@ -23,10 +25,21 @@ export class Tool extends BaseResource {
23
25
  * @param params - Parameters required for tool execution
24
26
  * @returns Promise containing the tool execution results
25
27
  */
26
- execute(params: { data: any }): Promise<any> {
27
- return this.request(`/api/tools/${this.toolId}/execute`, {
28
+ execute(params: { data: any; runId?: string; runtimeContext?: RuntimeContext | Record<string, any> }): Promise<any> {
29
+ const url = new URLSearchParams();
30
+
31
+ if (params.runId) {
32
+ url.set('runId', params.runId);
33
+ }
34
+
35
+ const body = {
36
+ data: params.data,
37
+ runtimeContext: parseClientRuntimeContext(params.runtimeContext),
38
+ };
39
+
40
+ return this.request(`/api/tools/${this.toolId}/execute?${url.toString()}`, {
28
41
  method: 'POST',
29
- body: params,
42
+ body,
30
43
  });
31
44
  }
32
45
  }