@mastra/client-js 0.1.23-alpha.0 → 0.10.0

package/src/resources/workflow.ts

@@ -1,11 +1,14 @@
+import type { RuntimeContext } from '@mastra/core/runtime-context';
 import type {
-  GetWorkflowResponse,
   ClientOptions,
-  WorkflowRunResult,
+  GetWorkflowResponse,
   GetWorkflowRunsResponse,
   GetWorkflowRunsParams,
+  WorkflowRunResult,
+  WorkflowWatchResult,
 } from '../types';
 
+import { parseClientRuntimeContext } from '../utils';
 import { BaseResource } from './base';
 
 const RECORD_SEPARATOR = '\x1E';
@@ -18,6 +21,77 @@ export class Workflow extends BaseResource {
     super(options);
   }
 
+  /**
+   * 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 async *streamProcessor(stream: ReadableStream): AsyncGenerator<WorkflowWatchResult, 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 workflow
    * @returns Promise containing workflow details including steps and graphs
@@ -56,22 +130,10 @@ export class Workflow extends BaseResource {
     }
   }
 
-  /**
-   * @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
-   */
-  execute(params: Record<string, any>): Promise<WorkflowRunResult> {
-    return this.request(`/api/workflows/${this.workflowId}/execute`, {
-      method: 'POST',
-      body: params,
-    });
-  }
-
   /**
    * Creates a new workflow run
-   * @returns Promise containing the generated run ID
+   * @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();
@@ -80,158 +142,108 @@ export class Workflow extends BaseResource {
       searchParams.set('runId', params.runId);
     }
 
-    return this.request(`/api/workflows/${this.workflowId}/createRun?${searchParams.toString()}`, {
+    return this.request(`/api/workflows/${this.workflowId}/create-run?${searchParams.toString()}`, {
       method: 'POST',
     });
   }
 
   /**
    * Starts a workflow run synchronously without waiting for the workflow to complete
-   * @param params - Object containing the runId and triggerData
+   * @param params - Object containing the runId, inputData and runtimeContext
    * @returns Promise containing success message
    */
-  start(params: { runId: string; triggerData: Record<string, any> }): Promise<{ message: string }> {
+  start(params: {
+    runId: string;
+    inputData: Record<string, any>;
+    runtimeContext?: RuntimeContext | Record<string, any>;
+  }): Promise<{ message: string }> {
+    const runtimeContext = parseClientRuntimeContext(params.runtimeContext);
     return this.request(`/api/workflows/${this.workflowId}/start?runId=${params.runId}`, {
       method: 'POST',
-      body: params?.triggerData,
+      body: { inputData: params?.inputData, runtimeContext },
     });
   }
 
   /**
    * Resumes a suspended 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 params - Object containing the runId, step, resumeData and runtimeContext
+   * @returns Promise containing success message
    */
   resume({
-    stepId,
+    step,
     runId,
-    context,
+    resumeData,
+    ...rest
   }: {
-    stepId: string;
+    step: string | string[];
     runId: string;
-    context: Record<string, any>;
+    resumeData?: Record<string, any>;
+    runtimeContext?: RuntimeContext | Record<string, any>;
   }): Promise<{ message: string }> {
+    const runtimeContext = parseClientRuntimeContext(rest.runtimeContext);
     return this.request(`/api/workflows/${this.workflowId}/resume?runId=${runId}`, {
       method: 'POST',
+      stream: true,
       body: {
-        stepId,
-        context,
+        step,
+        resumeData,
+        runtimeContext,
       },
     });
   }
 
   /**
    * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-   * @param params - Object containing the optional runId and triggerData
+   * @param params - Object containing the optional runId, inputData and runtimeContext
    * @returns Promise containing the workflow execution results
    */
-  startAsync(params: { runId?: string; triggerData: Record<string, any> }): Promise<WorkflowRunResult> {
+  startAsync(params: {
+    runId?: string;
+    inputData: Record<string, any>;
+    runtimeContext?: RuntimeContext | Record<string, any>;
+  }): Promise<WorkflowRunResult> {
     const searchParams = new URLSearchParams();
 
     if (!!params?.runId) {
       searchParams.set('runId', params.runId);
     }
 
+    const runtimeContext = parseClientRuntimeContext(params.runtimeContext);
+
     return this.request(`/api/workflows/${this.workflowId}/start-async?${searchParams.toString()}`, {
       method: 'POST',
-      body: params?.triggerData,
+      body: { inputData: params.inputData, runtimeContext },
     });
   }
 
   /**
    * Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
-   * @param params - Object containing the runId, stepId, and context
+   * @param params - Object containing the runId, step, resumeData and runtimeContext
    * @returns Promise containing the workflow resume results
    */
-  resumeAsync(params: { runId: string; stepId: string; context: Record<string, any> }): Promise<WorkflowRunResult> {
+  resumeAsync(params: {
+    runId: string;
+    step: string | string[];
+    resumeData?: Record<string, any>;
+    runtimeContext?: RuntimeContext | Record<string, any>;
+  }): Promise<WorkflowRunResult> {
+    const runtimeContext = parseClientRuntimeContext(params.runtimeContext);
     return this.request(`/api/workflows/${this.workflowId}/resume-async?runId=${params.runId}`, {
       method: 'POST',
       body: {
-        stepId: params.stepId,
-        context: params.context,
+        step: params.step,
+        resumeData: params.resumeData,
+        runtimeContext,
       },
     });
   }
 
-  /**
-   * Creates an async generator that processes a readable stream and yields 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<WorkflowRunResult, 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
-      });
-    }
-  }
-
   /**
    * 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
    */
-  async watch({ runId }: { runId?: string }, onRecord: (record: WorkflowRunResult) => void) {
+  async watch({ runId }: { runId?: string }, onRecord: (record: WorkflowWatchResult) => void) {
     const response: Response = await this.request(`/api/workflows/${this.workflowId}/watch?runId=${runId}`, {
       stream: true,
     });

package/src/types.ts

@@ -3,19 +3,21 @@ import type {
   AiMessageType,
   CoreMessage,
   QueryResult,
-  StepAction,
-  StepGraph,
   StorageThreadType,
-  BaseLogMessage,
-  WorkflowRunResult as CoreWorkflowRunResult,
-  VNextWorkflowRuns,
   WorkflowRuns,
+  LegacyWorkflowRuns,
 } from '@mastra/core';
+import type { BaseLogMessage } from '@mastra/core/logger';
 
 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 { RuntimeContext } from '@mastra/core/runtime-context';
+import type { Workflow, WatchEvent, WorkflowResult } from '@mastra/core/workflows';
+import type {
+  StepAction,
+  StepGraph,
+  LegacyWorkflowRunResult as CoreLegacyWorkflowRunResult,
+} from '@mastra/core/workflows/legacy';
 import type { JSONSchema7 } from 'json-schema';
 import type { ZodSchema } from 'zod';
 
@@ -64,14 +66,14 @@ export type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undef
   messages: string | string[] | CoreMessage[] | AiMessageType[];
   output?: T;
   experimental_output?: T;
-  runtimeContext?: RuntimeContext;
+  runtimeContext?: RuntimeContext | Record<string, any>;
 } & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 
 export type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
   messages: string | string[] | CoreMessage[] | AiMessageType[];
   output?: T;
   experimental_output?: T;
-  runtimeContext?: RuntimeContext;
+  runtimeContext?: RuntimeContext | Record<string, any>;
 } & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext'>>;
 
 export interface GetEvalsByAgentIdResponse extends GetAgentResponse {
@@ -88,7 +90,7 @@ export interface GetToolResponse {
   outputSchema: string;
 }
 
-export interface GetWorkflowResponse {
+export interface GetLegacyWorkflowResponse {
   name: string;
   triggerSchema: string;
   steps: Record<string, StepAction<any, any, any, any>>;
@@ -105,19 +107,20 @@ export interface GetWorkflowRunsParams {
   resourceId?: string;
 }
 
-export type GetWorkflowRunsResponse = WorkflowRuns;
+export type GetLegacyWorkflowRunsResponse = LegacyWorkflowRuns;
 
-export type GetVNextWorkflowRunsResponse = VNextWorkflowRuns;
+export type GetWorkflowRunsResponse = WorkflowRuns;
 
-export type WorkflowRunResult = {
+export type LegacyWorkflowRunResult = {
   activePaths: Record<string, { status: string; suspendPayload?: any; stepPath: string[] }>;
-  results: CoreWorkflowRunResult<any, any, any>['results'];
+  results: CoreLegacyWorkflowRunResult<any, any, any>['results'];
   timestamp: number;
   runId: string;
 };
 
-export interface GetVNextWorkflowResponse {
+export interface GetWorkflowResponse {
   name: string;
+  description?: string;
   steps: {
     [key: string]: {
       id: string;
@@ -128,14 +131,14 @@ export interface GetVNextWorkflowResponse {
       suspendSchema: string;
     };
   };
-  stepGraph: NewWorkflow['serializedStepGraph'];
+  stepGraph: Workflow['serializedStepGraph'];
   inputSchema: string;
   outputSchema: string;
 }
 
-export type VNextWorkflowWatchResult = WatchEvent & { runId: string };
+export type WorkflowWatchResult = WatchEvent & { runId: string };
 
-export type VNextWorkflowRunResult = VNextWorkflowResult<any, any>;
+export type WorkflowRunResult = WorkflowResult<any, any>;
 export interface UpsertVectorParams {
   indexName: string;
   vectors: number[][];

package/src/utils/index.ts

@@ -0,0 +1,11 @@
+import { RuntimeContext } from '@mastra/core/runtime-context';
+
+export function parseClientRuntimeContext(runtimeContext?: RuntimeContext | Record<string, any>) {
+  if (runtimeContext) {
+    if (runtimeContext instanceof RuntimeContext) {
+      return Object.fromEntries(runtimeContext.entries());
+    }
+    return runtimeContext;
+  }
+  return undefined;
+}