@mastra/client-js 0.0.0-storage-20250225005900

package/.turbo/turbo-build.log

@@ -0,0 +1,16 @@
+
+
+> @mastra/client-js@0.1.4-alpha.0 build /Users/ward/projects/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.56 KB
+ESM ⚡️ Build success in 119ms
+DTS Build start
+DTS ⚡️ Build success in 2785ms
+DTS dist/index.d.mts 13.64 KB

package/CHANGELOG.md

@@ -0,0 +1,70 @@
+# @mastra/client-js
+
+## 0.0.0-storage-20250225005900
+
+### Patch Changes
+
+- Updated dependencies [7fceae1]
+- Updated dependencies [f626fbb]
+- Updated dependencies [8db2a28]
+  - @mastra/core@0.0.0-storage-20250225005900
+
+## 0.1.4-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [7fceae1]
+- Updated dependencies [f626fbb]
+  - @mastra/core@0.4.2-alpha.0
+
+## 0.1.3
+
+### Patch Changes
+
+- Updated dependencies [ce44b9b]
+- Updated dependencies [967da43]
+- Updated dependencies [b405f08]
+  - @mastra/core@0.4.1
+
+## 0.1.2
+
+### Patch Changes
+
+- 5297264: Fix build errors by changing contracts
+- Updated dependencies [2fc618f]
+- Updated dependencies [fe0fd01]
+  - @mastra/core@0.4.0
+
+## 0.1.2-alpha.1
+
+### Patch Changes
+
+- Updated dependencies [fe0fd01]
+  - @mastra/core@0.4.0-alpha.1
+
+## 0.1.2-alpha.0
+
+### Patch Changes
+
+- 5297264: Fix build errors by changing contracts
+- Updated dependencies [2fc618f]
+  - @mastra/core@0.4.0-alpha.0
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [f205ede]
+  - @mastra/core@0.3.0
+
+## 0.1.0
+
+### Patch Changes
+
+- b9ef5fd: Add workflow watch and resume to client sdk
+
+## 0.1.0-alpha.18
+
+### Patch Changes
+
+- b9ef5fd: Add workflow watch and resume to client sdk

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,125 @@
+# Mastra Client
+
+JavaScript/TypeScript client library for the [Mastra AI](https://mastra.ai) framework. This client provides a simple interface to interact with Mastra AI's APIs for agents, vectors, memory, tools, and workflows.
+
+## Installation
+
+```bash
+npm install @mastra/client-js
+```
+
+## Quick Start
+
+```typescript
+import { MastraClient } from '@mastra/client';
+
+// Initialize the client
+const client = new MastraClient({
+  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);
+}
+```
+
+## Client Configuration
+
+The client can be configured with several options:
+
+```typescript
+const client = new MastraClient({
+    baseUrl: string;           // Base URL for the Mastra API
+    retries?: number;          // Number of retry attempts (default: 3)
+    backoffMs?: number;        // Initial backoff time in ms (default: 300)
+    maxBackoffMs?: number;     // Maximum backoff time in ms (default: 5000)
+    headers?: Record<string, string>; // Custom headers
+});
+```
+
+## Available Methods
+
+### Agents
+
+- `getAgents()`: Get all available agents
+- `getAgent(agentId)`: Get a specific agent instance
+  - `agent.details()`: Get agent details
+  - `agent.generate(params)`: Generate a response
+  - `agent.stream(params)`: Stream a response
+  - `agent.getTool(toolId)`: Get agent tool details
+  - `agent.evals()`: Get agent evaluations
+  - `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
+- `saveMessageToMemory(params)`: Save messages to memory
+- `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
+  - `vector.getIndexes()`: Get all indexes
+  - `vector.createIndex(params)`: Create a new index
+  - `vector.upsert(params)`: Upsert vectors
+  - `vector.query(params)`: Query vectors
+
+### Logs
+
+- `getLogs(params)`: Get system logs
+- `getLog(params)`: Get specific log entry
+- `getLogTransports()`: Get configured Log transports
+
+### 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
+
+## 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
+- Error handling
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,405 @@
+import { CoreMessage, OutputType, StorageThreadType, AiMessageType, MessageType, StepAction, StepGraph, QueryResult, BaseLogMessage, GenerateReturn } from '@mastra/core';
+import { JSONSchema7 } from 'json-schema';
+import { ZodSchema } from 'zod';
+
+interface ClientOptions {
+    /** Base URL for API requests */
+    baseUrl: string;
+    /** Number of retry attempts for failed requests */
+    retries?: number;
+    /** Initial backoff time in milliseconds between retries */
+    backoffMs?: number;
+    /** Maximum backoff time in milliseconds between retries */
+    maxBackoffMs?: number;
+    /** Custom headers to include with requests */
+    headers?: Record<string, string>;
+}
+interface RequestOptions {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: any;
+    stream?: boolean;
+}
+interface GetAgentResponse {
+    name: string;
+    instructions: string;
+    tools: Record<string, GetToolResponse>;
+    provider: string;
+}
+interface GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> {
+    messages: string | string[] | CoreMessage[];
+    threadId?: string;
+    resourceid?: string;
+    output?: OutputType | T;
+}
+interface StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> {
+    messages: string | string[] | CoreMessage[];
+    threadId?: string;
+    resourceid?: string;
+    output?: OutputType | T;
+}
+interface GetEvalsByAgentIdResponse extends GetAgentResponse {
+    evals: any[];
+}
+interface GetToolResponse {
+    id: string;
+    description: string;
+    inputSchema: string;
+    outputSchema: string;
+}
+interface GetWorkflowResponse {
+    name: string;
+    triggerSchema: string;
+    steps: Record<string, StepAction<any, any, any, any>>;
+    stepGraph: StepGraph;
+    stepSubscriberGraph: Record<string, StepGraph>;
+}
+interface UpsertVectorParams {
+    indexName: string;
+    vectors: number[][];
+    metadata?: Record<string, any>[];
+    ids?: string[];
+}
+interface CreateIndexParams {
+    indexName: string;
+    dimension: number;
+    metric?: 'cosine' | 'euclidean' | 'dotproduct';
+}
+interface QueryVectorParams {
+    indexName: string;
+    queryVector: number[];
+    topK?: number;
+    filter?: Record<string, any>;
+    includeVector?: boolean;
+}
+interface QueryVectorResponse {
+    results: QueryResult[];
+}
+interface GetVectorIndexResponse {
+    dimension: number;
+    metric: 'cosine' | 'euclidean' | 'dotproduct';
+    count: number;
+}
+interface SaveMessageToMemoryParams {
+    messages: MessageType[];
+    agentId: string;
+}
+type SaveMessageToMemoryResponse = MessageType[];
+interface CreateMemoryThreadParams {
+    title: string;
+    metadata: Record<string, any>;
+    resourceid: string;
+    threadId: string;
+    agentId: string;
+}
+type CreateMemoryThreadResponse = StorageThreadType;
+interface GetMemoryThreadParams {
+    resourceId: string;
+    agentId: string;
+}
+type GetMemoryThreadResponse = StorageThreadType[];
+interface UpdateMemoryThreadParams {
+    title: string;
+    metadata: Record<string, any>;
+    resourceid: string;
+}
+interface GetMemoryThreadMessagesResponse {
+    messages: CoreMessage[];
+    uiMessages: AiMessageType[];
+}
+interface GetLogsParams {
+    transportId: string;
+}
+interface GetLogParams {
+    runId: string;
+    transportId: string;
+}
+type GetLogsResponse = BaseLogMessage[];
+type RequestFunction = (path: string, options?: RequestOptions) => Promise<any>;
+interface GetTelemetryResponse {
+    traces: any[];
+}
+interface GetTelemetryParams {
+    name?: string;
+    scope?: string;
+    page?: number;
+    perPage?: number;
+    attribute?: Record<string, string>;
+}
+
+declare class BaseResource {
+    readonly options: ClientOptions;
+    constructor(options: ClientOptions);
+    /**
+     * Makes an HTTP request to the API with retries and exponential backoff
+     * @param path - The API endpoint path
+     * @param options - Optional request configuration
+     * @returns Promise containing the response data
+     */
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+}
+
+declare class Agent extends BaseResource {
+    private agentId;
+    constructor(options: ClientOptions, agentId: string);
+    /**
+     * Retrieves details about the agent
+     * @returns Promise containing agent details including model and instructions
+     */
+    details(): Promise<GetAgentResponse>;
+    /**
+     * Generates a response from the agent
+     * @param params - Generation parameters including prompt
+     * @returns Promise containing the generated response
+     */
+    generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T>): Promise<GenerateReturn<T>>;
+    /**
+     * Streams a response from the agent
+     * @param params - Stream parameters including prompt
+     * @returns Promise containing the streamed response
+     */
+    stream<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: StreamParams<T>): Promise<Response>;
+    /**
+     * Gets details about a specific tool available to the agent
+     * @param toolId - ID of the tool to retrieve
+     * @returns Promise containing tool details
+     */
+    getTool(toolId: string): Promise<GetToolResponse>;
+    /**
+     * Retrieves evaluation results for the agent
+     * @returns Promise containing agent evaluations
+     */
+    evals(): Promise<GetEvalsByAgentIdResponse>;
+    /**
+     * Retrieves live evaluation results for the agent
+     * @returns Promise containing live agent evaluations
+     */
+    liveEvals(): Promise<GetEvalsByAgentIdResponse>;
+}
+
+declare class MemoryThread extends BaseResource {
+    private threadId;
+    private agentId;
+    constructor(options: ClientOptions, threadId: string, agentId: string);
+    /**
+     * Retrieves the memory thread details
+     * @returns Promise containing thread details including title and metadata
+     */
+    get(): Promise<StorageThreadType>;
+    /**
+     * Updates the memory thread properties
+     * @param params - Update parameters including title and metadata
+     * @returns Promise containing updated thread details
+     */
+    update(params: UpdateMemoryThreadParams): Promise<StorageThreadType>;
+    /**
+     * Deletes the memory thread
+     * @returns Promise containing deletion result
+     */
+    delete(): Promise<{
+        result: string;
+    }>;
+    /**
+     * Retrieves messages associated with the thread
+     * @returns Promise containing thread messages and UI messages
+     */
+    getMessages(): Promise<GetMemoryThreadMessagesResponse>;
+}
+
+declare class Vector extends BaseResource {
+    private vectorName;
+    constructor(options: ClientOptions, vectorName: string);
+    /**
+     * Retrieves details about a specific vector index
+     * @param indexName - Name of the index to get details for
+     * @returns Promise containing vector index details
+     */
+    details(indexName: string): Promise<GetVectorIndexResponse>;
+    /**
+     * Deletes a vector index
+     * @param indexName - Name of the index to delete
+     * @returns Promise indicating deletion success
+     */
+    delete(indexName: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Retrieves a list of all available indexes
+     * @returns Promise containing array of index names
+     */
+    getIndexes(): Promise<{
+        indexes: string[];
+    }>;
+    /**
+     * Creates a new vector index
+     * @param params - Parameters for index creation including dimension and metric
+     * @returns Promise indicating creation success
+     */
+    createIndex(params: CreateIndexParams): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Upserts vectors into an index
+     * @param params - Parameters containing vectors, metadata, and optional IDs
+     * @returns Promise containing array of vector IDs
+     */
+    upsert(params: UpsertVectorParams): Promise<string[]>;
+    /**
+     * Queries vectors in an index
+     * @param params - Query parameters including query vector and search options
+     * @returns Promise containing query results
+     */
+    query(params: QueryVectorParams): Promise<QueryVectorResponse>;
+}
+
+declare class Workflow extends BaseResource {
+    private workflowId;
+    constructor(options: ClientOptions, workflowId: string);
+    /**
+     * Retrieves details about the workflow
+     * @returns Promise containing workflow details including steps and graphs
+     */
+    details(): Promise<GetWorkflowResponse>;
+    /**
+     * Executes the workflow with the provided parameters
+     * @param params - Parameters required for workflow execution
+     * @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 {
+    private toolId;
+    constructor(options: ClientOptions, toolId: string);
+    /**
+     * Retrieves details about the tool
+     * @returns Promise containing tool details including description and schemas
+     */
+    details(): Promise<GetToolResponse>;
+    /**
+     * Executes the tool with the provided parameters
+     * @param params - Parameters required for tool execution
+     * @returns Promise containing the tool execution results
+     */
+    execute(params: {
+        data: any;
+    }): Promise<any>;
+}
+
+declare class MastraClient extends BaseResource {
+    constructor(options: ClientOptions);
+    /**
+     * Retrieves all available agents
+     * @returns Promise containing map of agent IDs to agent details
+     */
+    getAgents(): Promise<Record<string, GetAgentResponse>>;
+    /**
+     * Gets an agent instance by ID
+     * @param agentId - ID of the agent to retrieve
+     * @returns Agent instance
+     */
+    getAgent(agentId: string): Agent;
+    /**
+     * Retrieves memory threads for a resource
+     * @param params - Parameters containing the resource ID
+     * @returns Promise containing array of memory threads
+     */
+    getMemoryThreads(params: GetMemoryThreadParams): Promise<GetMemoryThreadResponse>;
+    /**
+     * Creates a new memory thread
+     * @param params - Parameters for creating the memory thread
+     * @returns Promise containing the created memory thread
+     */
+    createMemoryThread(params: CreateMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
+    /**
+     * Gets a memory thread instance by ID
+     * @param threadId - ID of the memory thread to retrieve
+     * @returns MemoryThread instance
+     */
+    getMemoryThread(threadId: string, agentId: string): MemoryThread;
+    /**
+     * Saves messages to memory
+     * @param params - Parameters containing messages to save
+     * @returns Promise containing the saved messages
+     */
+    saveMessageToMemory(params: SaveMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
+    /**
+     * Gets the status of the memory system
+     * @returns Promise containing memory system status
+     */
+    getMemoryStatus(agentId: string): Promise<{
+        result: boolean;
+    }>;
+    /**
+     * Retrieves all available tools
+     * @returns Promise containing map of tool IDs to tool details
+     */
+    getTools(): Promise<Record<string, GetToolResponse>>;
+    /**
+     * Gets a tool instance by ID
+     * @param toolId - ID of the tool to retrieve
+     * @returns Tool instance
+     */
+    getTool(toolId: string): Tool;
+    /**
+     * Retrieves all available workflows
+     * @returns Promise containing map of workflow IDs to workflow details
+     */
+    getWorkflows(): Promise<Record<string, GetWorkflowResponse>>;
+    /**
+     * Gets a workflow instance by ID
+     * @param workflowId - ID of the workflow to retrieve
+     * @returns Workflow instance
+     */
+    getWorkflow(workflowId: string): Workflow;
+    /**
+     * Gets a vector instance by name
+     * @param vectorName - Name of the vector to retrieve
+     * @returns Vector instance
+     */
+    getVector(vectorName: string): Vector;
+    /**
+     * Retrieves logs
+     * @param params - Parameters for filtering logs
+     * @returns Promise containing array of log messages
+     */
+    getLogs(params: GetLogsParams): Promise<GetLogsResponse>;
+    /**
+     * Gets logs for a specific run
+     * @param params - Parameters containing run ID to retrieve
+     * @returns Promise containing array of log messages
+     */
+    getLogForRun(params: GetLogParams): Promise<GetLogsResponse>;
+    /**
+     * List of all log transports
+     * @returns Promise containing list of log transports
+     */
+    getLogTransports(): Promise<{
+        transports: string[];
+    }>;
+    /**
+     * List of all traces (paged)
+     * @param params - Parameters for filtering traces
+     * @returns Promise containing telemetry data
+     */
+    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 };