@mastra/client-js 0.0.0-switch-to-core-20250424015131 → 0.0.0-vector-query-sources-20250516172905

package/src/resources/vnext-workflow.ts

@@ -0,0 +1,261 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type {
+  ClientOptions,
+  GetVNextWorkflowResponse,
+  GetVNextWorkflowRunsResponse,
+  GetWorkflowRunsParams,
+  VNextWorkflowRunResult,
+  VNextWorkflowWatchResult,
+} from '../types';
+
+import { BaseResource } from './base';
+
+const RECORD_SEPARATOR = '\x1E';
+
+export class VNextWorkflow extends BaseResource {
+  constructor(
+    options: ClientOptions,
+    private workflowId: string,
+  ) {
+    super(options);
+  }
+
+  /**
+   * 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 async *streamProcessor(stream: ReadableStream): AsyncGenerator<VNextWorkflowWatchResult, void, unknown> {
+    const reader = stream.getReader();
+
+    // Track if we've finished reading from the stream
+    let doneReading = false;
+    // Buffer to accumulate partial chunks
+    let buffer = '';
+
+    try {
+      while (!doneReading) {
+        // Read the next chunk from the stream
+        const { done, value } = await reader.read();
+        doneReading = done;
+
+        // Skip processing if we're done and there's no value
+        if (done && !value) continue;
+
+        try {
+          // Decode binary data to text
+          const decoded = value ? new TextDecoder().decode(value) : '';
+
+          // Split the combined buffer and new data by record separator
+          const chunks = (buffer + decoded).split(RECORD_SEPARATOR);
+
+          // The last chunk might be incomplete, so save it for the next iteration
+          buffer = chunks.pop() || '';
+
+          // Process complete chunks
+          for (const chunk of chunks) {
+            if (chunk) {
+              // Only process non-empty chunks
+              if (typeof chunk === 'string') {
+                try {
+                  const parsedChunk = JSON.parse(chunk);
+                  yield parsedChunk;
+                } catch {
+                  // Silently ignore parsing errors to maintain stream processing
+                  // This allows the stream to continue even if one record is malformed
+                }
+              }
+            }
+          }
+        } catch {
+          // Silently ignore parsing errors to maintain stream processing
+          // This allows the stream to continue even if one record is malformed
+        }
+      }
+
+      // Process any remaining data in the buffer after stream is done
+      if (buffer) {
+        try {
+          yield JSON.parse(buffer);
+        } catch {
+          // Ignore parsing error for final chunk
+        }
+      }
+    } finally {
+      // Always ensure we clean up the reader
+      reader.cancel().catch(() => {
+        // Ignore cancel errors
+      });
+    }
+  }
+
+  /**
+   * Retrieves details about the vNext workflow
+   * @returns Promise containing vNext workflow details including steps and graphs
+   */
+  details(): Promise<GetVNextWorkflowResponse> {
+    return this.request(`/api/workflows/v-next/${this.workflowId}`);
+  }
+
+  /**
+   * Retrieves all runs for a vNext workflow
+   * @param params - Parameters for filtering runs
+   * @returns Promise containing vNext workflow runs array
+   */
+  runs(params?: GetWorkflowRunsParams): Promise<GetVNextWorkflowRunsResponse> {
+    const searchParams = new URLSearchParams();
+    if (params?.fromDate) {
+      searchParams.set('fromDate', params.fromDate.toISOString());
+    }
+    if (params?.toDate) {
+      searchParams.set('toDate', params.toDate.toISOString());
+    }
+    if (params?.limit) {
+      searchParams.set('limit', String(params.limit));
+    }
+    if (params?.offset) {
+      searchParams.set('offset', String(params.offset));
+    }
+    if (params?.resourceId) {
+      searchParams.set('resourceId', params.resourceId);
+    }
+
+    if (searchParams.size) {
+      return this.request(`/api/workflows/v-next/${this.workflowId}/runs?${searchParams}`);
+    } else {
+      return this.request(`/api/workflows/v-next/${this.workflowId}/runs`);
+    }
+  }
+
+  /**
+   * 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 }> {
+    const searchParams = new URLSearchParams();
+
+    if (!!params?.runId) {
+      searchParams.set('runId', params.runId);
+    }
+
+    return this.request(`/api/workflows/v-next/${this.workflowId}/create-run?${searchParams.toString()}`, {
+      method: 'POST',
+    });
+  }
+
+  /**
+   * 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 }> {
+    const runtimeContext = params.runtimeContext ? Object.fromEntries(params.runtimeContext.entries()) : undefined;
+    return this.request(`/api/workflows/v-next/${this.workflowId}/start?runId=${params.runId}`, {
+      method: 'POST',
+      body: { inputData: params?.inputData, runtimeContext },
+    });
+  }
+
+  /**
+   * 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,
+    ...rest
+  }: {
+    step: string | string[];
+    runId: string;
+    resumeData?: Record<string, any>;
+    runtimeContext?: RuntimeContext;
+  }): Promise<{ message: string }> {
+    const runtimeContext = rest.runtimeContext ? Object.fromEntries(rest.runtimeContext.entries()) : undefined;
+    return this.request(`/api/workflows/v-next/${this.workflowId}/resume?runId=${runId}`, {
+      method: 'POST',
+      stream: true,
+      body: {
+        step,
+        resumeData,
+        runtimeContext,
+      },
+    });
+  }
+
+  /**
+   * 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> {
+    const searchParams = new URLSearchParams();
+
+    if (!!params?.runId) {
+      searchParams.set('runId', params.runId);
+    }
+
+    const runtimeContext = params.runtimeContext ? Object.fromEntries(params.runtimeContext.entries()) : undefined;
+    return this.request(`/api/workflows/v-next/${this.workflowId}/start-async?${searchParams.toString()}`, {
+      method: 'POST',
+      body: { inputData: params.inputData, runtimeContext },
+    });
+  }
+
+  /**
+   * 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> {
+    const runtimeContext = params.runtimeContext ? Object.fromEntries(params.runtimeContext.entries()) : undefined;
+    return this.request(`/api/workflows/v-next/${this.workflowId}/resume-async?runId=${params.runId}`, {
+      method: 'POST',
+      body: {
+        step: params.step,
+        resumeData: params.resumeData,
+        runtimeContext,
+      },
+    });
+  }
+
+  /**
+   * 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
+   */
+  async watch({ runId }: { runId?: string }, onRecord: (record: VNextWorkflowWatchResult) => void) {
+    const response: Response = await this.request(`/api/workflows/v-next/${this.workflowId}/watch?runId=${runId}`, {
+      stream: true,
+    });
+
+    if (!response.ok) {
+      throw new Error(`Failed to watch vNext workflow: ${response.statusText}`);
+    }
+
+    if (!response.body) {
+      throw new Error('Response body is null');
+    }
+
+    for await (const record of this.streamProcessor(response.body)) {
+      onRecord(record);
+    }
+  }
+}

package/src/resources/workflow.ts

@@ -1,4 +1,10 @@
-import type { GetWorkflowResponse, ClientOptions, WorkflowRunResult } from '../types';
+import type {
+  GetWorkflowResponse,
+  ClientOptions,
+  WorkflowRunResult,
+  GetWorkflowRunsResponse,
+  GetWorkflowRunsParams,
+} from '../types';
 
 import { BaseResource } from './base';
 
@@ -20,6 +26,36 @@ export class Workflow extends BaseResource {
     return this.request(`/api/workflows/${this.workflowId}`);
   }
 
+  /**
+   * Retrieves all runs for a workflow
+   * @param params - Parameters for filtering runs
+   * @returns Promise containing workflow runs array
+   */
+  runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse> {
+    const searchParams = new URLSearchParams();
+    if (params?.fromDate) {
+      searchParams.set('fromDate', params.fromDate.toISOString());
+    }
+    if (params?.toDate) {
+      searchParams.set('toDate', params.toDate.toISOString());
+    }
+    if (params?.limit) {
+      searchParams.set('limit', String(params.limit));
+    }
+    if (params?.offset) {
+      searchParams.set('offset', String(params.offset));
+    }
+    if (params?.resourceId) {
+      searchParams.set('resourceId', params.resourceId);
+    }
+
+    if (searchParams.size) {
+      return this.request(`/api/workflows/${this.workflowId}/runs?${searchParams}`);
+    } else {
+      return this.request(`/api/workflows/${this.workflowId}/runs`);
+    }
+  }
+
   /**
    * @deprecated Use `startAsync` instead
    * Executes the workflow with the provided parameters
@@ -168,7 +204,7 @@ export class Workflow extends BaseResource {
               }
             }
           }
-        } catch (error) {
+        } catch {
           // Silently ignore parsing errors to maintain stream processing
           // This allows the stream to continue even if one record is malformed
         }

package/src/types.ts

@@ -8,9 +8,14 @@ import type {
   StorageThreadType,
   BaseLogMessage,
   WorkflowRunResult as CoreWorkflowRunResult,
+  VNextWorkflowRuns,
+  WorkflowRuns,
 } from '@mastra/core';
 
 import type { AgentGenerateOptions, AgentStreamOptions } from '@mastra/core/agent';
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import type { ServerInfo } from '@mastra/core/mcp';
+import type { NewWorkflow, WatchEvent, WorkflowResult as VNextWorkflowResult } from '@mastra/core/workflows/vNext';
 import type { JSONSchema7 } from 'json-schema';
 import type { ZodSchema } from 'zod';
 
@@ -36,24 +41,44 @@ export interface RequestOptions {
   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];
+};
+
 export interface GetAgentResponse {
   name: string;
   instructions: string;
   tools: Record<string, GetToolResponse>;
+  workflows: Record<string, GetWorkflowResponse>;
   provider: string;
   modelId: string;
 }
 
 export type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
   messages: string | string[] | CoreMessage[] | AiMessageType[];
-} & Partial<AgentGenerateOptions<T>>;
+  output?: T;
+  experimental_output?: T;
+  runtimeContext?: RuntimeContext;
+} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 
 export 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;
+} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 
 export interface GetEvalsByAgentIdResponse extends GetAgentResponse {
   evals: any[];
+  instructions: string;
+  name: string;
+  id: string;
 }
 
 export interface GetToolResponse {
@@ -72,12 +97,45 @@ export interface GetWorkflowResponse {
   workflowId?: string;
 }
 
+export interface GetWorkflowRunsParams {
+  fromDate?: Date;
+  toDate?: Date;
+  limit?: number;
+  offset?: number;
+  resourceId?: string;
+}
+
+export type GetWorkflowRunsResponse = WorkflowRuns;
+
+export type GetVNextWorkflowRunsResponse = VNextWorkflowRuns;
+
 export type WorkflowRunResult = {
   activePaths: Record<string, { status: string; suspendPayload?: any; stepPath: string[] }>;
   results: CoreWorkflowRunResult<any, any, any>['results'];
   timestamp: number;
   runId: string;
 };
+
+export 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;
+}
+
+export type VNextWorkflowWatchResult = WatchEvent & { runId: string };
+
+export type VNextWorkflowRunResult = VNextWorkflowResult<any, any>;
 export interface UpsertVectorParams {
   indexName: string;
   vectors: number[][];
@@ -138,6 +196,13 @@ export interface UpdateMemoryThreadParams {
   resourceId: string;
 }
 
+export interface GetMemoryThreadMessagesParams {
+  /**
+   * Limit the number of messages to retrieve (default: 40)
+   */
+  limit?: number;
+}
+
 export interface GetMemoryThreadMessagesResponse {
   messages: CoreMessage[];
   uiMessages: AiMessageType[];
@@ -206,6 +271,8 @@ export interface GetTelemetryParams {
   page?: number;
   perPage?: number;
   attribute?: Record<string, string>;
+  fromDate?: Date;
+  toDate?: Date;
 }
 
 export interface GetNetworkResponse {
@@ -222,3 +289,20 @@ export interface GetNetworkResponse {
   };
   state?: Record<string, any>;
 }
+
+export interface McpServerListResponse {
+  servers: ServerInfo[];
+  next: string | null;
+  total_count: number;
+}
+
+export interface McpToolInfo {
+  id: string;
+  name: string;
+  description?: string;
+  inputSchema: string;
+}
+
+export interface McpServerToolListResponse {
+  tools: McpToolInfo[];
+}

package/src/utils/zod-to-json-schema.ts

@@ -0,0 +1,10 @@
+import { ZodSchema } from 'zod';
+import originalZodToJsonSchema from 'zod-to-json-schema';
+
+export function zodToJsonSchema<T extends ZodSchema | any>(zodSchema: T) {
+  if (!(zodSchema instanceof ZodSchema)) {
+    return zodSchema;
+  }
+
+  return originalZodToJsonSchema(zodSchema, { $refStrategy: 'none' });
+}