@mastra/client-js 0.0.0-tool-call-parts-20250630193309 → 0.0.0-transpile-packages-20250730132657

package/dist/index.d.cts

@@ -1,12 +1,14 @@
 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, MastraMessageV1, LegacyWorkflowRuns, WorkflowRuns, WorkflowRun, QueryResult, GenerateReturn } from '@mastra/core';
+import { GenerateReturn } from '@mastra/core/llm';
 import { JSONSchema7 } from 'json-schema';
 import { ZodSchema } from 'zod';
+import { CoreMessage, AiMessageType, StorageThreadType, StorageGetMessagesArg, PaginationInfo, MastraMessageV1, MastraMessageV2, LegacyWorkflowRuns, WorkflowRuns, WorkflowRun, QueryResult, GenerateReturn as GenerateReturn$1 } from '@mastra/core';
 import { AgentGenerateOptions, AgentStreamOptions, ToolsInput } from '@mastra/core/agent';
 import { LogLevel, BaseLogMessage } from '@mastra/core/logger';
 import { RuntimeContext } from '@mastra/core/runtime-context';
+import { MastraScorerEntry, ScoreRowData } from '@mastra/core/scores';
 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';
@@ -23,13 +25,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 {
@@ -52,14 +55,14 @@ type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> =
     experimental_output?: T;
     runtimeContext?: RuntimeContext | Record<string, any>;
     clientTools?: ToolsInput;
-} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools'>>;
+} & 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>;
     clientTools?: ToolsInput;
-} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools'>>;
+} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools' | 'abortSignal'>>;
 interface GetEvalsByAgentIdResponse extends GetAgentResponse {
     evals: any[];
     instructions: string;
@@ -114,6 +117,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;
@@ -192,10 +206,14 @@ interface GetMemoryThreadMessagesParams {
      */
     limit?: number;
 }
+type GetMemoryThreadMessagesPaginatedParams = Omit<StorageGetMessagesArg, 'threadConfig' | 'threadId'>;
 interface GetMemoryThreadMessagesResponse {
     messages: CoreMessage[];
     uiMessages: AiMessageType[];
 }
+type GetMemoryThreadMessagesPaginatedResponse = PaginationInfo & {
+    messages: MastraMessageV1[] | MastraMessageV2[];
+};
 interface GetLogsParams {
     transportId: string;
     fromDate?: Date;
@@ -321,17 +339,29 @@ interface GenerateOrStreamVNextNetworkParams {
     message: string;
     threadId?: string;
     resourceId?: string;
+    runtimeContext?: RuntimeContext | Record<string, any>;
 }
 interface LoopStreamVNextNetworkParams {
     message: string;
     threadId?: string;
     resourceId?: string;
     maxIterations?: number;
+    runtimeContext?: RuntimeContext | Record<string, any>;
 }
 interface LoopVNextNetworkResponse {
     status: 'success';
     result: {
-        text: string;
+        task: string;
+        resourceId: string;
+        resourceType: 'agent' | 'workflow' | 'none' | 'tool';
+        result: string;
+        iteration: number;
+        isOneOff: boolean;
+        prompt: string;
+        threadId?: string | undefined;
+        threadResourceId?: string | undefined;
+        isComplete?: boolean | undefined;
+        completionReason?: string | undefined;
     };
     steps: WorkflowResult<any, any>['steps'];
 }
@@ -350,6 +380,50 @@ interface McpToolInfo {
 interface McpServerToolListResponse {
     tools: McpToolInfo[];
 }
+type ClientScoreRowData = Omit<ScoreRowData, 'createdAt' | 'updatedAt'> & {
+    createdAt: string;
+    updatedAt: string;
+};
+interface GetScoresByRunIdParams {
+    runId: string;
+    page?: number;
+    perPage?: number;
+}
+interface GetScoresByScorerIdParams {
+    scorerId: string;
+    entityId?: string;
+    entityType?: string;
+    page?: number;
+    perPage?: number;
+}
+interface GetScoresByEntityIdParams {
+    entityId: string;
+    entityType: string;
+    page?: number;
+    perPage?: number;
+}
+interface SaveScoreParams {
+    score: ScoreRowData;
+}
+interface GetScoresResponse {
+    pagination: {
+        total: number;
+        page: number;
+        perPage: number;
+        hasMore: boolean;
+    };
+    scores: ClientScoreRowData[];
+}
+interface SaveScoreResponse {
+    score: ClientScoreRowData;
+}
+type GetScorerResponse = MastraScorerEntry & {
+    agentIds: string[];
+    workflowIds: string[];
+};
+interface GetScorersResponse {
+    scorers: Array<GetScorerResponse>;
+}
 
 declare class BaseResource {
     readonly options: ClientOptions;
@@ -415,18 +489,18 @@ 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> & {
+    generate(params: GenerateParams<undefined> & {
         output?: never;
         experimental_output?: never;
-    }): Promise<GenerateReturn<T>>;
-    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
-        output: T;
+    }): Promise<GenerateReturn<any, undefined, undefined>>;
+    generate<Output extends JSONSchema7 | ZodSchema>(params: GenerateParams<Output> & {
+        output: Output;
         experimental_output?: never;
-    }): Promise<GenerateReturn<T>>;
-    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
+    }): Promise<GenerateReturn<any, Output, undefined>>;
+    generate<StructuredOutput extends JSONSchema7 | ZodSchema>(params: GenerateParams<StructuredOutput> & {
         output?: never;
-        experimental_output: T;
-    }): Promise<GenerateReturn<T>>;
+        experimental_output: StructuredOutput;
+    }): Promise<GenerateReturn<any, undefined, StructuredOutput>>;
     private processChatResponse;
     /**
      * Streams a response from the agent
@@ -481,7 +555,7 @@ declare class Network 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<Output extends JSONSchema7 | ZodSchema | undefined = undefined, StructuredOutput extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<Output>): Promise<GenerateReturn$1<any, Output, StructuredOutput>>;
     /**
      * Streams a response from the agent
      * @param params - Stream parameters including prompt
@@ -520,6 +594,12 @@ declare class MemoryThread extends BaseResource {
      * @returns Promise containing thread messages and UI messages
      */
     getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
+    /**
+     * Retrieves paginated messages associated with the thread with advanced filtering and selection options
+     * @param params - Pagination parameters including selectBy criteria, page, perPage, date ranges, and message inclusion options
+     * @returns Promise containing paginated thread messages with pagination metadata (total, page, perPage, hasMore)
+     */
+    getMessagesPaginated({ selectBy, ...rest }: GetMemoryThreadMessagesPaginatedParams): Promise<GetMemoryThreadMessagesPaginatedResponse>;
 }
 
 declare class Vector extends BaseResource {
@@ -707,6 +787,26 @@ declare class Workflow extends BaseResource {
      * @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
@@ -717,6 +817,16 @@ declare class Workflow extends BaseResource {
     }): Promise<{
         runId: string;
     }>;
+    /**
+     * Creates a new workflow run (alias for createRun)
+     * @param params - Optional object containing the optional runId
+     * @returns Promise containing the runId of the created run
+     */
+    createRunAsync(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
@@ -859,6 +969,36 @@ declare class MCPTool extends BaseResource {
     }): Promise<any>;
 }
 
+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 VNextNetwork extends BaseResource {
     private networkId;
     constructor(options: ClientOptions, networkId: string);
@@ -880,6 +1020,7 @@ declare class VNextNetwork extends BaseResource {
      */
     loop(params: {
         message: string;
+        runtimeContext?: RuntimeContext | Record<string, any>;
     }): Promise<LoopVNextNetworkResponse>;
     private streamProcessor;
     /**
@@ -896,36 +1037,6 @@ declare class VNextNetwork extends BaseResource {
     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);
     /**
@@ -1128,6 +1239,61 @@ declare class MastraClient extends BaseResource {
      * @returns A2A client instance
      */
     getA2A(agentId: string): A2A;
+    /**
+     * Retrieves the working memory for a specific thread (optionally resource-scoped).
+     * @param agentId - ID of the agent.
+     * @param threadId - ID of the thread.
+     * @param resourceId - Optional ID of the resource.
+     * @returns Working memory for the specified thread or resource.
+     */
+    getWorkingMemory({ agentId, threadId, resourceId, }: {
+        agentId: string;
+        threadId: string;
+        resourceId?: string;
+    }): Promise<unknown>;
+    /**
+     * Updates the working memory for a specific thread (optionally resource-scoped).
+     * @param agentId - ID of the agent.
+     * @param threadId - ID of the thread.
+     * @param workingMemory - The new working memory content.
+     * @param resourceId - Optional ID of the resource.
+     */
+    updateWorkingMemory({ agentId, threadId, workingMemory, resourceId, }: {
+        agentId: string;
+        threadId: string;
+        workingMemory: string;
+        resourceId?: string;
+    }): Promise<unknown>;
+    /**
+     * Retrieves all available scorers
+     * @returns Promise containing list of available scorers
+     */
+    getScorers(): Promise<Record<string, GetScorerResponse>>;
+    /**
+     * Retrieves a scorer by ID
+     * @param scorerId - ID of the scorer to retrieve
+     * @returns Promise containing the scorer
+     */
+    getScorer(scorerId: string): Promise<GetScorerResponse>;
+    getScoresByScorerId(params: GetScoresByScorerIdParams): Promise<GetScoresResponse>;
+    /**
+     * Retrieves scores by run ID
+     * @param params - Parameters containing run ID and pagination options
+     * @returns Promise containing scores and pagination info
+     */
+    getScoresByRunId(params: GetScoresByRunIdParams): Promise<GetScoresResponse>;
+    /**
+     * Retrieves scores by entity ID and type
+     * @param params - Parameters containing entity ID, type, and pagination options
+     * @returns Promise containing scores and pagination info
+     */
+    getScoresByEntityId(params: GetScoresByEntityIdParams): Promise<GetScoresResponse>;
+    /**
+     * Saves a score
+     * @param params - Parameters containing the score data to save
+     * @returns Promise containing the saved score
+     */
+    saveScore(params: SaveScoreParams): Promise<SaveScoreResponse>;
 }
 
-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 };
+export { type ClientOptions, type ClientScoreRowData, 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 GetMemoryThreadMessagesPaginatedParams, type GetMemoryThreadMessagesPaginatedResponse, type GetMemoryThreadMessagesParams, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkMemoryThreadParams, type GetNetworkResponse, type GetScorerResponse, type GetScorersResponse, type GetScoresByEntityIdParams, type GetScoresByRunIdParams, type GetScoresByScorerIdParams, type GetScoresResponse, 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 SaveScoreParams, type SaveScoreResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult, type WorkflowWatchResult };