@mastra/client-js 0.1.6 → 0.1.7-alpha.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @mastra/client-js@0.1.6-alpha.0 build /home/runner/work/mastra/mastra/client-sdks/client-js
+> @mastra/client-js@0.1.7-alpha.0 build /home/runner/work/mastra/mastra/client-sdks/client-js
 > tsup src/index.ts --format esm,cjs --dts --clean --treeshake
 
 CLI Building entry: src/index.ts
@@ -9,11 +9,11 @@
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.js 13.86 KB
-ESM ⚡️ Build success in 408ms
-CJS dist/index.cjs 13.96 KB
-CJS ⚡️ Build success in 594ms
+CJS dist/index.cjs 15.48 KB
+CJS ⚡️ Build success in 942ms
+ESM dist/index.js 15.38 KB
+ESM ⚡️ Build success in 944ms
 DTS Build start
-DTS ⚡️ Build success in 9964ms
-DTS dist/index.d.ts  13.64 KB
-DTS dist/index.d.cts 13.64 KB
+DTS ⚡️ Build success in 11611ms
+DTS dist/index.d.ts  14.44 KB
+DTS dist/index.d.cts 14.44 KB

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @mastra/client-js
 
+## 0.1.7-alpha.0
+
+### Patch Changes
+
+- 960690d: Improve client-js workflow watch dx
+- Updated dependencies [59df7b6]
+- Updated dependencies [29f3a82]
+- Updated dependencies [59df7b6]
+- Updated dependencies [c139344]
+  - @mastra/core@0.5.0-alpha.0
+
 ## 0.1.6
 
 ### Patch Changes

package/dist/index.cjs

@@ -287,14 +287,63 @@ var Workflow = class extends BaseResource {
       }
     });
   }
+  /**
+   * 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
+   */
+  async *streamProcessor(stream) {
+    const reader = stream.getReader();
+    let buffer = "";
+    try {
+      while (true) {
+        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);
+            }
+          }
+          break;
+        }
+        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);
+              yield parsedRecord;
+            } catch (e) {
+              throw new Error(`Could not parse record: ${record}`);
+            }
+          }
+        }
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
   /**
    * Watches workflow transitions in real-time
-   * @returns Promise containing the workflow watch stream
+   * @returns AsyncGenerator that yields parsed records from the workflow watch stream
    */
-  watch() {
-    return this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch() {
+    const response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
       stream: true
     });
+    if (!response.ok) {
+      throw new Error(`Failed to watch workflow: ${response.statusText}`);
+    }
+    if (!response.body) {
+      throw new Error("Response body is null");
+    }
+    yield* this.streamProcessor(response.body);
   }
 };
 

package/dist/index.d.cts

@@ -50,6 +50,22 @@ interface GetWorkflowResponse {
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
 }
+type GetWorkflowWatchResponse = {
+    activePaths: Array<{
+        stepId: string;
+        stepPath: string[];
+        status: 'completed' | 'suspended' | 'pending';
+    }>;
+    context: {
+        steps: Record<string, {
+            status: 'completed' | 'suspended' | 'running';
+            [key: string]: any;
+        }>;
+    };
+    timestamp: number;
+    suspendedSteps: Record<string, any>;
+    runId: string;
+};
 interface UpsertVectorParams {
     indexName: string;
     vectors: number[][];
@@ -274,11 +290,19 @@ declare class Workflow extends BaseResource {
         runId: string;
         context: Record<string, any>;
     }): Promise<Record<string, any>>;
+    /**
+     * 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 streamProcessor;
     /**
      * Watches workflow transitions in real-time
-     * @returns Promise containing the workflow watch stream
+     * @returns AsyncGenerator that yields parsed records from the workflow watch stream
      */
-    watch(): Promise<Response>;
+    watch(): AsyncGenerator<GetWorkflowWatchResponse, void, unknown>;
 }
 
 declare class Tool extends BaseResource {
@@ -398,4 +422,4 @@ declare class MastraClient extends BaseResource {
     getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse>;
 }
 
-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 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 };
+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 GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowWatchResponse, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams };

package/dist/index.d.ts

@@ -50,6 +50,22 @@ interface GetWorkflowResponse {
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
 }
+type GetWorkflowWatchResponse = {
+    activePaths: Array<{
+        stepId: string;
+        stepPath: string[];
+        status: 'completed' | 'suspended' | 'pending';
+    }>;
+    context: {
+        steps: Record<string, {
+            status: 'completed' | 'suspended' | 'running';
+            [key: string]: any;
+        }>;
+    };
+    timestamp: number;
+    suspendedSteps: Record<string, any>;
+    runId: string;
+};
 interface UpsertVectorParams {
     indexName: string;
     vectors: number[][];
@@ -274,11 +290,19 @@ declare class Workflow extends BaseResource {
         runId: string;
         context: Record<string, any>;
     }): Promise<Record<string, any>>;
+    /**
+     * 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 streamProcessor;
     /**
      * Watches workflow transitions in real-time
-     * @returns Promise containing the workflow watch stream
+     * @returns AsyncGenerator that yields parsed records from the workflow watch stream
      */
-    watch(): Promise<Response>;
+    watch(): AsyncGenerator<GetWorkflowWatchResponse, void, unknown>;
 }
 
 declare class Tool extends BaseResource {
@@ -398,4 +422,4 @@ declare class MastraClient extends BaseResource {
     getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse>;
 }
 
-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 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 };
+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 GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowWatchResponse, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams };

package/dist/index.js

@@ -285,14 +285,63 @@ var Workflow = class extends BaseResource {
       }
     });
   }
+  /**
+   * 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
+   */
+  async *streamProcessor(stream) {
+    const reader = stream.getReader();
+    let buffer = "";
+    try {
+      while (true) {
+        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);
+            }
+          }
+          break;
+        }
+        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);
+              yield parsedRecord;
+            } catch (e) {
+              throw new Error(`Could not parse record: ${record}`);
+            }
+          }
+        }
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
   /**
    * Watches workflow transitions in real-time
-   * @returns Promise containing the workflow watch stream
+   * @returns AsyncGenerator that yields parsed records from the workflow watch stream
    */
-  watch() {
-    return this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch() {
+    const response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
       stream: true
     });
+    if (!response.ok) {
+      throw new Error(`Failed to watch workflow: ${response.statusText}`);
+    }
+    if (!response.body) {
+      throw new Error("Response body is null");
+    }
+    yield* this.streamProcessor(response.body);
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/client-js",
-  "version": "0.1.6",
+  "version": "0.1.7-alpha.0",
   "description": "The official TypeScript library for the Mastra Client API",
   "author": "",
   "type": "module",
@@ -25,7 +25,7 @@
     "json-schema": "^0.4.0",
     "zod": "^3.24.1",
     "zod-to-json-schema": "^3.24.1",
-    "@mastra/core": "^0.4.4"
+    "@mastra/core": "^0.5.0-alpha.0"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.26.0",

package/src/example.ts

@@ -1,43 +1,66 @@
 import { MastraClient } from './client';
 
-(async () => {
-  const client = new MastraClient({
-    baseUrl: 'http://localhost:4111',
-  });
-
-  try {
-    const agent = client.getAgent('weatherAgent');
-    const response = await agent.stream({
-      messages: [
-        {
-          role: 'user',
-          content: 'Hello, world!',
-        },
-      ],
-    });
-
-    const reader = response?.body?.getReader();
-    const decoder = new TextDecoder();
-    let buffer = '';
-
-    while (true) {
-      if (!reader) break;
-      const { value, done } = await reader.read();
-      if (done) break;
-
-      const chunk = decoder.decode(value);
-      buffer += chunk;
-
-      console.log(buffer);
-
-      const matches = buffer.matchAll(/0:"([^"]*)"/g);
-
-      for (const match of matches) {
-        const content = match[1];
-        process.stdout.write(`${content}\n`);
-      }
-    }
-  } catch (error) {
-    console.error(error);
-  }
-})();
+// Agent
+
+// (async () => {
+//   const client = new MastraClient({
+//     baseUrl: 'http://localhost:4111',
+//   });
+
+//   try {
+//     const agent = client.getAgent('weatherAgent');
+//     const response = await agent.stream({
+//       messages: [
+//         {
+//           role: 'user',
+//           content: 'Hello, world!',
+//         },
+//       ],
+//     });
+
+//     const reader = response?.body?.getReader();
+//     const decoder = new TextDecoder();
+//     let buffer = '';
+
+//     while (true) {
+//       if (!reader) break;
+//       const { value, done } = await reader.read();
+//       if (done) break;
+
+//       const chunk = decoder.decode(value);
+//       buffer += chunk;
+
+//       console.log(buffer);
+
+//       const matches = buffer.matchAll(/0:"([^"]*)"/g);
+
+//       for (const match of matches) {
+//         const content = match[1];
+//         process.stdout.write(`${content}\n`);
+//       }
+//     }
+//   } catch (error) {
+//     console.error(error);
+//   }
+// })();
+
+// Workflow
+
+// (async () => {
+//   const client = new MastraClient({
+//     baseUrl: 'http://localhost:4111',
+//   });
+
+//   const workflowId = 'weatherWorkflow';
+
+//   const workflow = client.getWorkflow(workflowId);
+//   const response = workflow.watch();
+
+//   workflow.execute({
+//     city: 'New York',
+//   });
+
+//   for await (const record of response) {
+//     console.log(new Date().toTimeString(), record);
+//   }
+// })();

package/src/resources/workflow.ts

@@ -1,4 +1,4 @@
-import type { GetWorkflowResponse, ClientOptions } from '../types';
+import type { GetWorkflowResponse, ClientOptions, GetWorkflowWatchResponse } from '../types';
 
 import { BaseResource } from './base';
 
@@ -56,13 +56,78 @@ export class Workflow extends BaseResource {
     });
   }
 
+  /**
+   * 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<GetWorkflowWatchResponse, void, unknown> {
+    const reader = stream.getReader();
+    let buffer = '';
+
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+
+        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);
+            }
+          }
+          break;
+        }
+
+        // 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);
+              yield parsedRecord;
+            } catch (e) {
+              throw new Error(`Could not parse record: ${record}`);
+            }
+          }
+        }
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
+
   /**
    * Watches workflow transitions in real-time
-   * @returns Promise containing the workflow watch stream
+   * @returns AsyncGenerator that yields parsed records from the workflow watch stream
    */
-  watch(): Promise<Response> {
-    return this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch() {
+    const response: Response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
       stream: true,
     });
+
+    if (!response.ok) {
+      throw new Error(`Failed to watch workflow: ${response.statusText}`);
+    }
+
+    if (!response.body) {
+      throw new Error('Response body is null');
+    }
+
+    yield* this.streamProcessor(response.body);
   }
 }

package/src/types.ts

@@ -69,6 +69,26 @@ export interface GetWorkflowResponse {
   stepSubscriberGraph: Record<string, StepGraph>;
 }
 
+export type GetWorkflowWatchResponse = {
+  activePaths: Array<{
+    stepId: string;
+    stepPath: string[];
+    status: 'completed' | 'suspended' | 'pending';
+  }>;
+  context: {
+    steps: Record<
+      string,
+      {
+        status: 'completed' | 'suspended' | 'running';
+        [key: string]: any;
+      }
+    >;
+  };
+  timestamp: number;
+  suspendedSteps: Record<string, any>;
+  runId: string;
+};
+
 export interface UpsertVectorParams {
   indexName: string;
   vectors: number[][];