@mastra/client-js 0.0.0-course-20250527170450 → 0.0.0-custom-instrumentation-20250708222033

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 import { AbstractAgent } from '@ag-ui/client';
-import { ServerInfo, ServerDetailInfo } from '@mastra/core/mcp';
+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 { CoreMessage, AiMessageType, StorageThreadType, MastraMessageV1, LegacyWorkflowRuns, WorkflowRuns, WorkflowRun, QueryResult, GenerateReturn } from '@mastra/core';
 import { JSONSchema7 } from 'json-schema';
 import { ZodSchema } from 'zod';
-import { BaseLogMessage } from '@mastra/core/logger';
-import { AgentGenerateOptions, AgentStreamOptions } from '@mastra/core/agent';
+import { AgentGenerateOptions, AgentStreamOptions, ToolsInput } from '@mastra/core/agent';
+import { LogLevel, BaseLogMessage } from '@mastra/core/logger';
 import { RuntimeContext } from '@mastra/core/runtime-context';
-import { Workflow as Workflow$1, WorkflowResult, WatchEvent } from '@mastra/core/workflows';
+import { Workflow as Workflow$1, WatchEvent, WorkflowResult } 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';
@@ -23,13 +23,14 @@ interface ClientOptions {
     maxBackoffMs?: number;
     /** Custom headers to include with requests */
     headers?: Record<string, string>;
+    /** Abort signal for request */
+    abortSignal?: AbortSignal;
 }
 interface RequestOptions {
     method?: string;
     headers?: Record<string, string>;
     body?: any;
     stream?: boolean;
-    signal?: AbortSignal;
 }
 type WithoutMethods<T> = {
     [K in keyof T as T[K] extends (...args: any[]) => any ? never : T[K] extends {
@@ -51,13 +52,15 @@ type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> =
     output?: T;
     experimental_output?: T;
     runtimeContext?: RuntimeContext | Record<string, any>;
-} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
+    clientTools?: ToolsInput;
+} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools' | 'abortSignal'>>;
 type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
     messages: string | string[] | CoreMessage[] | AiMessageType[];
     output?: T;
     experimental_output?: T;
     runtimeContext?: RuntimeContext | Record<string, any>;
-} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
+    clientTools?: ToolsInput;
+} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools' | 'abortSignal'>>;
 interface GetEvalsByAgentIdResponse extends GetAgentResponse {
     evals: any[];
     instructions: string;
@@ -87,6 +90,8 @@ interface GetWorkflowRunsParams {
 }
 type GetLegacyWorkflowRunsResponse = LegacyWorkflowRuns;
 type GetWorkflowRunsResponse = WorkflowRuns;
+type GetWorkflowRunByIdResponse = WorkflowRun;
+type GetWorkflowRunExecutionResultResponse = WatchEvent['payload']['workflowState'];
 type LegacyWorkflowRunResult = {
     activePaths: Record<string, {
         status: string;
@@ -110,6 +115,17 @@ interface GetWorkflowResponse {
             suspendSchema: string;
         };
     };
+    allSteps: {
+        [key: string]: {
+            id: string;
+            description: string;
+            inputSchema: string;
+            outputSchema: string;
+            resumeSchema: string;
+            suspendSchema: string;
+            isWorkflow: boolean;
+        };
+    };
     stepGraph: Workflow$1['serializedStepGraph'];
     inputSchema: string;
     outputSchema: string;
@@ -145,10 +161,14 @@ interface GetVectorIndexResponse {
     count: number;
 }
 interface SaveMessageToMemoryParams {
-    messages: MessageType[];
+    messages: MastraMessageV1[];
     agentId: string;
 }
-type SaveMessageToMemoryResponse = MessageType[];
+interface SaveNetworkMessageToMemoryParams {
+    messages: MastraMessageV1[];
+    networkId: string;
+}
+type SaveMessageToMemoryResponse = MastraMessageV1[];
 interface CreateMemoryThreadParams {
     title?: string;
     metadata?: Record<string, any>;
@@ -156,11 +176,22 @@ interface CreateMemoryThreadParams {
     threadId?: string;
     agentId: string;
 }
+interface CreateNetworkMemoryThreadParams {
+    title?: string;
+    metadata?: Record<string, any>;
+    resourceId: string;
+    threadId?: string;
+    networkId: string;
+}
 type CreateMemoryThreadResponse = StorageThreadType;
 interface GetMemoryThreadParams {
     resourceId: string;
     agentId: string;
 }
+interface GetNetworkMemoryThreadParams {
+    resourceId: string;
+    networkId: string;
+}
 type GetMemoryThreadResponse = StorageThreadType[];
 interface UpdateMemoryThreadParams {
     title: string;
@@ -179,12 +210,30 @@ interface GetMemoryThreadMessagesResponse {
 }
 interface GetLogsParams {
     transportId: string;
+    fromDate?: Date;
+    toDate?: Date;
+    logLevel?: LogLevel;
+    filters?: Record<string, string>;
+    page?: number;
+    perPage?: number;
 }
 interface GetLogParams {
     runId: string;
     transportId: string;
+    fromDate?: Date;
+    toDate?: Date;
+    logLevel?: LogLevel;
+    filters?: Record<string, string>;
+    page?: number;
+    perPage?: number;
 }
-type GetLogsResponse = BaseLogMessage[];
+type GetLogsResponse = {
+    logs: BaseLogMessage[];
+    total: number;
+    page: number;
+    perPage: number;
+    hasMore: boolean;
+};
 type RequestFunction = (path: string, options?: RequestOptions) => Promise<any>;
 type SpanStatus = {
     code: number;
@@ -236,6 +285,7 @@ interface GetTelemetryParams {
     toDate?: Date;
 }
 interface GetNetworkResponse {
+    id: string;
     name: string;
     instructions: string;
     agents: Array<{
@@ -249,6 +299,54 @@ interface GetNetworkResponse {
     };
     state?: Record<string, any>;
 }
+interface GetVNextNetworkResponse {
+    id: string;
+    name: string;
+    instructions: string;
+    agents: Array<{
+        name: string;
+        provider: string;
+        modelId: string;
+    }>;
+    routingModel: {
+        provider: string;
+        modelId: string;
+    };
+    workflows: Array<{
+        name: string;
+        description: string;
+        inputSchema: string | undefined;
+        outputSchema: string | undefined;
+    }>;
+    tools: Array<{
+        id: string;
+        description: string;
+    }>;
+}
+interface GenerateVNextNetworkResponse {
+    task: string;
+    result: string;
+    resourceId: string;
+    resourceType: 'none' | 'tool' | 'agent' | 'workflow';
+}
+interface GenerateOrStreamVNextNetworkParams {
+    message: string;
+    threadId?: string;
+    resourceId?: string;
+}
+interface LoopStreamVNextNetworkParams {
+    message: string;
+    threadId?: string;
+    resourceId?: string;
+    maxIterations?: number;
+}
+interface LoopVNextNetworkResponse {
+    status: 'success';
+    result: {
+        text: string;
+    };
+    steps: WorkflowResult<any, any>['steps'];
+}
 interface McpServerListResponse {
     servers: ServerInfo[];
     next: string | null;
@@ -259,6 +357,7 @@ interface McpToolInfo {
     name: string;
     description?: string;
     inputSchema: string;
+    toolType?: MCPToolType;
 }
 interface McpServerToolListResponse {
     tools: McpToolInfo[];
@@ -306,6 +405,13 @@ declare class AgentVoice extends BaseResource {
         voiceId: string;
         [key: string]: any;
     }>>;
+    /**
+     * Get the listener configuration for the agent's voice provider
+     * @returns Promise containing a check if the agent has listening capabilities
+     */
+    getListener(): Promise<{
+        enabled: boolean;
+    }>;
 }
 declare class Agent extends BaseResource {
     private agentId;
@@ -321,7 +427,19 @@ declare class Agent extends BaseResource {
      * @param params - Generation parameters including prompt
      * @returns Promise containing the generated response
      */
-    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T>): Promise<GenerateReturn<T>>;
+    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
+        output?: never;
+        experimental_output?: never;
+    }): Promise<GenerateReturn<T>>;
+    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
+        output: T;
+        experimental_output?: never;
+    }): Promise<GenerateReturn<T>>;
+    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
+        output?: never;
+        experimental_output: T;
+    }): Promise<GenerateReturn<T>>;
+    private processChatResponse;
     /**
      * Streams a response from the agent
      * @param params - Stream parameters including prompt
@@ -330,6 +448,10 @@ declare class Agent extends BaseResource {
     stream<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: StreamParams<T>): Promise<Response & {
         processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
     }>;
+    /**
+     * Processes the stream response and handles tool calls
+     */
+    private processStreamResponse;
     /**
      * Gets details about a specific tool available to the agent
      * @param toolId - ID of the tool to retrieve
@@ -585,6 +707,38 @@ declare class Workflow extends BaseResource {
      * @returns Promise containing workflow runs array
      */
     runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse>;
+    /**
+     * Retrieves a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to retrieve
+     * @returns Promise containing the workflow run details
+     */
+    runById(runId: string): Promise<GetWorkflowRunByIdResponse>;
+    /**
+     * Retrieves the execution result for a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to retrieve the execution result for
+     * @returns Promise containing the workflow run execution result
+     */
+    runExecutionResult(runId: string): Promise<GetWorkflowRunExecutionResultResponse>;
+    /**
+     * Cancels a specific workflow run by its ID
+     * @param runId - The ID of the workflow run to cancel
+     * @returns Promise containing a success message
+     */
+    cancelRun(runId: string): Promise<{
+        message: string;
+    }>;
+    /**
+     * Sends an event to a specific workflow run by its ID
+     * @param params - Object containing the runId, event and data
+     * @returns Promise containing a success message
+     */
+    sendRunEvent(params: {
+        runId: string;
+        event: string;
+        data: unknown;
+    }): Promise<{
+        message: string;
+    }>;
     /**
      * Creates a new workflow run
      * @param params - Optional object containing the optional runId
@@ -631,15 +785,18 @@ declare class Workflow extends BaseResource {
         runtimeContext?: RuntimeContext | Record<string, any>;
     }): Promise<WorkflowRunResult>;
     /**
-     * Starts a vNext workflow run and returns a stream
+     * Starts a workflow run and returns a stream
      * @param params - Object containing the optional runId, inputData and runtimeContext
-     * @returns Promise containing the vNext workflow execution results
+     * @returns Promise containing the workflow execution results
      */
     stream(params: {
         runId?: string;
         inputData: Record<string, any>;
         runtimeContext?: RuntimeContext;
-    }): Promise<stream_web.ReadableStream<WorkflowWatchResult>>;
+    }): Promise<stream_web.ReadableStream<{
+        type: string;
+        payload: any;
+    }>>;
     /**
      * 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
@@ -734,6 +891,73 @@ declare class MCPTool extends BaseResource {
     }): Promise<any>;
 }
 
+declare class VNextNetwork extends BaseResource {
+    private networkId;
+    constructor(options: ClientOptions, networkId: string);
+    /**
+     * Retrieves details about the network
+     * @returns Promise containing vNext network details
+     */
+    details(): Promise<GetVNextNetworkResponse>;
+    /**
+     * Generates a response from the v-next network
+     * @param params - Generation parameters including message
+     * @returns Promise containing the generated response
+     */
+    generate(params: GenerateOrStreamVNextNetworkParams): Promise<GenerateVNextNetworkResponse>;
+    /**
+     * Generates a response from the v-next network using multiple primitives
+     * @param params - Generation parameters including message
+     * @returns Promise containing the generated response
+     */
+    loop(params: {
+        message: string;
+    }): Promise<LoopVNextNetworkResponse>;
+    private streamProcessor;
+    /**
+     * Streams a response from the v-next network
+     * @param params - Stream parameters including message
+     * @returns Promise containing the results
+     */
+    stream(params: GenerateOrStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
+    /**
+     * Streams a response from the v-next network loop
+     * @param params - Stream parameters including message
+     * @returns Promise containing the results
+     */
+    loopStream(params: LoopStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
+}
+
+declare class NetworkMemoryThread extends BaseResource {
+    private threadId;
+    private networkId;
+    constructor(options: ClientOptions, threadId: string, networkId: string);
+    /**
+     * Retrieves the memory thread details
+     * @returns Promise containing thread details including title and metadata
+     */
+    get(): Promise<StorageThreadType>;
+    /**
+     * Updates the memory thread properties
+     * @param params - Update parameters including title and metadata
+     * @returns Promise containing updated thread details
+     */
+    update(params: UpdateMemoryThreadParams): Promise<StorageThreadType>;
+    /**
+     * Deletes the memory thread
+     * @returns Promise containing deletion result
+     */
+    delete(): Promise<{
+        result: string;
+    }>;
+    /**
+     * 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(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
+}
+
 declare class MastraClient extends BaseResource {
     constructor(options: ClientOptions);
     /**
@@ -781,6 +1005,37 @@ declare class MastraClient extends BaseResource {
     getMemoryStatus(agentId: string): Promise<{
         result: boolean;
     }>;
+    /**
+     * Retrieves memory threads for a resource
+     * @param params - Parameters containing the resource ID
+     * @returns Promise containing array of memory threads
+     */
+    getNetworkMemoryThreads(params: GetNetworkMemoryThreadParams): Promise<GetMemoryThreadResponse>;
+    /**
+     * Creates a new memory thread
+     * @param params - Parameters for creating the memory thread
+     * @returns Promise containing the created memory thread
+     */
+    createNetworkMemoryThread(params: CreateNetworkMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
+    /**
+     * Gets a memory thread instance by ID
+     * @param threadId - ID of the memory thread to retrieve
+     * @returns MemoryThread instance
+     */
+    getNetworkMemoryThread(threadId: string, networkId: string): NetworkMemoryThread;
+    /**
+     * Saves messages to memory
+     * @param params - Parameters containing messages to save
+     * @returns Promise containing the saved messages
+     */
+    saveNetworkMessageToMemory(params: SaveNetworkMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
+    /**
+     * Gets the status of the memory system
+     * @returns Promise containing memory system status
+     */
+    getNetworkMemoryStatus(networkId: string): Promise<{
+        result: boolean;
+    }>;
     /**
      * Retrieves all available tools
      * @returns Promise containing map of tool IDs to tool details
@@ -849,13 +1104,24 @@ declare class MastraClient extends BaseResource {
      * Retrieves all available networks
      * @returns Promise containing map of network IDs to network details
      */
-    getNetworks(): Promise<Record<string, GetNetworkResponse>>;
+    getNetworks(): Promise<Array<GetNetworkResponse>>;
+    /**
+     * Retrieves all available vNext networks
+     * @returns Promise containing map of vNext network IDs to vNext network details
+     */
+    getVNextNetworks(): Promise<Array<GetVNextNetworkResponse>>;
     /**
      * Gets a network instance by ID
      * @param networkId - ID of the network to retrieve
      * @returns Network instance
      */
     getNetwork(networkId: string): Network;
+    /**
+     * Gets a vNext network instance by ID
+     * @param networkId - ID of the vNext network to retrieve
+     * @returns vNext Network instance
+     */
+    getVNextNetwork(networkId: string): VNextNetwork;
     /**
      * Retrieves a list of available MCP servers.
      * @param params - Optional parameters for pagination (limit, offset).
@@ -896,4 +1162,4 @@ declare class MastraClient extends BaseResource {
     getA2A(agentId: string): A2A;
 }
 
-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 };
+export { type ClientOptions, type CreateIndexParams, type CreateMemoryThreadParams, type CreateMemoryThreadResponse, type CreateNetworkMemoryThreadParams, type GenerateOrStreamVNextNetworkParams, type GenerateParams, type GenerateVNextNetworkResponse, type GetAgentResponse, type GetEvalsByAgentIdResponse, type GetLegacyWorkflowResponse, type GetLegacyWorkflowRunsResponse, type GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesParams, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkMemoryThreadParams, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVNextNetworkResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowRunByIdResponse, type GetWorkflowRunExecutionResultResponse, type GetWorkflowRunsParams, type GetWorkflowRunsResponse, type LegacyWorkflowRunResult, type LoopStreamVNextNetworkParams, type LoopVNextNetworkResponse, MastraClient, type McpServerListResponse, type McpServerToolListResponse, type McpToolInfo, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type SaveNetworkMessageToMemoryParams, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult, type WorkflowWatchResult };