@mastra/client-js 0.1.14-alpha.1 → 0.1.14-alpha.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @mastra/client-js@0.1.14-alpha.1 build /home/runner/work/mastra/mastra/client-sdks/client-js
+> @mastra/client-js@0.1.14-alpha.3 build /home/runner/work/mastra/mastra/client-sdks/client-js
 > tsup src/index.ts --format esm,cjs --dts --clean --treeshake=smallest --splitting
 
 CLI Building entry: src/index.ts
@@ -9,11 +9,11 @@
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 21.61 KB
-ESM ⚡️ Build success in 859ms
-CJS dist/index.cjs 21.79 KB
-CJS ⚡️ Build success in 860ms
+ESM dist/index.js 21.30 KB
+ESM ⚡️ Build success in 809ms
+CJS dist/index.cjs 21.48 KB
+CJS ⚡️ Build success in 810ms
 DTS Build start
-DTS ⚡️ Build success in 12860ms
-DTS dist/index.d.ts  18.89 KB
-DTS dist/index.d.cts 18.89 KB
+DTS ⚡️ Build success in 12001ms
+DTS dist/index.d.ts  18.97 KB
+DTS dist/index.d.cts 18.97 KB

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @mastra/client-js
 
+## 0.1.14-alpha.3
+
+### Patch Changes
+
+- 789bef3: Make runId optional for workflow startAsync api
+- 8393832: Handle nested workflow view on workflow graph
+- Updated dependencies [5ae0180]
+- Updated dependencies [9bfa12b]
+- Updated dependencies [515ebfb]
+- Updated dependencies [88fa727]
+- Updated dependencies [f37f535]
+- Updated dependencies [4d67826]
+- Updated dependencies [6330967]
+- Updated dependencies [8393832]
+- Updated dependencies [6330967]
+  - @mastra/core@0.8.0-alpha.3
+
+## 0.1.14-alpha.2
+
+### Patch Changes
+
+- 84fe241: Improve streaming of workflows
+- Updated dependencies [56c31b7]
+- Updated dependencies [dbbbf80]
+- Updated dependencies [99d43b9]
+  - @mastra/core@0.8.0-alpha.2
+
 ## 0.1.14-alpha.1
 
 ### Patch Changes

package/dist/index.cjs

@@ -359,6 +359,7 @@ var Vector = class extends BaseResource {
 };
 
 // src/resources/workflow.ts
+var RECORD_SEPARATOR = "";
 var Workflow = class extends BaseResource {
   constructor(options, workflowId) {
     super(options);
@@ -372,6 +373,7 @@ var Workflow = class extends BaseResource {
     return this.request(`/api/workflows/${this.workflowId}`);
   }
   /**
+   * @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
@@ -428,11 +430,15 @@ var Workflow = class extends BaseResource {
   }
   /**
    * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-   * @param params - Object containing the runId and triggerData
+   * @param params - Object containing the optional runId and triggerData
    * @returns Promise containing the workflow execution results
    */
   startAsync(params) {
-    return this.request(`/api/workflows/${this.workflowId}/startAsync?runId=${params.runId}`, {
+    const searchParams = new URLSearchParams();
+    if (!!params?.runId) {
+      searchParams.set("runId", params.runId);
+    }
+    return this.request(`/api/workflows/${this.workflowId}/start-async?${searchParams.toString()}`, {
       method: "POST",
       body: params?.triggerData
     });
@@ -443,7 +449,7 @@ var Workflow = class extends BaseResource {
    * @returns Promise containing the workflow resume results
    */
   resumeAsync(params) {
-    return this.request(`/api/workflows/${this.workflowId}/resumeAsync?runId=${params.runId}`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume-async?runId=${params.runId}`, {
       method: "POST",
       body: {
         stepId: params.stepId,
@@ -460,43 +466,34 @@ var Workflow = class extends BaseResource {
    */
   async *streamProcessor(stream) {
     const reader = stream.getReader();
+    let doneReading = false;
     let buffer = "";
     try {
-      while (true) {
+      while (!doneReading) {
         const { done, value } = await reader.read();
-        if (done) {
-          if (buffer.trim().length > 0) {
-            try {
-              const record = JSON.parse(buffer);
-              yield record;
-            } catch (e) {
-              console.warn("Could not parse final buffer content:", buffer);
+        doneReading = done;
+        if (done && !value) continue;
+        try {
+          const decoded = value ? new TextDecoder().decode(value) : "";
+          const chunks = (buffer + decoded).split(RECORD_SEPARATOR);
+          buffer = chunks.pop() || "";
+          for (const chunk of chunks) {
+            if (chunk) {
+              yield JSON.parse(chunk);
             }
           }
-          break;
+        } catch (error) {
         }
-        buffer += new TextDecoder().decode(value);
-        const records = buffer.split("");
-        buffer = records.pop() || "";
-        for (const record of records) {
-          if (record.trim().length > 0) {
-            try {
-              const parsedRecord = JSON.parse(record);
-              const isWorkflowCompleted = Object.values(parsedRecord?.activePaths || {}).every(
-                (path) => path.status === "completed" || path.status === "suspended" || path.status === "failed" || path.status === "skipped"
-              );
-              if (isWorkflowCompleted) {
-                reader.cancel();
-              }
-              yield parsedRecord;
-            } catch (e) {
-              throw new Error(`Could not parse record: ${record}, ${e}`);
-            }
-          }
+      }
+      if (buffer) {
+        try {
+          yield JSON.parse(buffer);
+        } catch {
         }
       }
     } finally {
-      reader.cancel();
+      reader.cancel().catch(() => {
+      });
     }
   }
   /**

package/dist/index.d.cts

@@ -51,6 +51,7 @@ interface GetWorkflowResponse {
     steps: Record<string, StepAction<any, any, any, any>>;
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
+    workflowId?: string;
 }
 type WorkflowRunResult = {
     activePaths: Record<string, {
@@ -339,6 +340,7 @@ declare class Workflow extends BaseResource {
      */
     details(): Promise<GetWorkflowResponse>;
     /**
+     * @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
@@ -380,11 +382,11 @@ declare class Workflow extends BaseResource {
     }>;
     /**
      * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-     * @param params - Object containing the runId and triggerData
+     * @param params - Object containing the optional runId and triggerData
      * @returns Promise containing the workflow execution results
      */
     startAsync(params: {
-        runId: string;
+        runId?: string;
         triggerData: Record<string, any>;
     }): Promise<WorkflowRunResult>;
     /**

package/dist/index.d.ts

@@ -51,6 +51,7 @@ interface GetWorkflowResponse {
     steps: Record<string, StepAction<any, any, any, any>>;
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
+    workflowId?: string;
 }
 type WorkflowRunResult = {
     activePaths: Record<string, {
@@ -339,6 +340,7 @@ declare class Workflow extends BaseResource {
      */
     details(): Promise<GetWorkflowResponse>;
     /**
+     * @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
@@ -380,11 +382,11 @@ declare class Workflow extends BaseResource {
     }>;
     /**
      * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-     * @param params - Object containing the runId and triggerData
+     * @param params - Object containing the optional runId and triggerData
      * @returns Promise containing the workflow execution results
      */
     startAsync(params: {
-        runId: string;
+        runId?: string;
         triggerData: Record<string, any>;
     }): Promise<WorkflowRunResult>;
     /**

package/dist/index.js

@@ -357,6 +357,7 @@ var Vector = class extends BaseResource {
 };
 
 // src/resources/workflow.ts
+var RECORD_SEPARATOR = "";
 var Workflow = class extends BaseResource {
   constructor(options, workflowId) {
     super(options);
@@ -370,6 +371,7 @@ var Workflow = class extends BaseResource {
     return this.request(`/api/workflows/${this.workflowId}`);
   }
   /**
+   * @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
@@ -426,11 +428,15 @@ var Workflow = class extends BaseResource {
   }
   /**
    * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-   * @param params - Object containing the runId and triggerData
+   * @param params - Object containing the optional runId and triggerData
    * @returns Promise containing the workflow execution results
    */
   startAsync(params) {
-    return this.request(`/api/workflows/${this.workflowId}/startAsync?runId=${params.runId}`, {
+    const searchParams = new URLSearchParams();
+    if (!!params?.runId) {
+      searchParams.set("runId", params.runId);
+    }
+    return this.request(`/api/workflows/${this.workflowId}/start-async?${searchParams.toString()}`, {
       method: "POST",
       body: params?.triggerData
     });
@@ -441,7 +447,7 @@ var Workflow = class extends BaseResource {
    * @returns Promise containing the workflow resume results
    */
   resumeAsync(params) {
-    return this.request(`/api/workflows/${this.workflowId}/resumeAsync?runId=${params.runId}`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume-async?runId=${params.runId}`, {
       method: "POST",
       body: {
         stepId: params.stepId,
@@ -458,43 +464,34 @@ var Workflow = class extends BaseResource {
    */
   async *streamProcessor(stream) {
     const reader = stream.getReader();
+    let doneReading = false;
     let buffer = "";
     try {
-      while (true) {
+      while (!doneReading) {
         const { done, value } = await reader.read();
-        if (done) {
-          if (buffer.trim().length > 0) {
-            try {
-              const record = JSON.parse(buffer);
-              yield record;
-            } catch (e) {
-              console.warn("Could not parse final buffer content:", buffer);
+        doneReading = done;
+        if (done && !value) continue;
+        try {
+          const decoded = value ? new TextDecoder().decode(value) : "";
+          const chunks = (buffer + decoded).split(RECORD_SEPARATOR);
+          buffer = chunks.pop() || "";
+          for (const chunk of chunks) {
+            if (chunk) {
+              yield JSON.parse(chunk);
             }
           }
-          break;
+        } catch (error) {
         }
-        buffer += new TextDecoder().decode(value);
-        const records = buffer.split("");
-        buffer = records.pop() || "";
-        for (const record of records) {
-          if (record.trim().length > 0) {
-            try {
-              const parsedRecord = JSON.parse(record);
-              const isWorkflowCompleted = Object.values(parsedRecord?.activePaths || {}).every(
-                (path) => path.status === "completed" || path.status === "suspended" || path.status === "failed" || path.status === "skipped"
-              );
-              if (isWorkflowCompleted) {
-                reader.cancel();
-              }
-              yield parsedRecord;
-            } catch (e) {
-              throw new Error(`Could not parse record: ${record}, ${e}`);
-            }
-          }
+      }
+      if (buffer) {
+        try {
+          yield JSON.parse(buffer);
+        } catch {
         }
       }
     } finally {
-      reader.cancel();
+      reader.cancel().catch(() => {
+      });
     }
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/client-js",
-  "version": "0.1.14-alpha.1",
+  "version": "0.1.14-alpha.3",
   "description": "The official TypeScript library for the Mastra Client API",
   "author": "",
   "type": "module",
@@ -26,11 +26,11 @@
     "json-schema": "^0.4.0",
     "zod": "^3.24.2",
     "zod-to-json-schema": "^3.24.3",
-    "@mastra/core": "^0.8.0-alpha.1"
+    "@mastra/core": "^0.8.0-alpha.3"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.26.9",
-    "@babel/preset-typescript": "^7.26.0",
+    "@babel/preset-typescript": "^7.27.0",
     "@tsconfig/recommended": "^1.0.8",
     "@types/json-schema": "^7.0.15",
     "@types/node": "^20.17.27",

package/src/index.test.ts

@@ -12,6 +12,7 @@ describe('MastraClient Resources', () => {
     baseUrl: 'http://localhost:4111',
     headers: {
       Authorization: 'Bearer test-key',
+      'x-mastra-client-type': 'js',
     },
   };
 
@@ -631,14 +632,14 @@ describe('MastraClient Resources', () => {
       };
       mockFetchResponse(mockResponse);
 
-      const result = await workflow.execute({ trigger: 'test' });
+      const result = await workflow.startAsync({ triggerData: { test: 'test' } });
       expect(result).toEqual(mockResponse);
       expect(global.fetch).toHaveBeenCalledWith(
-        `${clientOptions.baseUrl}/api/workflows/test-workflow/execute`,
+        `${clientOptions.baseUrl}/api/workflows/test-workflow/start-async?`,
         expect.objectContaining({
           method: 'POST',
           headers: expect.objectContaining(clientOptions.headers),
-          body: JSON.stringify({ trigger: 'test' }),
+          body: JSON.stringify({ test: 'test' }),
         }),
       );
     });

package/src/resources/workflow.ts

@@ -2,6 +2,8 @@ import type { GetWorkflowResponse, ClientOptions, WorkflowRunResult } from '../t
 
 import { BaseResource } from './base';
 
+const RECORD_SEPARATOR = '\x1E';
+
 export class Workflow extends BaseResource {
   constructor(
     options: ClientOptions,
@@ -19,6 +21,7 @@ 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
@@ -85,11 +88,17 @@ export class Workflow extends BaseResource {
 
   /**
    * Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
-   * @param params - Object containing the runId and triggerData
+   * @param params - Object containing the optional runId and triggerData
    * @returns Promise containing the workflow execution results
    */
-  startAsync(params: { runId: string; triggerData: Record<string, any> }): Promise<WorkflowRunResult> {
-    return this.request(`/api/workflows/${this.workflowId}/startAsync?runId=${params.runId}`, {
+  startAsync(params: { runId?: string; triggerData: Record<string, any> }): Promise<WorkflowRunResult> {
+    const searchParams = new URLSearchParams();
+
+    if (!!params?.runId) {
+      searchParams.set('runId', params.runId);
+    }
+
+    return this.request(`/api/workflows/${this.workflowId}/start-async?${searchParams.toString()}`, {
       method: 'POST',
       body: params?.triggerData,
     });
@@ -101,7 +110,7 @@ export class Workflow extends BaseResource {
    * @returns Promise containing the workflow resume results
    */
   resumeAsync(params: { runId: string; stepId: string; context: Record<string, any> }): Promise<WorkflowRunResult> {
-    return this.request(`/api/workflows/${this.workflowId}/resumeAsync?runId=${params.runId}`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume-async?runId=${params.runId}`, {
       method: 'POST',
       body: {
         stepId: params.stepId,
@@ -119,61 +128,57 @@ export class Workflow extends BaseResource {
    */
   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 (true) {
+      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);
 
-        if (done) {
-          // Process any remaining data in buffer before finishing
-          if (buffer.trim().length > 0) {
-            try {
-              const record = JSON.parse(buffer);
-              yield record;
-            } catch (e) {
-              console.warn('Could not parse final buffer content:', buffer);
+          // 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
+              yield JSON.parse(chunk);
             }
           }
-          break;
+        } catch (error) {
+          // Silently ignore parsing errors to maintain stream processing
+          // This allows the stream to continue even if one record is malformed
         }
+      }
 
-        // Decode and add to buffer
-        buffer += new TextDecoder().decode(value);
-
-        // Split the buffer into records
-        const records = buffer.split('\x1E');
-
-        // Keep the last (potentially incomplete) chunk in the buffer
-        buffer = records.pop() || '';
-
-        // Process each complete record
-        for (const record of records) {
-          if (record.trim().length > 0) {
-            try {
-              // Assuming the records are JSON strings
-              const parsedRecord = JSON.parse(record);
-
-              //Check to see if all steps are completed and cancel reader
-              const isWorkflowCompleted = Object.values(parsedRecord?.activePaths || {}).every(
-                (path: any) =>
-                  path.status === 'completed' ||
-                  path.status === 'suspended' ||
-                  path.status === 'failed' ||
-                  path.status === 'skipped',
-              );
-              if (isWorkflowCompleted) {
-                reader.cancel();
-              }
-              yield parsedRecord;
-            } catch (e) {
-              throw new Error(`Could not parse record: ${record}, ${e}`);
-            }
-          }
+      // 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 {
-      reader.cancel();
+      // Always ensure we clean up the reader
+      reader.cancel().catch(() => {
+        // Ignore cancel errors
+      });
     }
   }
 

package/src/types.ts

@@ -69,6 +69,7 @@ export interface GetWorkflowResponse {
   steps: Record<string, StepAction<any, any, any, any>>;
   stepGraph: StepGraph;
   stepSubscriberGraph: Record<string, StepGraph>;
+  workflowId?: string;
 }
 
 export type WorkflowRunResult = {