@mastra/client-js 0.1.7-alpha.9 → 0.1.8-alpha.0

package/.turbo/turbo-build.log

@@ -1,19 +1,19 @@
 
-> @mastra/client-js@0.1.7-alpha.9 build /home/runner/work/mastra/mastra/client-sdks/client-js
-> tsup src/index.ts --format esm,cjs --dts --clean --treeshake
+> @mastra/client-js@0.1.8-alpha.0 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
 CLI Using tsconfig: tsconfig.json
-CLI tsup v8.3.6
+CLI tsup v8.4.0
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 15.48 KB
-CJS ⚡️ Build success in 660ms
-ESM dist/index.js 15.38 KB
-ESM ⚡️ Build success in 661ms
+ESM dist/index.js 16.00 KB
+ESM ⚡️ Build success in 491ms
+CJS dist/index.cjs 16.09 KB
+CJS ⚡️ Build success in 683ms
 DTS Build start
-DTS ⚡️ Build success in 9871ms
-DTS dist/index.d.ts  14.44 KB
-DTS dist/index.d.cts 14.44 KB
+DTS ⚡️ Build success in 10443ms
+DTS dist/index.d.ts  14.79 KB
+DTS dist/index.d.cts 14.79 KB

package/CHANGELOG.md

@@ -1,5 +1,85 @@
 # @mastra/client-js
 
+## 0.1.8-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [3729dbd]
+  - @mastra/core@0.5.1-alpha.0
+
+## 0.1.7
+
+### Patch Changes
+
+- 960690d: Improve client-js workflow watch dx
+- 8deb34c: Better workflow watch api + watch workflow by runId
+- fd4a1d7: Update cjs bundling to make sure files are split
+- Updated dependencies [a910463]
+- Updated dependencies [59df7b6]
+- Updated dependencies [22643eb]
+- Updated dependencies [6feb23f]
+- Updated dependencies [f2d6727]
+- Updated dependencies [7a7a547]
+- Updated dependencies [29f3a82]
+- Updated dependencies [3d0e290]
+- Updated dependencies [e9fbac5]
+- Updated dependencies [301e4ee]
+- Updated dependencies [ee667a2]
+- Updated dependencies [dfbe4e9]
+- Updated dependencies [dab255b]
+- Updated dependencies [1e8bcbc]
+- Updated dependencies [f6678e4]
+- Updated dependencies [9e81f35]
+- Updated dependencies [c93798b]
+- Updated dependencies [a85ab24]
+- Updated dependencies [dbd9f2d]
+- Updated dependencies [59df7b6]
+- Updated dependencies [caefaa2]
+- Updated dependencies [c151ae6]
+- Updated dependencies [52e0418]
+- Updated dependencies [d79aedf]
+- Updated dependencies [03236ec]
+- Updated dependencies [3764e71]
+- Updated dependencies [df982db]
+- Updated dependencies [a171b37]
+- Updated dependencies [506f1d5]
+- Updated dependencies [02ffb7b]
+- Updated dependencies [0461849]
+- Updated dependencies [2259379]
+- Updated dependencies [aeb5e36]
+- Updated dependencies [f2301de]
+- Updated dependencies [358f069]
+- Updated dependencies [fd4a1d7]
+- Updated dependencies [c139344]
+  - @mastra/core@0.5.0
+
+## 0.1.7-alpha.12
+
+### Patch Changes
+
+- Updated dependencies [a85ab24]
+  - @mastra/core@0.5.0-alpha.12
+
+## 0.1.7-alpha.11
+
+### Patch Changes
+
+- 8deb34c: Better workflow watch api + watch workflow by runId
+- fd4a1d7: Update cjs bundling to make sure files are split
+- Updated dependencies [7a7a547]
+- Updated dependencies [c93798b]
+- Updated dependencies [dbd9f2d]
+- Updated dependencies [a171b37]
+- Updated dependencies [fd4a1d7]
+  - @mastra/core@0.5.0-alpha.11
+
+## 0.1.7-alpha.10
+
+### Patch Changes
+
+- Updated dependencies [a910463]
+  - @mastra/core@0.5.0-alpha.10
+
 ## 0.1.7-alpha.9
 
 ### Patch Changes

package/README.md

@@ -79,9 +79,10 @@ const client = new MastraClient({
 - `getWorkflows()`: Get all workflows
 - `getWorkflow(workflowId)`: Get a workflow instance
   - `workflow.details()`: Get workflow details
-  - `workflow.execute(params)`: Execute the workflow
-  - `workflow.watch(params)`: Watch the workflow
-  - `workflow.resume(params)`: Resume the workflow
+  - `workflow.execute(params)`: Execute the workflow and wait for execution results
+  - `workflow.startRun()`: Start a new workflow run
+  - `workflow.watch(params)`: Watch the workflow run
+  - `workflow.resume(params)`: Resume the workflow run
 
 ### Vectors
 

package/dist/index.cjs

@@ -266,6 +266,17 @@ var Workflow = class extends BaseResource {
       body: params
     });
   }
+  /**
+   * Creates a new workflow run instance and starts it
+   * @param params - Parameters required for the workflow run
+   * @returns Promise containing the generated run ID
+   */
+  startRun(params) {
+    return this.request(`/api/workflows/${this.workflowId}/startRun`, {
+      method: "POST",
+      body: params
+    });
+  }
   /**
    * Resumes a suspended workflow step
    * @param stepId - ID of the step to resume
@@ -278,11 +289,10 @@ var Workflow = class extends BaseResource {
     runId,
     context
   }) {
-    return this.request(`/api/workflows/${this.workflowId}/resume`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume?runId=${runId}`, {
       method: "POST",
       body: {
         stepId,
-        runId,
         context
       }
     });
@@ -318,6 +328,12 @@ var Workflow = class extends BaseResource {
           if (record.trim().length > 0) {
             try {
               const parsedRecord = JSON.parse(record);
+              const isWorkflowCompleted = parsedRecord?.activePaths?.every(
+                (path) => path.status === "completed" || path.status === "suspended" || path.status === "failed"
+              );
+              if (isWorkflowCompleted) {
+                reader.cancel();
+              }
               yield parsedRecord;
             } catch (e) {
               throw new Error(`Could not parse record: ${record}`);
@@ -326,15 +342,16 @@ var Workflow = class extends BaseResource {
         }
       }
     } finally {
-      reader.releaseLock();
+      reader.cancel();
     }
   }
   /**
    * 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() {
-    const response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch({ runId }) {
+    const response = await this.request(`/api/workflows/${this.workflowId}/watch?runId=${runId}`, {
       stream: true
     });
     if (!response.ok) {
@@ -504,9 +521,6 @@ var MastraClient = class extends BaseResource {
   getTelemetry(params) {
     const { name, scope, page, perPage, attribute } = params || {};
     const _attribute = attribute ? Object.entries(attribute).map(([key, value]) => `${key}:${value}`) : [];
-    ({
-      ..._attribute?.length ? { attribute: _attribute } : {}
-    });
     const searchParams = new URLSearchParams();
     if (name) {
       searchParams.set("name", name);

package/dist/index.d.cts

@@ -50,7 +50,7 @@ interface GetWorkflowResponse {
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
 }
-type GetWorkflowWatchResponse = {
+type WorkflowRunResult = {
     activePaths: Array<{
         stepId: string;
         stepPath: string[];
@@ -277,7 +277,15 @@ declare class Workflow extends BaseResource {
      * @param params - Parameters required for workflow execution
      * @returns Promise containing the workflow execution results
      */
-    execute(params: Record<string, any>): Promise<Record<string, any>>;
+    execute(params: Record<string, any>): Promise<WorkflowRunResult>;
+    /**
+     * Creates a new workflow run instance and starts it
+     * @param params - Parameters required for the workflow run
+     * @returns Promise containing the generated run ID
+     */
+    startRun(params: Record<string, any>): Promise<{
+        runId: string;
+    }>;
     /**
      * Resumes a suspended workflow step
      * @param stepId - ID of the step to resume
@@ -300,9 +308,12 @@ declare class Workflow extends BaseResource {
     private streamProcessor;
     /**
      * 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
      */
-    watch(): AsyncGenerator<GetWorkflowWatchResponse, void, unknown>;
+    watch({ runId }: {
+        runId?: string;
+    }): AsyncGenerator<WorkflowRunResult, void, unknown>;
 }
 
 declare class Tool extends BaseResource {
@@ -422,4 +433,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, type GetWorkflowWatchResponse, 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, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult };

package/dist/index.d.ts

@@ -50,7 +50,7 @@ interface GetWorkflowResponse {
     stepGraph: StepGraph;
     stepSubscriberGraph: Record<string, StepGraph>;
 }
-type GetWorkflowWatchResponse = {
+type WorkflowRunResult = {
     activePaths: Array<{
         stepId: string;
         stepPath: string[];
@@ -277,7 +277,15 @@ declare class Workflow extends BaseResource {
      * @param params - Parameters required for workflow execution
      * @returns Promise containing the workflow execution results
      */
-    execute(params: Record<string, any>): Promise<Record<string, any>>;
+    execute(params: Record<string, any>): Promise<WorkflowRunResult>;
+    /**
+     * Creates a new workflow run instance and starts it
+     * @param params - Parameters required for the workflow run
+     * @returns Promise containing the generated run ID
+     */
+    startRun(params: Record<string, any>): Promise<{
+        runId: string;
+    }>;
     /**
      * Resumes a suspended workflow step
      * @param stepId - ID of the step to resume
@@ -300,9 +308,12 @@ declare class Workflow extends BaseResource {
     private streamProcessor;
     /**
      * 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
      */
-    watch(): AsyncGenerator<GetWorkflowWatchResponse, void, unknown>;
+    watch({ runId }: {
+        runId?: string;
+    }): AsyncGenerator<WorkflowRunResult, void, unknown>;
 }
 
 declare class Tool extends BaseResource {
@@ -422,4 +433,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, type GetWorkflowWatchResponse, 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, MastraClient, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult };

package/dist/index.js

@@ -264,6 +264,17 @@ var Workflow = class extends BaseResource {
       body: params
     });
   }
+  /**
+   * Creates a new workflow run instance and starts it
+   * @param params - Parameters required for the workflow run
+   * @returns Promise containing the generated run ID
+   */
+  startRun(params) {
+    return this.request(`/api/workflows/${this.workflowId}/startRun`, {
+      method: "POST",
+      body: params
+    });
+  }
   /**
    * Resumes a suspended workflow step
    * @param stepId - ID of the step to resume
@@ -276,11 +287,10 @@ var Workflow = class extends BaseResource {
     runId,
     context
   }) {
-    return this.request(`/api/workflows/${this.workflowId}/resume`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume?runId=${runId}`, {
       method: "POST",
       body: {
         stepId,
-        runId,
         context
       }
     });
@@ -316,6 +326,12 @@ var Workflow = class extends BaseResource {
           if (record.trim().length > 0) {
             try {
               const parsedRecord = JSON.parse(record);
+              const isWorkflowCompleted = parsedRecord?.activePaths?.every(
+                (path) => path.status === "completed" || path.status === "suspended" || path.status === "failed"
+              );
+              if (isWorkflowCompleted) {
+                reader.cancel();
+              }
               yield parsedRecord;
             } catch (e) {
               throw new Error(`Could not parse record: ${record}`);
@@ -324,15 +340,16 @@ var Workflow = class extends BaseResource {
         }
       }
     } finally {
-      reader.releaseLock();
+      reader.cancel();
     }
   }
   /**
    * 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() {
-    const response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch({ runId }) {
+    const response = await this.request(`/api/workflows/${this.workflowId}/watch?runId=${runId}`, {
       stream: true
     });
     if (!response.ok) {
@@ -502,9 +519,6 @@ var MastraClient = class extends BaseResource {
   getTelemetry(params) {
     const { name, scope, page, perPage, attribute } = params || {};
     const _attribute = attribute ? Object.entries(attribute).map(([key, value]) => `${key}:${value}`) : [];
-    ({
-      ..._attribute?.length ? { attribute: _attribute } : {}
-    });
     const searchParams = new URLSearchParams();
     if (name) {
       searchParams.set("name", name);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/client-js",
-  "version": "0.1.7-alpha.9",
+  "version": "0.1.8-alpha.0",
   "description": "The official TypeScript library for the Mastra Client API",
   "author": "",
   "type": "module",
@@ -23,23 +23,23 @@
   "license": "ISC",
   "dependencies": {
     "json-schema": "^0.4.0",
-    "zod": "^3.24.1",
-    "zod-to-json-schema": "^3.24.1",
-    "@mastra/core": "^0.5.0-alpha.9"
+    "zod": "^3.24.2",
+    "zod-to-json-schema": "^3.24.3",
+    "@mastra/core": "^0.5.1-alpha.0"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-env": "^7.26.9",
     "@babel/preset-typescript": "^7.26.0",
-    "@tsconfig/recommended": "^1.0.7",
+    "@tsconfig/recommended": "^1.0.8",
     "@types/json-schema": "^7.0.15",
-    "@types/node": "^22.9.0",
-    "tsup": "^8.0.1",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.4",
-    "@internal/lint": "0.0.0"
+    "@types/node": "^22.13.10",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.8",
+    "@internal/lint": "0.0.1"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --clean --treeshake",
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean --treeshake=smallest --splitting",
     "dev": "pnpm build --watch",
     "test": "vitest run"
   }

package/src/example.ts

@@ -1,4 +1,5 @@
 import { MastraClient } from './client';
+import type { WorkflowRunResult } from './types';
 
 // Agent
 
@@ -51,16 +52,25 @@ import { MastraClient } from './client';
 //     baseUrl: 'http://localhost:4111',
 //   });
 
-//   const workflowId = 'weatherWorkflow';
+//   let finalWorkflowResult: WorkflowRunResult | null = null;
 
-//   const workflow = client.getWorkflow(workflowId);
-//   const response = workflow.watch();
+//   try{
+//     const workflowId = 'weatherWorkflow';
 
-//   workflow.execute({
-//     city: 'New York',
-//   });
+//     const workflow = client.getWorkflow(workflowId);
+
+//     const {runId} = await workflow.startRun({
+//       city: 'New York',
+//     });
 
-//   for await (const record of response) {
-//     console.log(new Date().toTimeString(), record);
+//     for await (const record of workflow.watch({runId})) {
+//       console.log(new Date().toTimeString(), record);
+//       finalWorkflowResult = record;
+//     }
+//   }catch(e){
+//     console.log(e);
+//   }finally{
+//     console.log('Done')
+//     console.log({finalWorkflowResult});
 //   }
 // })();

package/src/resources/workflow.ts

@@ -1,4 +1,4 @@
-import type { GetWorkflowResponse, ClientOptions, GetWorkflowWatchResponse } from '../types';
+import type { GetWorkflowResponse, ClientOptions, WorkflowRunResult } from '../types';
 
 import { BaseResource } from './base';
 
@@ -23,13 +23,25 @@ export class Workflow extends BaseResource {
    * @param params - Parameters required for workflow execution
    * @returns Promise containing the workflow execution results
    */
-  execute(params: Record<string, any>): Promise<Record<string, any>> {
+  execute(params: Record<string, any>): Promise<WorkflowRunResult> {
     return this.request(`/api/workflows/${this.workflowId}/execute`, {
       method: 'POST',
       body: params,
     });
   }
 
+  /**
+   * Creates a new workflow run instance and starts it
+   * @param params - Parameters required for the workflow run
+   * @returns Promise containing the generated run ID
+   */
+  startRun(params: Record<string, any>): Promise<{ runId: string }> {
+    return this.request(`/api/workflows/${this.workflowId}/startRun`, {
+      method: 'POST',
+      body: params,
+    });
+  }
+
   /**
    * Resumes a suspended workflow step
    * @param stepId - ID of the step to resume
@@ -46,11 +58,10 @@ export class Workflow extends BaseResource {
     runId: string;
     context: Record<string, any>;
   }): Promise<Record<string, any>> {
-    return this.request(`/api/workflows/${this.workflowId}/resume`, {
+    return this.request(`/api/workflows/${this.workflowId}/resume?runId=${runId}`, {
       method: 'POST',
       body: {
         stepId,
-        runId,
         context,
       },
     });
@@ -63,7 +74,7 @@ export class Workflow extends BaseResource {
    * @param stream - The readable stream to process
    * @returns An async generator that yields parsed records
    */
-  private async *streamProcessor(stream: ReadableStream): AsyncGenerator<GetWorkflowWatchResponse, void, unknown> {
+  private async *streamProcessor(stream: ReadableStream): AsyncGenerator<WorkflowRunResult, void, unknown> {
     const reader = stream.getReader();
     let buffer = '';
 
@@ -99,6 +110,14 @@ export class Workflow extends BaseResource {
             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 = parsedRecord?.activePaths?.every(
+                (path: any) => path.status === 'completed' || path.status === 'suspended' || path.status === 'failed',
+              );
+              if (isWorkflowCompleted) {
+                reader.cancel();
+              }
               yield parsedRecord;
             } catch (e) {
               throw new Error(`Could not parse record: ${record}`);
@@ -107,16 +126,17 @@ export class Workflow extends BaseResource {
         }
       }
     } finally {
-      reader.releaseLock();
+      reader.cancel();
     }
   }
 
   /**
    * 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() {
-    const response: Response = await this.request(`/api/workflows/${this.workflowId}/watch`, {
+  async *watch({ runId }: { runId?: string }) {
+    const response: Response = await this.request(`/api/workflows/${this.workflowId}/watch?runId=${runId}`, {
       stream: true,
     });
 

package/src/types.ts

@@ -69,7 +69,7 @@ export interface GetWorkflowResponse {
   stepSubscriberGraph: Record<string, StepGraph>;
 }
 
-export type GetWorkflowWatchResponse = {
+export type WorkflowRunResult = {
   activePaths: Array<{
     stepId: string;
     stepPath: string[];