@mastra/client-js 1.16.1-alpha.0 → 1.17.0-alpha.2

package/dist/types.d.ts

@@ -2,19 +2,33 @@ import type { AgentExecutionOptions, MultiPrimitiveExecutionOptions, AgentGenera
 import type { MessageListInput } from '@mastra/core/agent/message-list';
 import type { MastraScorerEntry, ScoreRowData } from '@mastra/core/evals';
 import type { CoreMessage } from '@mastra/core/llm';
-import type { BaseLogMessage, LogLevel } from '@mastra/core/logger';
+import type { LogLevel } from '@mastra/core/logger';
 import type { MCPToolType, ServerInfo } from '@mastra/core/mcp';
 import type { AiMessageType, MastraMessageV1, MastraDBMessage, MemoryConfig, StorageThreadType } from '@mastra/core/memory';
 import type { TracingOptions } from '@mastra/core/observability';
 import type { RequestContext } from '@mastra/core/request-context';
-import type { AgentInstructionBlock, PaginationInfo, WorkflowRuns, StorageListMessagesInput, ObservationalMemoryRecord, Rule, RuleGroup, StorageConditionalVariant, StorageConditionalField, StoredProcessorGraph } from '@mastra/core/storage';
+import type { AgentInstructionBlock, PaginationInfo, WorkflowRuns, StorageListMessagesInput, Rule, RuleGroup, StorageConditionalVariant, StorageConditionalField, StoredProcessorGraph } from '@mastra/core/storage';
 import type { QueryResult } from '@mastra/core/vector';
 import type { TimeTravelContext, Workflow, WorkflowResult, WorkflowRunStatus, WorkflowState } from '@mastra/core/workflows';
 import type { PublicSchema } from '@mastra/schema-compat/schema';
 import type { JSONSchema7 } from 'json-schema';
 import type { ZodSchema as ZodSchemaV3 } from 'zod/v3';
 import type { ZodType as ZodTypeV4 } from 'zod/v4';
+import type { Body, QueryParams, RouteKey, RouteResponse, Simplify } from './route-types.generated.js';
 export type ZodSchema = ZodSchemaV3 | ZodTypeV4;
+type OptionalizeUndefined<T> = T extends Date ? Date : T extends (...args: any[]) => any ? T : T extends readonly (infer U)[] ? OptionalizeUndefined<U>[] : T extends object ? Simplify<{
+    [K in keyof T as undefined extends T[K] ? never : K]: OptionalizeUndefined<T[K]>;
+} & {
+    [K in keyof T as undefined extends T[K] ? K : never]?: OptionalizeUndefined<Exclude<T[K], undefined>>;
+}> : T;
+type Serialized<T> = T extends Date ? string : T extends readonly (infer U)[] ? Serialized<U>[] : T extends object ? {
+    [K in keyof T]: Serialized<T[K]>;
+} : T;
+type RequestContextOptions = {
+    requestContext?: RequestContext | Record<string, any>;
+};
+type GeneratedRequest<T> = OptionalizeUndefined<T>;
+type GeneratedResponse<T extends RouteKey> = Serialized<RouteResponse<T>>;
 export interface ClientOptions {
     /** Base URL for API requests */
     baseUrl: string;
@@ -426,17 +440,8 @@ export interface GetWorkflowResponse {
     isProcessorWorkflow?: boolean;
 }
 export type WorkflowRunResult = WorkflowResult<any, any, any, any>;
-export interface UpsertVectorParams {
-    indexName: string;
-    vectors: number[][];
-    metadata?: Record<string, any>[];
-    ids?: string[];
-}
-export interface CreateIndexParams {
-    indexName: string;
-    dimension: number;
-    metric?: 'cosine' | 'euclidean' | 'dotproduct';
-}
+export type UpsertVectorParams = GeneratedRequest<Body<'POST /vector/:vectorName/upsert'>>;
+export type CreateIndexParams = GeneratedRequest<Body<'POST /vector/:vectorName/create-index'>>;
 export interface QueryVectorParams {
     indexName: string;
     queryVector: number[];
@@ -444,14 +449,8 @@ export interface QueryVectorParams {
     filter?: Record<string, any>;
     includeVector?: boolean;
 }
-export interface QueryVectorResponse {
-    results: QueryResult[];
-}
-export interface GetVectorIndexResponse {
-    dimension: number;
-    metric: 'cosine' | 'euclidean' | 'dotproduct';
-    count: number;
-}
+export type QueryVectorResponse = QueryResult[];
+export type GetVectorIndexResponse = GeneratedResponse<'GET /vector/:vectorName/indexes/:indexName'>;
 export interface SaveMessageToMemoryParams {
     messages: (MastraMessageV1 | MastraDBMessage)[];
     agentId: string;
@@ -464,15 +463,8 @@ export interface SaveNetworkMessageToMemoryParams {
 export type SaveMessageToMemoryResponse = {
     messages: (MastraMessageV1 | MastraDBMessage)[];
 };
-export interface CreateMemoryThreadParams {
-    title?: string;
-    metadata?: Record<string, any>;
-    resourceId: string;
-    threadId?: string;
-    agentId: string;
-    requestContext?: RequestContext | Record<string, any>;
-}
-export type CreateMemoryThreadResponse = StorageThreadType;
+export type CreateMemoryThreadParams = GeneratedRequest<Body<'POST /memory/threads'> & QueryParams<'POST /memory/threads'>> & RequestContextOptions;
+export type CreateMemoryThreadResponse = GeneratedResponse<'POST /memory/threads'>;
 export interface ListMemoryThreadsParams {
     /**
      * Optional resourceId to filter threads. When not provided, returns all threads.
@@ -493,16 +485,9 @@ export interface ListMemoryThreadsParams {
     sortDirection?: 'ASC' | 'DESC';
     requestContext?: RequestContext | Record<string, any>;
 }
-export type ListMemoryThreadsResponse = PaginationInfo & {
-    threads: StorageThreadType[];
-};
-export interface GetMemoryConfigParams {
-    agentId: string;
-    requestContext?: RequestContext | Record<string, any>;
-}
-export type GetMemoryConfigResponse = {
-    config: MemoryConfig;
-};
+export type ListMemoryThreadsResponse = GeneratedResponse<'GET /memory/threads'>;
+export type GetMemoryConfigParams = GeneratedRequest<QueryParams<'GET /memory/config'>> & RequestContextOptions;
+export type GetMemoryConfigResponse = GeneratedResponse<'GET /memory/config'>;
 export interface UpdateMemoryThreadParams {
     title: string;
     metadata: Record<string, any>;
@@ -534,15 +519,7 @@ export type CloneMemoryThreadResponse = {
     thread: StorageThreadType;
     clonedMessages: MastraDBMessage[];
 };
-export interface GetLogsParams {
-    transportId: string;
-    fromDate?: Date;
-    toDate?: Date;
-    logLevel?: LogLevel;
-    filters?: Record<string, string>;
-    page?: number;
-    perPage?: number;
-}
+export type GetLogsParams = GeneratedRequest<QueryParams<'GET /logs'>>;
 export interface GetLogParams {
     runId: string;
     transportId: string;
@@ -553,13 +530,7 @@ export interface GetLogParams {
     page?: number;
     perPage?: number;
 }
-export type GetLogsResponse = {
-    logs: BaseLogMessage[];
-    total: number;
-    page: number;
-    perPage: number;
-    hasMore: boolean;
-};
+export type GetLogsResponse = GeneratedResponse<'GET /logs'>;
 export type RequestFunction = (path: string, options?: RequestOptions) => Promise<any>;
 export interface GetVNextNetworkResponse {
     id: string;
@@ -1381,9 +1352,7 @@ export interface CompareScorerVersionsResponse {
     toVersion: ScorerVersionResponse;
     diffs: VersionDiff[];
 }
-export interface ListAgentsModelProvidersResponse {
-    providers: Provider[];
-}
+export type ListAgentsModelProvidersResponse = GeneratedResponse<'GET /agents/providers'>;
 export interface Provider {
     id: string;
     name: string;
@@ -1396,62 +1365,27 @@ export interface MastraPackage {
     name: string;
     version: string;
 }
-export interface GetSystemPackagesResponse {
-    packages: MastraPackage[];
-    isDev: boolean;
-    cmsEnabled: boolean;
-    observabilityEnabled: boolean;
-    storageType?: string;
-    observabilityStorageType?: string;
-    observabilityRuntimeStrategy?: 'realtime' | 'batch-with-updates' | 'insert-only' | 'event-sourced';
-}
+export type GetSystemPackagesResponse = GeneratedResponse<'GET /system/packages'>;
 /**
  * Workspace capabilities
  */
-export interface WorkspaceCapabilities {
-    hasFilesystem: boolean;
-    hasSandbox: boolean;
-    canBM25: boolean;
-    canVector: boolean;
-    canHybrid: boolean;
-    hasSkills: boolean;
-}
+export type WorkspaceCapabilities = ListWorkspacesResponse['workspaces'][number]['capabilities'];
 /**
  * Workspace safety configuration
  */
-export interface WorkspaceSafety {
-    readOnly: boolean;
-}
+export type WorkspaceSafety = ListWorkspacesResponse['workspaces'][number]['safety'];
 /**
  * Response for getting workspace info
  */
-export interface WorkspaceInfoResponse {
-    isWorkspaceConfigured: boolean;
-    id?: string;
-    name?: string;
-    status?: string;
-    capabilities?: WorkspaceCapabilities;
-    safety?: WorkspaceSafety;
-}
+export type WorkspaceInfoResponse = GeneratedResponse<'GET /workspaces/:workspaceId'>;
 /**
  * Workspace item in list response
  */
-export interface WorkspaceItem {
-    id: string;
-    name: string;
-    status: string;
-    source: 'mastra' | 'agent';
-    agentId?: string;
-    agentName?: string;
-    capabilities: WorkspaceCapabilities;
-    safety: WorkspaceSafety;
-}
+export type WorkspaceItem = ListWorkspacesResponse['workspaces'][number];
 /**
  * Response for listing all workspaces
  */
-export interface ListWorkspacesResponse {
-    workspaces: WorkspaceItem[];
-}
+export type ListWorkspacesResponse = GeneratedResponse<'GET /workspaces'>;
 /**
  * File entry in directory listing
  */
@@ -1463,52 +1397,27 @@ export interface WorkspaceFileEntry {
 /**
  * Response for reading a file
  */
-export interface WorkspaceFsReadResponse {
-    path: string;
-    content: string;
-    type: 'file' | 'directory';
-    size?: number;
-    mimeType?: string;
-}
+export type WorkspaceFsReadResponse = GeneratedResponse<'GET /workspaces/:workspaceId/fs/read'>;
 /**
  * Response for writing a file
  */
-export interface WorkspaceFsWriteResponse {
-    success: boolean;
-    path: string;
-}
+export type WorkspaceFsWriteResponse = GeneratedResponse<'POST /workspaces/:workspaceId/fs/write'>;
 /**
  * Response for listing files
  */
-export interface WorkspaceFsListResponse {
-    path: string;
-    entries: WorkspaceFileEntry[];
-}
+export type WorkspaceFsListResponse = GeneratedResponse<'GET /workspaces/:workspaceId/fs/list'>;
 /**
  * Response for deleting a file
  */
-export interface WorkspaceFsDeleteResponse {
-    success: boolean;
-    path: string;
-}
+export type WorkspaceFsDeleteResponse = GeneratedResponse<'DELETE /workspaces/:workspaceId/fs/delete'>;
 /**
  * Response for creating a directory
  */
-export interface WorkspaceFsMkdirResponse {
-    success: boolean;
-    path: string;
-}
+export type WorkspaceFsMkdirResponse = GeneratedResponse<'POST /workspaces/:workspaceId/fs/mkdir'>;
 /**
  * Response for getting file stats
  */
-export interface WorkspaceFsStatResponse {
-    path: string;
-    type: 'file' | 'directory';
-    size?: number;
-    createdAt?: string;
-    modifiedAt?: string;
-    mimeType?: string;
-}
+export type WorkspaceFsStatResponse = GeneratedResponse<'GET /workspaces/:workspaceId/fs/stat'>;
 /**
  * Workspace search result
  */
@@ -1529,35 +1438,19 @@ export interface WorkspaceSearchResult {
 /**
  * Parameters for searching workspace content
  */
-export interface WorkspaceSearchParams {
-    query: string;
-    topK?: number;
-    mode?: 'bm25' | 'vector' | 'hybrid';
-    minScore?: number;
-}
+export type WorkspaceSearchParams = GeneratedRequest<QueryParams<'GET /workspaces/:workspaceId/search'>>;
 /**
  * Response for searching workspace
  */
-export interface WorkspaceSearchResponse {
-    results: WorkspaceSearchResult[];
-    query: string;
-    mode: 'bm25' | 'vector' | 'hybrid';
-}
+export type WorkspaceSearchResponse = GeneratedResponse<'GET /workspaces/:workspaceId/search'>;
 /**
  * Parameters for indexing content
  */
-export interface WorkspaceIndexParams {
-    path: string;
-    content: string;
-    metadata?: Record<string, unknown>;
-}
+export type WorkspaceIndexParams = GeneratedRequest<Body<'POST /workspaces/:workspaceId/index'>>;
 /**
  * Response for indexing content
  */
-export interface WorkspaceIndexResponse {
-    success: boolean;
-    path: string;
-}
+export type WorkspaceIndexResponse = GeneratedResponse<'POST /workspaces/:workspaceId/index'>;
 /**
  * Skill source type indicating where the skill comes from
  */
@@ -1796,55 +1689,26 @@ export interface ExecuteProcessorResponse {
 /**
  * Parameters for getting observational memory
  */
-export interface GetObservationalMemoryParams {
-    agentId: string;
-    resourceId?: string;
-    threadId?: string;
+export type GetObservationalMemoryParams = Omit<GeneratedRequest<QueryParams<'GET /memory/observational-memory'>>, 'from' | 'to'> & {
     from?: Date | string;
     to?: Date | string;
-    offset?: number;
-    limit?: number;
-    requestContext?: RequestContext | Record<string, any>;
-}
+} & RequestContextOptions;
 /**
  * Response for observational memory endpoint
  */
-export interface GetObservationalMemoryResponse {
-    record: ObservationalMemoryRecord | null;
-    history?: ObservationalMemoryRecord[];
-}
+export type GetObservationalMemoryResponse = GeneratedResponse<'GET /memory/observational-memory'>;
 /**
  * Parameters for awaiting buffer status
  */
-export interface AwaitBufferStatusParams {
-    agentId: string;
-    resourceId?: string;
-    threadId?: string;
-    requestContext?: RequestContext;
-}
+export type AwaitBufferStatusParams = GeneratedRequest<Body<'POST /memory/observational-memory/buffer-status'>> & RequestContextOptions;
 /**
  * Response for buffer status endpoint
  */
-export interface AwaitBufferStatusResponse {
-    record: ObservationalMemoryRecord | null;
-}
+export type AwaitBufferStatusResponse = GeneratedResponse<'POST /memory/observational-memory/buffer-status'>;
 /**
  * Extended memory status response with OM info
  */
-export interface GetMemoryStatusResponse {
-    result: boolean;
-    memoryType?: 'local' | 'gateway';
-    observationalMemory?: {
-        enabled: boolean;
-        hasRecord?: boolean;
-        originType?: string;
-        lastObservedAt?: Date | null;
-        tokenCount?: number;
-        observationTokenCount?: number;
-        isObserving?: boolean;
-        isReflecting?: boolean;
-    };
-}
+export type GetMemoryStatusResponse = GeneratedResponse<'GET /memory/status'>;
 /**
  * Extended memory config response with OM config
  */
@@ -1870,67 +1734,20 @@ export interface GetMemoryConfigResponseExtended {
 /**
  * Response for listing available vector stores
  */
-export interface ListVectorsResponse {
-    vectors: Array<{
-        name: string;
-        id: string;
-        type: string;
-    }>;
-}
+export type ListVectorsResponse = GeneratedResponse<'GET /vectors'>;
 /**
  * Response for listing available embedding models
  */
-export interface ListEmbeddersResponse {
-    embedders: Array<{
-        id: string;
-        provider: string;
-        name: string;
-        description: string;
-        dimensions: number;
-        maxInputTokens: number;
-    }>;
-}
-export interface ToolProviderInfo {
-    id: string;
-    name: string;
-    description?: string;
-}
-export interface ToolProviderToolkit {
-    slug: string;
-    name: string;
-    description?: string;
-    icon?: string;
-}
-export interface ToolProviderToolInfo {
-    slug: string;
-    name: string;
-    description?: string;
-    toolkit?: string;
-}
-export interface ToolProviderPagination {
-    total?: number;
-    page?: number;
-    perPage?: number;
-    hasMore: boolean;
-}
-export interface ListToolProvidersResponse {
-    providers: ToolProviderInfo[];
-}
-export interface ListToolProviderToolkitsResponse {
-    data: ToolProviderToolkit[];
-    pagination?: ToolProviderPagination;
-}
-export interface ListToolProviderToolsParams {
-    toolkit?: string;
-    search?: string;
-    page?: number;
-    perPage?: number;
-}
-export interface ListToolProviderToolsResponse {
-    data: ToolProviderToolInfo[];
-    pagination?: ToolProviderPagination;
-}
-export type GetToolProviderToolSchemaResponse = Record<string, unknown>;
+export type ListEmbeddersResponse = GeneratedResponse<'GET /embedders'>;
+export type ToolProviderInfo = GeneratedResponse<'GET /tool-providers'>['providers'][number];
+export type ToolProviderToolkit = GeneratedResponse<'GET /tool-providers/:providerId/toolkits'>['data'][number];
+export type ToolProviderToolInfo = GeneratedResponse<'GET /tool-providers/:providerId/tools'>['data'][number];
+export type ToolProviderPagination = NonNullable<GeneratedResponse<'GET /tool-providers/:providerId/toolkits'>['pagination']>;
+export type ListToolProvidersResponse = GeneratedResponse<'GET /tool-providers'>;
+export type ListToolProviderToolkitsResponse = GeneratedResponse<'GET /tool-providers/:providerId/toolkits'>;
+export type ListToolProviderToolsParams = GeneratedRequest<QueryParams<'GET /tool-providers/:providerId/tools'>>;
+export type ListToolProviderToolsResponse = GeneratedResponse<'GET /tool-providers/:providerId/tools'>;
+export type GetToolProviderToolSchemaResponse = GeneratedResponse<'GET /tool-providers/:providerId/tools/:toolSlug/schema'>;
 /**
  * Provider phase names as returned by the server (prefixed form).
  * Distinct from ProcessorPhase which uses the short/unprefixed form for processor endpoints.
@@ -2294,52 +2111,63 @@ export interface DeletePromptBlockVersionResponse {
 }
 export type BackgroundTaskStatus = 'pending' | 'running' | 'completed' | 'failed' | 'cancelled' | 'timed_out';
 export type BackgroundTaskDateColumn = 'createdAt' | 'startedAt' | 'completedAt';
-export interface BackgroundTaskResponse {
+export type BackgroundTaskResponse = GeneratedResponse<'GET /background-tasks'>['tasks'][number];
+export type ListBackgroundTasksParams = GeneratedRequest<QueryParams<'GET /background-tasks'>>;
+export type ListBackgroundTasksResponse = GeneratedResponse<'GET /background-tasks'>;
+export type StreamBackgroundTasksParams = GeneratedRequest<QueryParams<'GET /background-tasks/stream'>>;
+export type ScheduleStatus = 'active' | 'paused';
+export interface ScheduleTarget {
+    type: 'workflow';
+    workflowId: string;
+    inputData?: unknown;
+    initialState?: unknown;
+    requestContext?: Record<string, unknown>;
+}
+export interface ScheduleRunSummary {
+    status: WorkflowRunStatus;
+    startedAt?: number;
+    completedAt?: number;
+    durationMs?: number;
+    error?: string;
+}
+export interface ScheduleResponse {
     id: string;
-    status: BackgroundTaskStatus;
-    toolName: string;
-    toolCallId: string;
-    args: Record<string, unknown>;
-    agentId: string;
-    threadId?: string;
-    resourceId?: string;
+    target: ScheduleTarget;
+    cron: string;
+    timezone?: string;
+    status: ScheduleStatus;
+    nextFireAt: number;
+    lastFireAt?: number;
+    lastRunId?: string;
+    lastRun?: ScheduleRunSummary;
+    metadata?: Record<string, unknown>;
+    createdAt: number;
+    updatedAt: number;
+}
+export type ScheduleTriggerStatus = 'published' | 'failed';
+export interface ScheduleTriggerResponse {
+    scheduleId: string;
     runId: string;
-    result?: unknown;
-    error?: {
-        message: string;
-        stack?: string;
-    };
-    createdAt: string;
-    startedAt?: string;
-    completedAt?: string;
-    retryCount: number;
-    maxRetries: number;
-    timeoutMs: number;
+    scheduledFireAt: number;
+    actualFireAt: number;
+    status: ScheduleTriggerStatus;
+    error?: string;
+    run?: ScheduleRunSummary;
 }
-export interface ListBackgroundTasksParams {
-    agentId?: string;
-    status?: BackgroundTaskStatus;
-    runId?: string;
-    threadId?: string;
-    resourceId?: string;
-    fromDate?: Date;
-    toDate?: Date;
-    dateFilterBy?: BackgroundTaskDateColumn;
-    orderBy?: BackgroundTaskDateColumn;
-    orderDirection?: 'asc' | 'desc';
-    page?: number;
-    perPage?: number;
+export interface ListSchedulesParams {
+    workflowId?: string;
+    status?: ScheduleStatus;
 }
-export interface ListBackgroundTasksResponse {
-    tasks: BackgroundTaskResponse[];
-    total: number;
+export interface ListSchedulesResponse {
+    schedules: ScheduleResponse[];
 }
-export interface StreamBackgroundTasksParams {
-    agentId?: string;
-    runId?: string;
-    threadId?: string;
-    resourceId?: string;
-    taskId?: string;
+export interface ListScheduleTriggersParams {
+    limit?: number;
+    fromActualFireAt?: number;
+    toActualFireAt?: number;
+}
+export interface ListScheduleTriggersResponse {
+    triggers: ScheduleTriggerResponse[];
 }
 export interface ExperimentReviewCounts {
     experimentId: string;