@mastra/client-js 0.12.3 → 0.12.4-alpha.1

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './client.js';
 export * from './types.js';
+export * from './tools.js';
 export type { UIMessageWithMetadata } from '@mastra/core/agent';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -21,6 +21,14 @@ function base64RuntimeContext(runtimeContext) {
   }
   return void 0;
 }
+function runtimeContextQueryString(runtimeContext) {
+  const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
+  if (!runtimeContextParam) return "";
+  const searchParams = new URLSearchParams();
+  searchParams.set("runtimeContext", runtimeContextParam);
+  const queryString = searchParams.toString();
+  return queryString ? `?${queryString}` : "";
+}
 function isZodType(value) {
   return typeof value === "object" && value !== null && "_def" in value && "parse" in value && typeof value.parse === "function" && "safeParse" in value && typeof value.safeParse === "function";
 }
@@ -280,30 +288,20 @@ var AgentVoice = class extends BaseResource {
   /**
    * Get available speakers for the agent's voice provider
    * @param runtimeContext - Optional runtime context to pass as query parameter
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing list of available speakers
    */
   getSpeakers(runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}/voice/speakers${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}/voice/speakers${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Get the listener configuration for the agent's voice provider
    * @param runtimeContext - Optional runtime context to pass as query parameter
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing a check if the agent has listening capabilities
    */
   getListener(runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}/voice/listener${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}/voice/listener${runtimeContextQueryString(runtimeContext)}`);
   }
 };
 var Agent = class extends BaseResource {
@@ -315,17 +313,11 @@ var Agent = class extends BaseResource {
   voice;
   /**
    * Retrieves details about the agent
-   * @param runtimeContext - Runtime context to use for the agent
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing agent details including model and instructions
    */
   details(runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}${runtimeContextQueryString(runtimeContext)}`);
   }
   async generate(params) {
     console.warn(
@@ -398,7 +390,16 @@ var Agent = class extends BaseResource {
     }
     return response;
   }
-  async generateVNext(params) {
+  async generateVNext(messagesOrParams, options) {
+    let params;
+    if (typeof messagesOrParams === "object" && "messages" in messagesOrParams) {
+      params = messagesOrParams;
+    } else {
+      params = {
+        messages: messagesOrParams,
+        ...options
+      };
+    }
     const processedParams = {
       ...params,
       output: params.output ? zodToJsonSchema(params.output) : void 0,
@@ -1127,7 +1128,16 @@ var Agent = class extends BaseResource {
     };
     return streamResponse;
   }
-  async streamVNext(params) {
+  async streamVNext(messagesOrParams, options) {
+    let params;
+    if (typeof messagesOrParams === "object" && "messages" in messagesOrParams) {
+      params = messagesOrParams;
+    } else {
+      params = {
+        messages: messagesOrParams,
+        ...options
+      };
+    }
     const processedParams = {
       ...params,
       output: params.output ? zodToJsonSchema(params.output) : void 0,
@@ -1276,13 +1286,7 @@ var Agent = class extends BaseResource {
    * @returns Promise containing tool details
    */
   getTool(toolId, runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}/tools/${toolId}${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}/tools/${toolId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Executes a tool for the agent
@@ -1306,13 +1310,7 @@ var Agent = class extends BaseResource {
    * @returns Promise containing agent evaluations
    */
   evals(runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}/evals/ci${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}/evals/ci${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Retrieves live evaluation results for the agent
@@ -1320,13 +1318,7 @@ var Agent = class extends BaseResource {
    * @returns Promise containing live agent evaluations
    */
   liveEvals(runtimeContext) {
-    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
-    const searchParams = new URLSearchParams();
-    if (runtimeContextParam) {
-      searchParams.set("runtimeContext", runtimeContextParam);
-    }
-    const queryString = searchParams.toString();
-    return this.request(`/api/agents/${this.agentId}/evals/live${queryString ? `?${queryString}` : ""}`);
+    return this.request(`/api/agents/${this.agentId}/evals/live${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Updates the model for the agent
@@ -1347,10 +1339,11 @@ var Network = class extends BaseResource {
   }
   /**
    * Retrieves details about the network
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing network details
    */
-  details() {
-    return this.request(`/api/networks/${this.networkId}`);
+  details(runtimeContext) {
+    return this.request(`/api/networks/${this.networkId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Generates a response from the agent
@@ -1484,10 +1477,13 @@ var Vector = class extends BaseResource {
   /**
    * Retrieves details about a specific vector index
    * @param indexName - Name of the index to get details for
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing vector index details
    */
-  details(indexName) {
-    return this.request(`/api/vector/${this.vectorName}/indexes/${indexName}`);
+  details(indexName, runtimeContext) {
+    return this.request(
+      `/api/vector/${this.vectorName}/indexes/${indexName}${runtimeContextQueryString(runtimeContext)}`
+    );
   }
   /**
    * Deletes a vector index
@@ -1501,10 +1497,11 @@ var Vector = class extends BaseResource {
   }
   /**
    * Retrieves a list of all available indexes
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing array of index names
    */
-  getIndexes() {
-    return this.request(`/api/vector/${this.vectorName}/indexes`);
+  getIndexes(runtimeContext) {
+    return this.request(`/api/vector/${this.vectorName}/indexes${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Creates a new vector index
@@ -1550,17 +1547,20 @@ var LegacyWorkflow = class extends BaseResource {
   }
   /**
    * Retrieves details about the legacy workflow
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing legacy workflow details including steps and graphs
    */
-  details() {
-    return this.request(`/api/workflows/legacy/${this.workflowId}`);
+  details(runtimeContext) {
+    return this.request(`/api/workflows/legacy/${this.workflowId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Retrieves all runs for a legacy workflow
    * @param params - Parameters for filtering runs
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing legacy workflow runs array
    */
-  runs(params) {
+  runs(params, runtimeContext) {
+    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
     const searchParams = new URLSearchParams();
     if (params?.fromDate) {
       searchParams.set("fromDate", params.fromDate.toISOString());
@@ -1577,6 +1577,9 @@ var LegacyWorkflow = class extends BaseResource {
     if (params?.resourceId) {
       searchParams.set("resourceId", params.resourceId);
     }
+    if (runtimeContextParam) {
+      searchParams.set("runtimeContext", runtimeContextParam);
+    }
     if (searchParams.size) {
       return this.request(`/api/workflows/legacy/${this.workflowId}/runs?${searchParams}`);
     } else {
@@ -1730,10 +1733,11 @@ var Tool = class extends BaseResource {
   }
   /**
    * Retrieves details about the tool
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing tool details including description and schemas
    */
-  details() {
-    return this.request(`/api/tools/${this.toolId}`);
+  details(runtimeContext) {
+    return this.request(`/api/tools/${this.toolId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Executes the tool with the provided parameters
@@ -1810,17 +1814,20 @@ var Workflow = class extends BaseResource {
   }
   /**
    * Retrieves details about the workflow
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing workflow details including steps and graphs
    */
-  details() {
-    return this.request(`/api/workflows/${this.workflowId}`);
+  details(runtimeContext) {
+    return this.request(`/api/workflows/${this.workflowId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Retrieves all runs for a workflow
    * @param params - Parameters for filtering runs
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing workflow runs array
    */
-  runs(params) {
+  runs(params, runtimeContext) {
+    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
     const searchParams = new URLSearchParams();
     if (params?.fromDate) {
       searchParams.set("fromDate", params.fromDate.toISOString());
@@ -1837,6 +1844,9 @@ var Workflow = class extends BaseResource {
     if (params?.resourceId) {
       searchParams.set("resourceId", params.resourceId);
     }
+    if (runtimeContextParam) {
+      searchParams.set("runtimeContext", runtimeContextParam);
+    }
     if (searchParams.size) {
       return this.request(`/api/workflows/${this.workflowId}/runs?${searchParams}`);
     } else {
@@ -1846,18 +1856,22 @@ var Workflow = class extends BaseResource {
   /**
    * Retrieves a specific workflow run by its ID
    * @param runId - The ID of the workflow run to retrieve
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing the workflow run details
    */
-  runById(runId) {
-    return this.request(`/api/workflows/${this.workflowId}/runs/${runId}`);
+  runById(runId, runtimeContext) {
+    return this.request(`/api/workflows/${this.workflowId}/runs/${runId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Retrieves the execution result for a specific workflow run by its ID
    * @param runId - The ID of the workflow run to retrieve the execution result for
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing the workflow run execution result
    */
-  runExecutionResult(runId) {
-    return this.request(`/api/workflows/${this.workflowId}/runs/${runId}/execution-result`);
+  runExecutionResult(runId, runtimeContext) {
+    return this.request(
+      `/api/workflows/${this.workflowId}/runs/${runId}/execution-result${runtimeContextQueryString(runtimeContext)}`
+    );
   }
   /**
    * Cancels a specific workflow run by its ID
@@ -1885,14 +1899,40 @@ var Workflow = class extends BaseResource {
    * @param params - Optional object containing the optional runId
    * @returns Promise containing the runId of the created run
    */
-  createRun(params) {
+  /** @deprecated Use createRunAsync instead */
+  async createRun(params) {
     const searchParams = new URLSearchParams();
     if (!!params?.runId) {
       searchParams.set("runId", params.runId);
     }
-    return this.request(`/api/workflows/${this.workflowId}/create-run?${searchParams.toString()}`, {
-      method: "POST"
-    });
+    const res = await this.request(
+      `/api/workflows/${this.workflowId}/create-run?${searchParams.toString()}`,
+      {
+        method: "POST"
+      }
+    );
+    const runId = res.runId;
+    return {
+      runId,
+      start: async (p) => {
+        return this.start({ runId, inputData: p.inputData, runtimeContext: p.runtimeContext });
+      },
+      startAsync: async (p) => {
+        return this.startAsync({ runId, inputData: p.inputData, runtimeContext: p.runtimeContext });
+      },
+      watch: async (onRecord) => {
+        return this.watch({ runId }, onRecord);
+      },
+      stream: async (p) => {
+        return this.stream({ runId, inputData: p.inputData, runtimeContext: p.runtimeContext });
+      },
+      resume: async (p) => {
+        return this.resume({ runId, step: p.step, resumeData: p.resumeData, runtimeContext: p.runtimeContext });
+      },
+      resumeAsync: async (p) => {
+        return this.resumeAsync({ runId, step: p.step, resumeData: p.resumeData, runtimeContext: p.runtimeContext });
+      }
+    };
   }
   /**
    * Creates a new workflow run (alias for createRun)
@@ -1928,7 +1968,6 @@ var Workflow = class extends BaseResource {
     const runtimeContext = parseClientRuntimeContext(rest.runtimeContext);
     return this.request(`/api/workflows/${this.workflowId}/resume?runId=${runId}`, {
       method: "POST",
-      stream: true,
       body: {
         step,
         resumeData,
@@ -2204,10 +2243,11 @@ var MCPTool = class extends BaseResource {
   }
   /**
    * Retrieves details about this specific tool from the MCP server.
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing the tool's information (name, description, schema).
    */
-  details() {
-    return this.request(`/api/mcp/${this.serverId}/tools/${this.toolId}`);
+  details(runtimeContext) {
+    return this.request(`/api/mcp/${this.serverId}/tools/${this.toolId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Executes this specific tool on the MCP server.
@@ -2718,10 +2758,11 @@ var VNextNetwork = class extends BaseResource {
   }
   /**
    * Retrieves details about the network
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing vNext network details
    */
-  details() {
-    return this.request(`/api/networks/v-next/${this.networkId}`);
+  details(runtimeContext) {
+    return this.request(`/api/networks/v-next/${this.networkId}${runtimeContextQueryString(runtimeContext)}`);
   }
   /**
    * Generates a response from the v-next network
@@ -2856,7 +2897,7 @@ var MastraClient = class extends BaseResource {
   }
   /**
    * Retrieves all available agents
-   * @param runtimeContext - Runtime context to use for the agents
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing map of agent IDs to agent details
    */
   getAgents(runtimeContext) {
@@ -2962,10 +3003,17 @@ var MastraClient = class extends BaseResource {
   }
   /**
    * Retrieves all available tools
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing map of tool IDs to tool details
    */
-  getTools() {
-    return this.request("/api/tools");
+  getTools(runtimeContext) {
+    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
+    const searchParams = new URLSearchParams();
+    if (runtimeContextParam) {
+      searchParams.set("runtimeContext", runtimeContextParam);
+    }
+    const queryString = searchParams.toString();
+    return this.request(`/api/tools${queryString ? `?${queryString}` : ""}`);
   }
   /**
    * Gets a tool instance by ID
@@ -2992,10 +3040,17 @@ var MastraClient = class extends BaseResource {
   }
   /**
    * Retrieves all available workflows
+   * @param runtimeContext - Optional runtime context to pass as query parameter
    * @returns Promise containing map of workflow IDs to workflow details
    */
-  getWorkflows() {
-    return this.request("/api/workflows");
+  getWorkflows(runtimeContext) {
+    const runtimeContextParam = base64RuntimeContext(parseClientRuntimeContext(runtimeContext));
+    const searchParams = new URLSearchParams();
+    if (runtimeContextParam) {
+      searchParams.set("runtimeContext", runtimeContextParam);
+    }
+    const queryString = searchParams.toString();
+    return this.request(`/api/workflows${queryString ? `?${queryString}` : ""}`);
   }
   /**
    * Gets a workflow instance by ID
@@ -3377,6 +3432,25 @@ var MastraClient = class extends BaseResource {
   }
 };
 
-export { MastraClient };
+// src/tools.ts
+var ClientTool = class {
+  id;
+  description;
+  inputSchema;
+  outputSchema;
+  execute;
+  constructor(opts) {
+    this.id = opts.id;
+    this.description = opts.description;
+    this.inputSchema = opts.inputSchema;
+    this.outputSchema = opts.outputSchema;
+    this.execute = opts.execute;
+  }
+};
+function createTool(opts) {
+  return new ClientTool(opts);
+}
+
+export { ClientTool, MastraClient, createTool };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map