@mastra/client-js 0.0.0-message-ordering-20250415215612 → 0.0.0-pass-headers-for-create-mastra-client-20250529190531

package/dist/index.d.cts

@@ -1,8 +1,16 @@
-import { CoreMessage, AiMessageType, StorageThreadType, MessageType, StepAction, StepGraph, WorkflowRunResult as WorkflowRunResult$1, QueryResult, BaseLogMessage, GenerateReturn } from '@mastra/core';
+import { AbstractAgent } from '@ag-ui/client';
+import { ServerInfo, MCPToolType, ServerDetailInfo } from '@mastra/core/mcp';
+import { processDataStream } from '@ai-sdk/ui-utils';
+import { CoreMessage, AiMessageType, StorageThreadType, MessageType, LegacyWorkflowRuns, WorkflowRuns, QueryResult, GenerateReturn } from '@mastra/core';
 import { JSONSchema7 } from 'json-schema';
 import { ZodSchema } from 'zod';
-import { processDataStream } from '@ai-sdk/ui-utils';
 import { AgentGenerateOptions, AgentStreamOptions } from '@mastra/core/agent';
+import { BaseLogMessage } from '@mastra/core/logger';
+import { RuntimeContext } from '@mastra/core/runtime-context';
+import { Workflow as Workflow$1, WorkflowResult, WatchEvent } from '@mastra/core/workflows';
+import { StepAction, StepGraph, LegacyWorkflowRunResult as LegacyWorkflowRunResult$1 } from '@mastra/core/workflows/legacy';
+import * as stream_web from 'stream/web';
+import { AgentCard, TaskSendParams, Task, TaskQueryParams, TaskIdParams } from '@mastra/core/a2a';
 
 interface ClientOptions {
     /** Base URL for API requests */
@@ -23,21 +31,38 @@ interface RequestOptions {
     stream?: boolean;
     signal?: AbortSignal;
 }
+type WithoutMethods<T> = {
+    [K in keyof T as T[K] extends (...args: any[]) => any ? never : T[K] extends {
+        (): any;
+    } ? never : T[K] extends undefined | ((...args: any[]) => any) ? never : K]: T[K];
+};
 interface GetAgentResponse {
     name: string;
     instructions: string;
     tools: Record<string, GetToolResponse>;
+    workflows: Record<string, GetWorkflowResponse>;
     provider: string;
     modelId: string;
+    defaultGenerateOptions: WithoutMethods<AgentGenerateOptions>;
+    defaultStreamOptions: WithoutMethods<AgentStreamOptions>;
 }
 type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
     messages: string | string[] | CoreMessage[] | AiMessageType[];
-} & Partial<AgentGenerateOptions<T>>;
+    output?: T;
+    experimental_output?: T;
+    runtimeContext?: RuntimeContext | Record<string, any>;
+} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
     messages: string | string[] | CoreMessage[] | AiMessageType[];
-} & Omit<AgentStreamOptions<T>, 'onFinish' | 'onStepFinish' | 'telemetry'>;
+    output?: T;
+    experimental_output?: T;
+    runtimeContext?: RuntimeContext | Record<string, any>;
+} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 interface GetEvalsByAgentIdResponse extends GetAgentResponse {
     evals: any[];
+    instructions: string;
+    name: string;
+    id: string;
 }
 interface GetToolResponse {
     id: string;
@@ -45,7 +70,7 @@ interface GetToolResponse {
     inputSchema: string;
     outputSchema: string;
 }
-interface GetWorkflowResponse {
+interface GetLegacyWorkflowResponse {
     name: string;
     triggerSchema: string;
     steps: Record<string, StepAction<any, any, any, any>>;
@@ -53,16 +78,46 @@ interface GetWorkflowResponse {
     stepSubscriberGraph: Record<string, StepGraph>;
     workflowId?: string;
 }
-type WorkflowRunResult = {
+interface GetWorkflowRunsParams {
+    fromDate?: Date;
+    toDate?: Date;
+    limit?: number;
+    offset?: number;
+    resourceId?: string;
+}
+type GetLegacyWorkflowRunsResponse = LegacyWorkflowRuns;
+type GetWorkflowRunsResponse = WorkflowRuns;
+type LegacyWorkflowRunResult = {
     activePaths: Record<string, {
         status: string;
         suspendPayload?: any;
         stepPath: string[];
     }>;
-    results: WorkflowRunResult$1<any, any, any>['results'];
+    results: LegacyWorkflowRunResult$1<any, any, any>['results'];
     timestamp: number;
     runId: string;
 };
+interface GetWorkflowResponse {
+    name: string;
+    description?: string;
+    steps: {
+        [key: string]: {
+            id: string;
+            description: string;
+            inputSchema: string;
+            outputSchema: string;
+            resumeSchema: string;
+            suspendSchema: string;
+        };
+    };
+    stepGraph: Workflow$1['serializedStepGraph'];
+    inputSchema: string;
+    outputSchema: string;
+}
+type WorkflowWatchResult = WatchEvent & {
+    runId: string;
+};
+type WorkflowRunResult = WorkflowResult<any, any>;
 interface UpsertVectorParams {
     indexName: string;
     vectors: number[][];
@@ -95,10 +150,10 @@ interface SaveMessageToMemoryParams {
 }
 type SaveMessageToMemoryResponse = MessageType[];
 interface CreateMemoryThreadParams {
-    title: string;
-    metadata: Record<string, any>;
-    resourceid: string;
-    threadId: string;
+    title?: string;
+    metadata?: Record<string, any>;
+    resourceId: string;
+    threadId?: string;
     agentId: string;
 }
 type CreateMemoryThreadResponse = StorageThreadType;
@@ -110,7 +165,13 @@ type GetMemoryThreadResponse = StorageThreadType[];
 interface UpdateMemoryThreadParams {
     title: string;
     metadata: Record<string, any>;
-    resourceid: string;
+    resourceId: string;
+}
+interface GetMemoryThreadMessagesParams {
+    /**
+     * Limit the number of messages to retrieve (default: 40)
+     */
+    limit?: number;
 }
 interface GetMemoryThreadMessagesResponse {
     messages: CoreMessage[];
@@ -171,6 +232,8 @@ interface GetTelemetryParams {
     page?: number;
     perPage?: number;
     attribute?: Record<string, string>;
+    fromDate?: Date;
+    toDate?: Date;
 }
 interface GetNetworkResponse {
     name: string;
@@ -186,6 +249,21 @@ interface GetNetworkResponse {
     };
     state?: Record<string, any>;
 }
+interface McpServerListResponse {
+    servers: ServerInfo[];
+    next: string | null;
+    total_count: number;
+}
+interface McpToolInfo {
+    id: string;
+    name: string;
+    description?: string;
+    inputSchema: string;
+    toolType?: MCPToolType;
+}
+interface McpServerToolListResponse {
+    tools: McpToolInfo[];
+}
 
 declare class BaseResource {
     readonly options: ClientOptions;
@@ -218,7 +296,9 @@ declare class AgentVoice extends BaseResource {
      * @param options - Optional provider-specific options
      * @returns Promise containing the transcribed text
      */
-    listen(audio: Blob, options?: Record<string, any>): Promise<Response>;
+    listen(audio: Blob, options?: Record<string, any>): Promise<{
+        text: string;
+    }>;
     /**
      * Get available speakers for the agent's voice provider
      * @returns Promise containing list of available speakers
@@ -257,6 +337,16 @@ declare class Agent extends BaseResource {
      * @returns Promise containing tool details
      */
     getTool(toolId: string): Promise<GetToolResponse>;
+    /**
+     * Executes a tool for the agent
+     * @param toolId - ID of the tool to execute
+     * @param params - Parameters required for tool execution
+     * @returns Promise containing the tool execution results
+     */
+    executeTool(toolId: string, params: {
+        data: any;
+        runtimeContext?: RuntimeContext;
+    }): Promise<any>;
     /**
      * Retrieves evaluation results for the agent
      * @returns Promise containing agent evaluations
@@ -317,9 +407,10 @@ declare class MemoryThread extends BaseResource {
     }>;
     /**
      * Retrieves messages associated with the thread
+     * @param params - Optional parameters including limit for number of messages to retrieve
      * @returns Promise containing thread messages and UI messages
      */
-    getMessages(): Promise<GetMemoryThreadMessagesResponse>;
+    getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
 }
 
 declare class Vector extends BaseResource {
@@ -368,23 +459,22 @@ declare class Vector extends BaseResource {
     query(params: QueryVectorParams): Promise<QueryVectorResponse>;
 }
 
-declare class Workflow extends BaseResource {
+declare class LegacyWorkflow extends BaseResource {
     private workflowId;
     constructor(options: ClientOptions, workflowId: string);
     /**
-     * Retrieves details about the workflow
-     * @returns Promise containing workflow details including steps and graphs
+     * Retrieves details about the legacy workflow
+     * @returns Promise containing legacy workflow details including steps and graphs
      */
-    details(): Promise<GetWorkflowResponse>;
+    details(): Promise<GetLegacyWorkflowResponse>;
     /**
-     * @deprecated Use `startAsync` instead
-     * Executes the workflow with the provided parameters
-     * @param params - Parameters required for workflow execution
-     * @returns Promise containing the workflow execution results
+     * Retrieves all runs for a legacy workflow
+     * @param params - Parameters for filtering runs
+     * @returns Promise containing legacy workflow runs array
      */
-    execute(params: Record<string, any>): Promise<WorkflowRunResult>;
+    runs(params?: GetWorkflowRunsParams): Promise<GetLegacyWorkflowRunsResponse>;
     /**
-     * Creates a new workflow run
+     * Creates a new legacy workflow run
      * @returns Promise containing the generated run ID
      */
     createRun(params?: {
@@ -393,7 +483,7 @@ declare class Workflow extends BaseResource {
         runId: string;
     }>;
     /**
-     * Starts a workflow run synchronously without waiting for the workflow to complete
+     * Starts a legacy workflow run synchronously without waiting for the workflow to complete
      * @param params - Object containing the runId and triggerData
      * @returns Promise containing success message
      */
@@ -404,11 +494,11 @@ declare class Workflow extends BaseResource {
         message: string;
     }>;
     /**
-     * Resumes a suspended workflow step synchronously without waiting for the workflow to complete
+     * Resumes a suspended legacy workflow step synchronously without waiting for the workflow to complete
      * @param stepId - ID of the step to resume
-     * @param runId - ID of the workflow run
-     * @param context - Context to resume the workflow with
-     * @returns Promise containing the workflow resume results
+     * @param runId - ID of the legacy workflow run
+     * @param context - Context to resume the legacy workflow with
+     * @returns Promise containing the legacy workflow resume results
      */
     resume({ stepId, runId, context, }: {
         stepId: string;
@@ -425,9 +515,9 @@ declare class Workflow extends BaseResource {
     startAsync(params: {
         runId?: string;
         triggerData: Record<string, any>;
-    }): Promise<WorkflowRunResult>;
+    }): Promise<LegacyWorkflowRunResult>;
     /**
-     * Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
+     * Resumes a suspended legacy workflow step asynchronously and returns a promise that resolves when the workflow is complete
      * @param params - Object containing the runId, stepId, and context
      * @returns Promise containing the workflow resume results
      */
@@ -435,7 +525,7 @@ declare class Workflow extends BaseResource {
         runId: string;
         stepId: string;
         context: Record<string, any>;
-    }): Promise<WorkflowRunResult>;
+    }): Promise<LegacyWorkflowRunResult>;
     /**
      * Creates an async generator that processes a readable stream and yields records
      * separated by the Record Separator character (\x1E)
@@ -445,13 +535,13 @@ declare class Workflow extends BaseResource {
      */
     private streamProcessor;
     /**
-     * Watches workflow transitions in real-time
+     * Watches legacy workflow transitions in real-time
      * @param runId - Optional run ID to filter the watch stream
-     * @returns AsyncGenerator that yields parsed records from the workflow watch stream
+     * @returns AsyncGenerator that yields parsed records from the legacy workflow watch stream
      */
     watch({ runId }: {
         runId?: string;
-    }, onRecord: (record: WorkflowRunResult) => void): Promise<void>;
+    }, onRecord: (record: LegacyWorkflowRunResult) => void): Promise<void>;
 }
 
 declare class Tool extends BaseResource {
@@ -469,6 +559,179 @@ declare class Tool extends BaseResource {
      */
     execute(params: {
         data: any;
+        runId?: string;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<any>;
+}
+
+declare class Workflow extends BaseResource {
+    private workflowId;
+    constructor(options: ClientOptions, workflowId: string);
+    /**
+     * Creates an async generator that processes a readable stream and yields workflow records
+     * separated by the Record Separator character (\x1E)
+     *
+     * @param stream - The readable stream to process
+     * @returns An async generator that yields parsed records
+     */
+    private streamProcessor;
+    /**
+     * Retrieves details about the workflow
+     * @returns Promise containing workflow details including steps and graphs
+     */
+    details(): Promise<GetWorkflowResponse>;
+    /**
+     * Retrieves all runs for a workflow
+     * @param params - Parameters for filtering runs
+     * @returns Promise containing workflow runs array
+     */
+    runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse>;
+    /**
+     * Creates a new workflow run
+     * @param params - Optional object containing the optional runId
+     * @returns Promise containing the runId of the created run
+     */
+    createRun(params?: {
+        runId?: string;
+    }): Promise<{
+        runId: string;
+    }>;
+    /**
+     * Starts a workflow run synchronously without waiting for the workflow to complete
+     * @param params - Object containing the runId, inputData and runtimeContext
+     * @returns Promise containing success message
+     */
+    start(params: {
+        runId: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Resumes a suspended workflow step synchronously without waiting for the workflow to complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing success message
+     */
+    resume({ step, runId, resumeData, ...rest }: {
+        step: string | string[];
+        runId: string;
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the workflow execution results
+     */
+    startAsync(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<WorkflowRunResult>;
+    /**
+     * Starts a vNext workflow run and returns a stream
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the vNext workflow execution results
+     */
+    stream(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<stream_web.ReadableStream<WorkflowWatchResult>>;
+    /**
+     * Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing the workflow resume results
+     */
+    resumeAsync(params: {
+        runId: string;
+        step: string | string[];
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext | Record<string, any>;
+    }): Promise<WorkflowRunResult>;
+    /**
+     * Watches workflow transitions in real-time
+     * @param runId - Optional run ID to filter the watch stream
+     * @returns AsyncGenerator that yields parsed records from the workflow watch stream
+     */
+    watch({ runId }: {
+        runId?: string;
+    }, onRecord: (record: WorkflowWatchResult) => void): Promise<void>;
+    /**
+     * Creates a new ReadableStream from an iterable or async iterable of objects,
+     * serializing each as JSON and separating them with the record separator (\x1E).
+     *
+     * @param records - An iterable or async iterable of objects to stream
+     * @returns A ReadableStream emitting the records as JSON strings separated by the record separator
+     */
+    static createRecordStream(records: Iterable<any> | AsyncIterable<any>): ReadableStream;
+}
+
+/**
+ * Class for interacting with an agent via the A2A protocol
+ */
+declare class A2A extends BaseResource {
+    private agentId;
+    constructor(options: ClientOptions, agentId: string);
+    /**
+     * Get the agent card with metadata about the agent
+     * @returns Promise containing the agent card information
+     */
+    getCard(): Promise<AgentCard>;
+    /**
+     * Send a message to the agent and get a response
+     * @param params - Parameters for the task
+     * @returns Promise containing the task response
+     */
+    sendMessage(params: TaskSendParams): Promise<{
+        task: Task;
+    }>;
+    /**
+     * Get the status and result of a task
+     * @param params - Parameters for querying the task
+     * @returns Promise containing the task response
+     */
+    getTask(params: TaskQueryParams): Promise<Task>;
+    /**
+     * Cancel a running task
+     * @param params - Parameters identifying the task to cancel
+     * @returns Promise containing the task response
+     */
+    cancelTask(params: TaskIdParams): Promise<{
+        task: Task;
+    }>;
+    /**
+     * Send a message and subscribe to streaming updates (not fully implemented)
+     * @param params - Parameters for the task
+     * @returns Promise containing the task response
+     */
+    sendAndSubscribe(params: TaskSendParams): Promise<Response>;
+}
+
+/**
+ * Represents a specific tool available on a specific MCP server.
+ * Provides methods to get details and execute the tool.
+ */
+declare class MCPTool extends BaseResource {
+    private serverId;
+    private toolId;
+    constructor(options: ClientOptions, serverId: string, toolId: string);
+    /**
+     * Retrieves details about this specific tool from the MCP server.
+     * @returns Promise containing the tool's information (name, description, schema).
+     */
+    details(): Promise<McpToolInfo>;
+    /**
+     * Executes this specific tool on the MCP server.
+     * @param params - Parameters for tool execution, including data/args and optional runtimeContext.
+     * @returns Promise containing the result of the tool execution.
+     */
+    execute(params: {
+        data?: any;
+        runtimeContext?: RuntimeContext;
     }): Promise<any>;
 }
 
@@ -479,6 +742,9 @@ declare class MastraClient extends BaseResource {
      * @returns Promise containing map of agent IDs to agent details
      */
     getAgents(): Promise<Record<string, GetAgentResponse>>;
+    getAGUI({ resourceId }: {
+        resourceId: string;
+    }): Promise<Record<string, AbstractAgent>>;
     /**
      * Gets an agent instance by ID
      * @param agentId - ID of the agent to retrieve
@@ -527,6 +793,17 @@ declare class MastraClient extends BaseResource {
      * @returns Tool instance
      */
     getTool(toolId: string): Tool;
+    /**
+     * Retrieves all available legacy workflows
+     * @returns Promise containing map of legacy workflow IDs to legacy workflow details
+     */
+    getLegacyWorkflows(): Promise<Record<string, GetLegacyWorkflowResponse>>;
+    /**
+     * Gets a legacy workflow instance by ID
+     * @param workflowId - ID of the legacy workflow to retrieve
+     * @returns Legacy Workflow instance
+     */
+    getLegacyWorkflow(workflowId: string): LegacyWorkflow;
     /**
      * Retrieves all available workflows
      * @returns Promise containing map of workflow IDs to workflow details
@@ -580,6 +857,44 @@ declare class MastraClient extends BaseResource {
      * @returns Network instance
      */
     getNetwork(networkId: string): Network;
+    /**
+     * Retrieves a list of available MCP servers.
+     * @param params - Optional parameters for pagination (limit, offset).
+     * @returns Promise containing the list of MCP servers and pagination info.
+     */
+    getMcpServers(params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<McpServerListResponse>;
+    /**
+     * Retrieves detailed information for a specific MCP server.
+     * @param serverId - The ID of the MCP server to retrieve.
+     * @param params - Optional parameters, e.g., specific version.
+     * @returns Promise containing the detailed MCP server information.
+     */
+    getMcpServerDetails(serverId: string, params?: {
+        version?: string;
+    }): Promise<ServerDetailInfo>;
+    /**
+     * Retrieves a list of tools for a specific MCP server.
+     * @param serverId - The ID of the MCP server.
+     * @returns Promise containing the list of tools.
+     */
+    getMcpServerTools(serverId: string): Promise<McpServerToolListResponse>;
+    /**
+     * Gets an MCPTool resource instance for a specific tool on an MCP server.
+     * This instance can then be used to fetch details or execute the tool.
+     * @param serverId - The ID of the MCP server.
+     * @param toolId - The ID of the tool.
+     * @returns MCPTool instance.
+     */
+    getMcpServerTool(serverId: string, toolId: string): MCPTool;
+    /**
+     * Gets an A2A client for interacting with an agent via the A2A protocol
+     * @param agentId - ID of the agent to interact with
+     * @returns A2A client instance
+     */
+    getA2A(agentId: string): A2A;
 }
 
-export { type ClientOptions, type CreateIndexParams, type CreateMemoryThreadParams, type CreateMemoryThreadResponse, type GenerateParams, type GetAgentResponse, type GetEvalsByAgentIdResponse, type GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVectorIndexResponse, type GetWorkflowResponse, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult };
+export { type ClientOptions, type CreateIndexParams, type CreateMemoryThreadParams, type CreateMemoryThreadResponse, type GenerateParams, type GetAgentResponse, type GetEvalsByAgentIdResponse, type GetLegacyWorkflowResponse, type GetLegacyWorkflowRunsResponse, type GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesParams, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowRunsParams, type GetWorkflowRunsResponse, type LegacyWorkflowRunResult, MastraClient, type McpServerListResponse, type McpServerToolListResponse, type McpToolInfo, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult, type WorkflowWatchResult };