@mastra/client-js 0.0.0-switch-to-core-20250424015131 → 0.0.0-vnext-inngest-20250506123700

package/dist/index.d.cts

@@ -1,8 +1,11 @@
-import { CoreMessage, AiMessageType, StorageThreadType, MessageType, StepAction, StepGraph, WorkflowRunResult as WorkflowRunResult$1, QueryResult, BaseLogMessage, GenerateReturn } from '@mastra/core';
+import { AbstractAgent } from '@ag-ui/client';
+import { processDataStream } from '@ai-sdk/ui-utils';
+import { CoreMessage, AiMessageType, StorageThreadType, MessageType, StepAction, StepGraph, WorkflowRuns, WorkflowRunResult as WorkflowRunResult$1, QueryResult, BaseLogMessage, 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 { NewWorkflow, WorkflowResult, WatchEvent } from '@mastra/core/workflows/vNext';
+import { RuntimeContext } from '@mastra/core/runtime-context';
 
 interface ClientOptions {
     /** Base URL for API requests */
@@ -38,6 +41,9 @@ type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
 } & Omit<AgentStreamOptions<T>, 'onFinish' | 'onStepFinish' | 'telemetry'>;
 interface GetEvalsByAgentIdResponse extends GetAgentResponse {
     evals: any[];
+    instructions: string;
+    name: string;
+    id: string;
 }
 interface GetToolResponse {
     id: string;
@@ -53,6 +59,14 @@ interface GetWorkflowResponse {
     stepSubscriberGraph: Record<string, StepGraph>;
     workflowId?: string;
 }
+interface GetWorkflowRunsParams {
+    fromDate?: Date;
+    toDate?: Date;
+    limit?: number;
+    offset?: number;
+    resourceId?: string;
+}
+type GetWorkflowRunsResponse = WorkflowRuns;
 type WorkflowRunResult = {
     activePaths: Record<string, {
         status: string;
@@ -63,6 +77,26 @@ type WorkflowRunResult = {
     timestamp: number;
     runId: string;
 };
+interface GetVNextWorkflowResponse {
+    name: string;
+    steps: {
+        [key: string]: {
+            id: string;
+            description: string;
+            inputSchema: string;
+            outputSchema: string;
+            resumeSchema: string;
+            suspendSchema: string;
+        };
+    };
+    stepGraph: NewWorkflow['serializedStepGraph'];
+    inputSchema: string;
+    outputSchema: string;
+}
+type VNextWorkflowWatchResult = WatchEvent & {
+    runId: string;
+};
+type VNextWorkflowRunResult = WorkflowResult<any, any>;
 interface UpsertVectorParams {
     indexName: string;
     vectors: number[][];
@@ -171,6 +205,8 @@ interface GetTelemetryParams {
     page?: number;
     perPage?: number;
     attribute?: Record<string, string>;
+    fromDate?: Date;
+    toDate?: Date;
 }
 interface GetNetworkResponse {
     name: string;
@@ -376,6 +412,12 @@ declare class Workflow extends BaseResource {
      * @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>;
     /**
      * @deprecated Use `startAsync` instead
      * Executes the workflow with the provided parameters
@@ -469,9 +511,98 @@ declare class Tool extends BaseResource {
      */
     execute(params: {
         data: any;
+        runId?: string;
     }): Promise<any>;
 }
 
+declare class VNextWorkflow extends BaseResource {
+    private workflowId;
+    constructor(options: ClientOptions, workflowId: string);
+    /**
+     * Creates an async generator that processes a readable stream and yields vNext 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 vNext workflow
+     * @returns Promise containing vNext workflow details including steps and graphs
+     */
+    details(): Promise<GetVNextWorkflowResponse>;
+    /**
+     * Retrieves all runs for a vNext workflow
+     * @param params - Parameters for filtering runs
+     * @returns Promise containing vNext workflow runs array
+     */
+    runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse>;
+    /**
+     * Creates a new vNext 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 vNext 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;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Resumes a suspended vNext workflow step synchronously without waiting for the vNext workflow to complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing success message
+     */
+    resume({ step, runId, resumeData, runtimeContext, }: {
+        step: string | string[];
+        runId: string;
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Starts a vNext workflow run asynchronously and returns a promise that resolves when the vNext workflow is complete
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the vNext workflow execution results
+     */
+    startAsync(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<VNextWorkflowRunResult>;
+    /**
+     * Resumes a suspended vNext workflow step asynchronously and returns a promise that resolves when the vNext workflow is complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing the vNext workflow resume results
+     */
+    resumeAsync(params: {
+        runId: string;
+        step: string | string[];
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<VNextWorkflowRunResult>;
+    /**
+     * Watches vNext workflow transitions in real-time
+     * @param runId - Optional run ID to filter the watch stream
+     * @returns AsyncGenerator that yields parsed records from the vNext workflow watch stream
+     */
+    watch({ runId }: {
+        runId?: string;
+    }, onRecord: (record: VNextWorkflowWatchResult) => void): Promise<void>;
+}
+
 declare class MastraClient extends BaseResource {
     constructor(options: ClientOptions);
     /**
@@ -479,6 +610,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
@@ -538,6 +672,17 @@ declare class MastraClient extends BaseResource {
      * @returns Workflow instance
      */
     getWorkflow(workflowId: string): Workflow;
+    /**
+     * Retrieves all available vNext workflows
+     * @returns Promise containing map of vNext workflow IDs to vNext workflow details
+     */
+    getVNextWorkflows(): Promise<Record<string, GetVNextWorkflowResponse>>;
+    /**
+     * Gets a vNext workflow instance by ID
+     * @param workflowId - ID of the vNext workflow to retrieve
+     * @returns vNext Workflow instance
+     */
+    getVNextWorkflow(workflowId: string): VNextWorkflow;
     /**
      * Gets a vector instance by name
      * @param vectorName - Name of the vector to retrieve
@@ -582,4 +727,4 @@ declare class MastraClient extends BaseResource {
     getNetwork(networkId: string): Network;
 }
 
-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 GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVNextWorkflowResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowRunsParams, type GetWorkflowRunsResponse, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type VNextWorkflowRunResult, type VNextWorkflowWatchResult, type WorkflowRunResult };

package/dist/index.d.ts

@@ -1,8 +1,11 @@
-import { CoreMessage, AiMessageType, StorageThreadType, MessageType, StepAction, StepGraph, WorkflowRunResult as WorkflowRunResult$1, QueryResult, BaseLogMessage, GenerateReturn } from '@mastra/core';
+import { AbstractAgent } from '@ag-ui/client';
+import { processDataStream } from '@ai-sdk/ui-utils';
+import { CoreMessage, AiMessageType, StorageThreadType, MessageType, StepAction, StepGraph, WorkflowRuns, WorkflowRunResult as WorkflowRunResult$1, QueryResult, BaseLogMessage, 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 { NewWorkflow, WorkflowResult, WatchEvent } from '@mastra/core/workflows/vNext';
+import { RuntimeContext } from '@mastra/core/runtime-context';
 
 interface ClientOptions {
     /** Base URL for API requests */
@@ -38,6 +41,9 @@ type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
 } & Omit<AgentStreamOptions<T>, 'onFinish' | 'onStepFinish' | 'telemetry'>;
 interface GetEvalsByAgentIdResponse extends GetAgentResponse {
     evals: any[];
+    instructions: string;
+    name: string;
+    id: string;
 }
 interface GetToolResponse {
     id: string;
@@ -53,6 +59,14 @@ interface GetWorkflowResponse {
     stepSubscriberGraph: Record<string, StepGraph>;
     workflowId?: string;
 }
+interface GetWorkflowRunsParams {
+    fromDate?: Date;
+    toDate?: Date;
+    limit?: number;
+    offset?: number;
+    resourceId?: string;
+}
+type GetWorkflowRunsResponse = WorkflowRuns;
 type WorkflowRunResult = {
     activePaths: Record<string, {
         status: string;
@@ -63,6 +77,26 @@ type WorkflowRunResult = {
     timestamp: number;
     runId: string;
 };
+interface GetVNextWorkflowResponse {
+    name: string;
+    steps: {
+        [key: string]: {
+            id: string;
+            description: string;
+            inputSchema: string;
+            outputSchema: string;
+            resumeSchema: string;
+            suspendSchema: string;
+        };
+    };
+    stepGraph: NewWorkflow['serializedStepGraph'];
+    inputSchema: string;
+    outputSchema: string;
+}
+type VNextWorkflowWatchResult = WatchEvent & {
+    runId: string;
+};
+type VNextWorkflowRunResult = WorkflowResult<any, any>;
 interface UpsertVectorParams {
     indexName: string;
     vectors: number[][];
@@ -171,6 +205,8 @@ interface GetTelemetryParams {
     page?: number;
     perPage?: number;
     attribute?: Record<string, string>;
+    fromDate?: Date;
+    toDate?: Date;
 }
 interface GetNetworkResponse {
     name: string;
@@ -376,6 +412,12 @@ declare class Workflow extends BaseResource {
      * @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>;
     /**
      * @deprecated Use `startAsync` instead
      * Executes the workflow with the provided parameters
@@ -469,9 +511,98 @@ declare class Tool extends BaseResource {
      */
     execute(params: {
         data: any;
+        runId?: string;
     }): Promise<any>;
 }
 
+declare class VNextWorkflow extends BaseResource {
+    private workflowId;
+    constructor(options: ClientOptions, workflowId: string);
+    /**
+     * Creates an async generator that processes a readable stream and yields vNext 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 vNext workflow
+     * @returns Promise containing vNext workflow details including steps and graphs
+     */
+    details(): Promise<GetVNextWorkflowResponse>;
+    /**
+     * Retrieves all runs for a vNext workflow
+     * @param params - Parameters for filtering runs
+     * @returns Promise containing vNext workflow runs array
+     */
+    runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse>;
+    /**
+     * Creates a new vNext 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 vNext 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;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Resumes a suspended vNext workflow step synchronously without waiting for the vNext workflow to complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing success message
+     */
+    resume({ step, runId, resumeData, runtimeContext, }: {
+        step: string | string[];
+        runId: string;
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Starts a vNext workflow run asynchronously and returns a promise that resolves when the vNext workflow is complete
+     * @param params - Object containing the optional runId, inputData and runtimeContext
+     * @returns Promise containing the vNext workflow execution results
+     */
+    startAsync(params: {
+        runId?: string;
+        inputData: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<VNextWorkflowRunResult>;
+    /**
+     * Resumes a suspended vNext workflow step asynchronously and returns a promise that resolves when the vNext workflow is complete
+     * @param params - Object containing the runId, step, resumeData and runtimeContext
+     * @returns Promise containing the vNext workflow resume results
+     */
+    resumeAsync(params: {
+        runId: string;
+        step: string | string[];
+        resumeData?: Record<string, any>;
+        runtimeContext?: RuntimeContext;
+    }): Promise<VNextWorkflowRunResult>;
+    /**
+     * Watches vNext workflow transitions in real-time
+     * @param runId - Optional run ID to filter the watch stream
+     * @returns AsyncGenerator that yields parsed records from the vNext workflow watch stream
+     */
+    watch({ runId }: {
+        runId?: string;
+    }, onRecord: (record: VNextWorkflowWatchResult) => void): Promise<void>;
+}
+
 declare class MastraClient extends BaseResource {
     constructor(options: ClientOptions);
     /**
@@ -479,6 +610,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
@@ -538,6 +672,17 @@ declare class MastraClient extends BaseResource {
      * @returns Workflow instance
      */
     getWorkflow(workflowId: string): Workflow;
+    /**
+     * Retrieves all available vNext workflows
+     * @returns Promise containing map of vNext workflow IDs to vNext workflow details
+     */
+    getVNextWorkflows(): Promise<Record<string, GetVNextWorkflowResponse>>;
+    /**
+     * Gets a vNext workflow instance by ID
+     * @param workflowId - ID of the vNext workflow to retrieve
+     * @returns vNext Workflow instance
+     */
+    getVNextWorkflow(workflowId: string): VNextWorkflow;
     /**
      * Gets a vector instance by name
      * @param vectorName - Name of the vector to retrieve
@@ -582,4 +727,4 @@ declare class MastraClient extends BaseResource {
     getNetwork(networkId: string): Network;
 }
 
-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 GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVNextWorkflowResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowRunsParams, type GetWorkflowRunsResponse, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type VNextWorkflowRunResult, type VNextWorkflowWatchResult, type WorkflowRunResult };