@mastra/client-js 0.1.0-alpha.17 → 0.1.0-alpha.18

package/.turbo/turbo-build.log

@@ -0,0 +1,15 @@
+
+> @mastra/client-js@0.1.0-alpha.18 build /home/runner/work/mastra/mastra/client-sdks/client-js
+> tsup-node src/index.ts --format esm --dts --clean --treeshake
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.3.6
+CLI Target: es2022
+CLI Cleaning output folder
+ESM Build start
+ESM dist/index.mjs 13.06 KB
+ESM ⚡️ Build success in 617ms
+DTS Build start
+DTS ⚡️ Build success in 9243ms
+DTS dist/index.d.mts 13.46 KB

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @mastra/client-js
+
+## 0.1.0-alpha.18
+
+### Patch Changes
+
+- b9ef5fd: Add workflow watch and resume to client sdk

package/README.md

@@ -15,20 +15,20 @@ import { MastraClient } from '@mastra/client';
 
 // Initialize the client
 const client = new MastraClient({
-    baseUrl: 'http://localhost:4111',  // Your Mastra API endpoint
+  baseUrl: 'http://localhost:4111', // Your Mastra API endpoint
 });
 
 // Example: Working with an Agent
 async function main() {
-    // Get an agent instance
-    const agent = client.getAgent('your-agent-id');
-    
-    // Generate a response
-    const response = await agent.generate({
-        messages: [{ role: 'user', content: "What's the weather like today?" }],
-    });
-    
-    console.log(response);
+  // Get an agent instance
+  const agent = client.getAgent('your-agent-id');
+
+  // Generate a response
+  const response = await agent.generate({
+    messages: [{ role: 'user', content: "What's the weather like today?" }],
+  });
+
+  console.log(response);
 }
 ```
 
@@ -49,6 +49,7 @@ const client = new MastraClient({
 ## Available Methods
 
 ### Agents
+
 - `getAgents()`: Get all available agents
 - `getAgent(agentId)`: Get a specific agent instance
   - `agent.details()`: Get agent details
@@ -59,6 +60,7 @@ const client = new MastraClient({
   - `agent.liveEvals()`: Get live evaluations
 
 ### Memory
+
 - `getMemoryThreads(params)`: Get memory threads
 - `createMemoryThread(params)`: Create a new memory thread
 - `getMemoryThread(threadId)`: Get a memory thread instance
@@ -66,18 +68,23 @@ const client = new MastraClient({
 - `getMemoryStatus()`: Get memory system status
 
 ### Tools
+
 - `getTools()`: Get all available tools
 - `getTool(toolId)`: Get a tool instance
   - `tool.details()`: Get tool details
   - `tool.execute(params)`: Execute the tool
 
 ### Workflows
+
 - `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
 
 ### Vectors
+
 - `getVector(vectorName)`: Get a vector instance
   - `vector.details(indexName)`: Get vector index details
   - `vector.delete(indexName)`: Delete a vector index
@@ -87,15 +94,18 @@ const client = new MastraClient({
   - `vector.query(params)`: Query vectors
 
 ### Logs
+
 - `getLogs(params)`: Get system logs
 - `getLog(params)`: Get specific log entry
 
 ### Telemetry
+
 - `getTelemetry(params)`: Get telemetry data
 
 ## Error Handling
 
 The client includes built-in retry logic for failed requests:
+
 - Automatically retries failed requests with exponential backoff
 - Configurable retry count and backoff timing
 - Throws error after max retries reached
@@ -103,6 +113,7 @@ The client includes built-in retry logic for failed requests:
 ## Internal Implementation
 
 The client uses the native `fetch` API internally for making HTTP requests. All requests are automatically handled with:
+
 - JSON serialization/deserialization
 - Retry logic with exponential backoff
 - Custom header management

package/dist/index.d.mts

@@ -266,6 +266,23 @@ declare class Workflow extends BaseResource {
      * @returns Promise containing the workflow execution results
      */
     execute(params: Record<string, any>): Promise<Record<string, any>>;
+    /**
+     * Resumes a suspended workflow step
+     * @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
+     */
+    resume({ stepId, runId, context, }: {
+        stepId: string;
+        runId: string;
+        context: Record<string, any>;
+    }): Promise<Record<string, any>>;
+    /**
+     * Watches workflow transitions in real-time
+     * @returns Promise containing the workflow watch stream
+     */
+    watch(): Promise<Response>;
 }
 
 declare class Tool extends BaseResource {

package/dist/index.mjs

@@ -262,6 +262,36 @@ var Workflow = class extends BaseResource {
       body: params
     });
   }
+  /**
+   * Resumes a suspended workflow step
+   * @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
+   */
+  resume({
+    stepId,
+    runId,
+    context
+  }) {
+    return this.request(`/api/workflows/${this.workflowId}/resume`, {
+      method: "POST",
+      body: {
+        stepId,
+        runId,
+        context
+      }
+    });
+  }
+  /**
+   * Watches workflow transitions in real-time
+   * @returns Promise containing the workflow watch stream
+   */
+  watch() {
+    return this.request(`/api/workflows/${this.workflowId}/watch`, {
+      stream: true
+    });
+  }
 };
 
 // src/resources/tool.ts

package/eslint.config.js

@@ -0,0 +1,6 @@
+import { createConfig } from '@internal/lint/eslint';
+
+const config = await createConfig();
+
+/** @type {import("eslint").Linter.Config[]} */
+export default [...config];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/client-js",
-  "version": "0.1.0-alpha.17",
+  "version": "0.1.0-alpha.18",
   "description": "The official TypeScript library for the Mastra Client API",
   "author": "",
   "types": "dist/index.d.mts",
@@ -16,16 +16,11 @@
   },
   "repository": "github:mastra-ai/client-js",
   "license": "ISC",
-  "scripts": {
-    "build": "tsup-node src/index.ts --format esm --dts --clean --treeshake",
-    "dev": "tsup-node src/index.ts --format esm --dts --clean --treeshake --watch",
-    "test": "vitest run"
-  },
   "dependencies": {
-    "@mastra/core": "^0.2.0-alpha.83",
     "json-schema": "^0.4.0",
     "zod": "^3.24.1",
-    "zod-to-json-schema": "^3.24.1"
+    "zod-to-json-schema": "^3.24.1",
+    "@mastra/core": "^0.2.1"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.26.0",
@@ -35,6 +30,12 @@
     "@types/node": "^22.9.0",
     "tsup": "^8.0.1",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.4",
+    "@internal/lint": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsup-node src/index.ts --format esm --dts --clean --treeshake",
+    "dev": "tsup-node src/index.ts --format esm --dts --clean --treeshake --watch",
+    "test": "vitest run"
   }
-}
+}

package/src/client.ts

@@ -1,158 +1,173 @@
-import type { ClientOptions, CreateMemoryThreadParams, CreateMemoryThreadResponse, GetAgentResponse, GetLogParams, GetLogsParams, GetLogsResponse, GetMemoryThreadParams, GetMemoryThreadResponse, GetTelemetryParams, GetTelemetryResponse, GetToolResponse, GetWorkflowResponse, RequestOptions, SaveMessageToMemoryParams, SaveMessageToMemoryResponse } from './types';
 import { Agent, MemoryThread, Tool, Workflow, Vector, BaseResource } from './resources';
+import type {
+  ClientOptions,
+  CreateMemoryThreadParams,
+  CreateMemoryThreadResponse,
+  GetAgentResponse,
+  GetLogParams,
+  GetLogsParams,
+  GetLogsResponse,
+  GetMemoryThreadParams,
+  GetMemoryThreadResponse,
+  GetTelemetryParams,
+  GetTelemetryResponse,
+  GetToolResponse,
+  GetWorkflowResponse,
+  RequestOptions,
+  SaveMessageToMemoryParams,
+  SaveMessageToMemoryResponse,
+} from './types';
 
 export class MastraClient extends BaseResource {
-
-    constructor(options: ClientOptions) {
-        super(options);
-    }
-
-
-    /**
-     * Retrieves all available agents
-     * @returns Promise containing map of agent IDs to agent details
-     */
-    public getAgents(): Promise<Record<string, GetAgentResponse>> {
-        return this.request('/api/agents');
-    }
-
-    /**
-     * Gets an agent instance by ID
-     * @param agentId - ID of the agent to retrieve
-     * @returns Agent instance
-     */
-    public getAgent(agentId: string) {
-        return new Agent(this.options, agentId);
-    }
-
-    /**
-     * Retrieves memory threads for a resource
-     * @param params - Parameters containing the resource ID
-     * @returns Promise containing array of memory threads
-     */
-    public getMemoryThreads(params: GetMemoryThreadParams): Promise<GetMemoryThreadResponse> {
-        return this.request(`/api/memory/threads?resourceid=${params.resourceId}&agentId=${params.agentId}`);
-    }
-
-    /**
-     * Creates a new memory thread
-     * @param params - Parameters for creating the memory thread
-     * @returns Promise containing the created memory thread
-     */
-    public createMemoryThread(params: CreateMemoryThreadParams): Promise<CreateMemoryThreadResponse> {
-        return this.request(`/api/memory/threads?agentId=${params.agentId}`, { method: 'POST', body: params });
-    }
-
-    /**
-     * Gets a memory thread instance by ID
-     * @param threadId - ID of the memory thread to retrieve
-     * @returns MemoryThread instance
-     */
-    public getMemoryThread(threadId: string, agentId: string) {
-        return new MemoryThread(this.options, threadId, agentId);
-    }
-
-    /**
-     * Saves messages to memory
-     * @param params - Parameters containing messages to save
-     * @returns Promise containing the saved messages
-     */
-    public saveMessageToMemory(params: SaveMessageToMemoryParams): Promise<SaveMessageToMemoryResponse> {
-        return this.request(`/api/memory/save-messages?agentId=${params.agentId}`, {
-            method: 'POST',
-            body: params,
-        });
-    }
-
-    /**
-     * Gets the status of the memory system
-     * @returns Promise containing memory system status
-     */
-    public getMemoryStatus(agentId: string): Promise<{ result: boolean }> {
-        return this.request(`/api/memory/status?agentId=${agentId}`);
-    }
-
-    /**
-     * Retrieves all available tools
-     * @returns Promise containing map of tool IDs to tool details
-     */
-    public getTools(): Promise<Record<string, GetToolResponse>> {
-        return this.request('/api/tools');
-    }
-
-    /**
-     * Gets a tool instance by ID
-     * @param toolId - ID of the tool to retrieve
-     * @returns Tool instance
-     */
-    public getTool(toolId: string) {
-        return new Tool(this.options, toolId);
-    }
-
-    /**
-     * Retrieves all available workflows
-     * @returns Promise containing map of workflow IDs to workflow details
-     */
-    public getWorkflows(): Promise<Record<string, GetWorkflowResponse>> {
-        return this.request('/api/workflows');
-    }
-
-    /**
-     * Gets a workflow instance by ID
-     * @param workflowId - ID of the workflow to retrieve
-     * @returns Workflow instance
-     */
-    public getWorkflow(workflowId: string) {
-        return new Workflow(this.options, workflowId);
-    }
-
-    /**
-     * Gets a vector instance by name
-     * @param vectorName - Name of the vector to retrieve
-     * @returns Vector instance
-     */
-    public getVector(vectorName: string) {
-        return new Vector(this.options, vectorName);
-    }
-
-    /**
-     * Retrieves logs
-     * @param params - Parameters for filtering logs
-     * @returns Promise containing array of log messages
-     */
-    public getLogs(params: GetLogsParams): Promise<GetLogsResponse> {
-        return this.request(`/api/logs?transportId=${params.transportId}`);
-    }
-
-    /**
-     * Gets logs for a specific run
-     * @param params - Parameters containing run ID to retrieve
-     * @returns Promise containing array of log messages
-     */
-    public getLogForRun(params: GetLogParams): Promise<GetLogsResponse> {
-        return this.request(`/api/logs/${params.runId}?transportId=${params.transportId}`);
-    }
-
-    /**
-     * List of all traces (paged)
-     * @param params - Parameters for filtering traces
-     * @returns Promise containing telemetry data
-     */ 
-    public getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse> {
-        const { name, scope, page, perPage, attribute } = params || {};
-        const _attribute = attribute ? Object.entries(attribute).map(([key, value]) => `${key}:${value}`) : [];
-
-        const queryObj = {
-          ...(name ? { name } : {}),
-          ...(scope ? { scope } : {}),
-          ...(page ? { page: String(page) } : {}),
-          ...(perPage ? { perPage: String(perPage) } : {}),
-          ...(_attribute?.length ? { attribute: _attribute } : {})
-        }
-
-        const hasQueryParams = Object.keys(queryObj).length > 0;
-
-        const queryParams = hasQueryParams ? new URLSearchParams(queryObj) : '';
-        return this.request(`/api/telemetry?${queryParams}`);
-    }
-} 
+  constructor(options: ClientOptions) {
+    super(options);
+  }
+
+  /**
+   * Retrieves all available agents
+   * @returns Promise containing map of agent IDs to agent details
+   */
+  public getAgents(): Promise<Record<string, GetAgentResponse>> {
+    return this.request('/api/agents');
+  }
+
+  /**
+   * Gets an agent instance by ID
+   * @param agentId - ID of the agent to retrieve
+   * @returns Agent instance
+   */
+  public getAgent(agentId: string) {
+    return new Agent(this.options, agentId);
+  }
+
+  /**
+   * Retrieves memory threads for a resource
+   * @param params - Parameters containing the resource ID
+   * @returns Promise containing array of memory threads
+   */
+  public getMemoryThreads(params: GetMemoryThreadParams): Promise<GetMemoryThreadResponse> {
+    return this.request(`/api/memory/threads?resourceid=${params.resourceId}&agentId=${params.agentId}`);
+  }
+
+  /**
+   * Creates a new memory thread
+   * @param params - Parameters for creating the memory thread
+   * @returns Promise containing the created memory thread
+   */
+  public createMemoryThread(params: CreateMemoryThreadParams): Promise<CreateMemoryThreadResponse> {
+    return this.request(`/api/memory/threads?agentId=${params.agentId}`, { method: 'POST', body: params });
+  }
+
+  /**
+   * Gets a memory thread instance by ID
+   * @param threadId - ID of the memory thread to retrieve
+   * @returns MemoryThread instance
+   */
+  public getMemoryThread(threadId: string, agentId: string) {
+    return new MemoryThread(this.options, threadId, agentId);
+  }
+
+  /**
+   * Saves messages to memory
+   * @param params - Parameters containing messages to save
+   * @returns Promise containing the saved messages
+   */
+  public saveMessageToMemory(params: SaveMessageToMemoryParams): Promise<SaveMessageToMemoryResponse> {
+    return this.request(`/api/memory/save-messages?agentId=${params.agentId}`, {
+      method: 'POST',
+      body: params,
+    });
+  }
+
+  /**
+   * Gets the status of the memory system
+   * @returns Promise containing memory system status
+   */
+  public getMemoryStatus(agentId: string): Promise<{ result: boolean }> {
+    return this.request(`/api/memory/status?agentId=${agentId}`);
+  }
+
+  /**
+   * Retrieves all available tools
+   * @returns Promise containing map of tool IDs to tool details
+   */
+  public getTools(): Promise<Record<string, GetToolResponse>> {
+    return this.request('/api/tools');
+  }
+
+  /**
+   * Gets a tool instance by ID
+   * @param toolId - ID of the tool to retrieve
+   * @returns Tool instance
+   */
+  public getTool(toolId: string) {
+    return new Tool(this.options, toolId);
+  }
+
+  /**
+   * Retrieves all available workflows
+   * @returns Promise containing map of workflow IDs to workflow details
+   */
+  public getWorkflows(): Promise<Record<string, GetWorkflowResponse>> {
+    return this.request('/api/workflows');
+  }
+
+  /**
+   * Gets a workflow instance by ID
+   * @param workflowId - ID of the workflow to retrieve
+   * @returns Workflow instance
+   */
+  public getWorkflow(workflowId: string) {
+    return new Workflow(this.options, workflowId);
+  }
+
+  /**
+   * Gets a vector instance by name
+   * @param vectorName - Name of the vector to retrieve
+   * @returns Vector instance
+   */
+  public getVector(vectorName: string) {
+    return new Vector(this.options, vectorName);
+  }
+
+  /**
+   * Retrieves logs
+   * @param params - Parameters for filtering logs
+   * @returns Promise containing array of log messages
+   */
+  public getLogs(params: GetLogsParams): Promise<GetLogsResponse> {
+    return this.request(`/api/logs?transportId=${params.transportId}`);
+  }
+
+  /**
+   * Gets logs for a specific run
+   * @param params - Parameters containing run ID to retrieve
+   * @returns Promise containing array of log messages
+   */
+  public getLogForRun(params: GetLogParams): Promise<GetLogsResponse> {
+    return this.request(`/api/logs/${params.runId}?transportId=${params.transportId}`);
+  }
+
+  /**
+   * List of all traces (paged)
+   * @param params - Parameters for filtering traces
+   * @returns Promise containing telemetry data
+   */
+  public getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse> {
+    const { name, scope, page, perPage, attribute } = params || {};
+    const _attribute = attribute ? Object.entries(attribute).map(([key, value]) => `${key}:${value}`) : [];
+
+    const queryObj = {
+      ...(name ? { name } : {}),
+      ...(scope ? { scope } : {}),
+      ...(page ? { page: String(page) } : {}),
+      ...(perPage ? { perPage: String(perPage) } : {}),
+      ...(_attribute?.length ? { attribute: _attribute } : {}),
+    };
+
+    const hasQueryParams = Object.keys(queryObj).length > 0;
+
+    const queryParams = hasQueryParams ? new URLSearchParams(queryObj) : '';
+    return this.request(`/api/telemetry?${queryParams}`);
+  }
+}

package/src/example.ts

@@ -1,43 +1,43 @@
-import { MastraClient } from "./client";
-
+import { MastraClient } from './client';
 
 (async () => {
-    const client = new MastraClient({
-        baseUrl: 'http://localhost:4111',
+  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!',
+        },
+      ],
     });
 
-    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 = ''
+    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;
+    while (true) {
+      if (!reader) break;
+      const { value, done } = await reader.read();
+      if (done) break;
 
-            const chunk = decoder.decode(value);
-            buffer += chunk;
+      const chunk = decoder.decode(value);
+      buffer += chunk;
 
-            console.log(buffer);
+      console.log(buffer);
 
-            const matches = buffer.matchAll(/0:"([^"]*)"/g);
+      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);
+      for (const match of matches) {
+        const content = match[1];
+        process.stdout.write(`${content}\n`);
+      }
     }
-})()
+  } catch (error) {
+    console.error(error);
+  }
+})();