@mastra/server 0.0.1-alpha.0

package/dist/_tsup-dts-rollup.d.ts

@@ -0,0 +1,592 @@
+import type { Agent } from '@mastra/core/agent';
+import type { AgentNetwork } from '@mastra/core/network';
+import { BaseLogMessage } from '@mastra/core';
+import { CoreMessage } from 'ai';
+import { EvalRow } from '@mastra/core';
+import { GenerateObjectResult } from 'ai';
+import { GenerateTextResult } from 'ai';
+import type { Mastra } from '@mastra/core/mastra';
+import type { Mastra as Mastra_2 } from '@mastra/core';
+import type { MastraMemory } from '@mastra/core/memory';
+import { Message } from 'ai';
+import { MessageType } from '@mastra/core';
+import type { QueryResult } from '@mastra/core/vector';
+import { ReadableStream as ReadableStream_2 } from 'node:stream/web';
+import { Step } from '@mastra/core';
+import { StepExecutionContext } from '@mastra/core';
+import { StepGraph } from '@mastra/core';
+import { StorageThreadType } from '@mastra/core';
+import type { ToolAction } from '@mastra/core/tools';
+import type { VercelTool } from '@mastra/core/tools';
+import type { Workflow } from '@mastra/core/workflows';
+import { WorkflowContext as WorkflowContext_2 } from '@mastra/core';
+import { WorkflowRunResult } from '@mastra/core';
+
+export declare namespace agents {
+    export {
+        getAgentsHandler,
+        getAgentByIdHandler,
+        getEvalsByAgentIdHandler,
+        getLiveEvalsByAgentIdHandler,
+        generateHandler,
+        streamGenerateHandler
+    }
+}
+
+export declare interface ApiError extends Error {
+    message: string;
+    status?: number;
+}
+
+declare type ClientErrorStatusCode = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451;
+
+export declare interface Context {
+    mastra: Mastra;
+}
+
+export declare function createIndex({ mastra, vectorName, index, }: Pick<VectorContext, 'mastra' | 'vectorName'> & {
+    index: CreateIndexRequest;
+}): Promise<{
+    success: boolean;
+}>;
+
+declare interface CreateIndexRequest {
+    indexName: string;
+    dimension: number;
+    metric?: 'cosine' | 'euclidean' | 'dotproduct';
+}
+
+export declare function createRunHandler({ mastra, workflowId, runId: prevRunId, }: Pick<WorkflowContext, 'mastra' | 'workflowId' | 'runId'>): Promise<{
+    runId: string;
+}>;
+
+export declare function createThreadHandler({ mastra, agentId, body, }: Pick<MemoryContext, 'mastra' | 'agentId'> & {
+    body?: Omit<Parameters<MastraMemory['createThread']>[0], 'resourceId'> & {
+        resourceId?: string;
+    };
+}): Promise<StorageThreadType>;
+
+export declare function deleteIndex({ mastra, vectorName, indexName, }: Pick<VectorContext, 'mastra' | 'vectorName'> & {
+    indexName?: string;
+}): Promise<{
+    success: boolean;
+}>;
+
+export declare function deleteThreadHandler({ mastra, agentId, threadId, }: Pick<MemoryContext, 'mastra' | 'agentId' | 'threadId'>): Promise<{
+    result: string;
+}>;
+
+declare type DeprecatedStatusCode = 305 | 306;
+
+export declare function describeIndex({ mastra, vectorName, indexName, }: Pick<VectorContext, 'mastra' | 'vectorName'> & {
+    indexName?: string;
+}): Promise<{
+    dimension: number;
+    count: number;
+    metric: string | undefined;
+}>;
+
+export declare function executeAgentToolHandler({ mastra, agentId, toolId, data, }: Pick<ToolsContext, 'mastra' | 'toolId'> & {
+    agentId?: string;
+    data: any;
+}): Promise<any>;
+
+export declare function executeToolHandler(tools: ToolsContext['tools']): ({ mastra, runId, toolId, data, }: Pick<ToolsContext, "mastra" | "toolId" | "runId"> & {
+    data?: unknown;
+}) => Promise<any>;
+
+export declare function generateHandler({ mastra, agentId, body, }: Context & {
+    agentId: string;
+    body: GetBody<'generate'>;
+}): Promise<GenerateTextResult<any, any>>;
+
+export declare function generateHandler_alias_1({ mastra, networkId, body, }: NetworkContext & {
+    body: {
+        messages?: Parameters<AgentNetwork['generate']>[0];
+    } & Parameters<AgentNetwork['generate']>[1];
+}): Promise<GenerateObjectResult<any>>;
+
+/**
+ * Generate speech from text
+ */
+export declare function generateSpeechHandler({ mastra, agentId, body, }: VoiceContext & {
+    body?: {
+        text?: string;
+        speakerId?: string;
+    };
+}): Promise<{
+    audioData: Buffer<ArrayBuffer>;
+}>;
+
+export declare function getAgentByIdHandler({ mastra, agentId }: Context & {
+    agentId: string;
+}): Promise<{
+    name: any;
+    instructions: string;
+    tools: any;
+    provider: string;
+    modelId: string;
+}>;
+
+export declare function getAgentsHandler({ mastra }: Context): Promise<any>;
+
+declare type GetBody<T extends keyof Agent & {
+    [K in keyof Agent]: Agent[K] extends (...args: any) => any ? K : never;
+}[keyof Agent]> = {
+    messages: Parameters<Agent[T]>[0];
+} & Parameters<Agent[T]>[1];
+
+export declare function getEvalsByAgentIdHandler({ mastra, agentId }: Context & {
+    agentId: string;
+}): Promise<{
+    id: string;
+    name: any;
+    instructions: string;
+    evals: EvalRow[];
+}>;
+
+export declare function getLiveEvalsByAgentIdHandler({ mastra, agentId }: Context & {
+    agentId: string;
+}): Promise<{
+    id: string;
+    name: any;
+    instructions: string;
+    evals: EvalRow[];
+}>;
+
+export declare function getLogsByRunIdHandler({ mastra, runId, transportId, }: Pick<LogsContext, 'mastra' | 'runId' | 'transportId'>): Promise<BaseLogMessage[] | undefined>;
+
+export declare function getLogsHandler({ mastra, transportId }: Pick<LogsContext, 'mastra' | 'transportId'>): Promise<BaseLogMessage[]>;
+
+export declare function getLogTransports({ mastra }: Pick<LogsContext, 'mastra'>): Promise<{
+    transports: string[];
+}>;
+
+export declare function getMemoryStatusHandler({ mastra, agentId }: Pick<MemoryContext, 'mastra' | 'agentId'>): Promise<{
+    result: boolean;
+}>;
+
+export declare function getMessagesHandler({ mastra, agentId, threadId, }: Pick<MemoryContext, 'mastra' | 'agentId' | 'threadId'>): Promise<{
+    messages: CoreMessage[];
+    uiMessages: Message[];
+}>;
+
+export declare function getNetworkByIdHandler({ mastra, networkId }: Pick<NetworkContext, 'mastra' | 'networkId'>): Promise<{
+    id: string;
+    name: string;
+    instructions: string;
+    agents: {
+        name: string;
+        provider: string;
+        modelId: string;
+    }[];
+    routingModel: {
+        provider: string;
+        modelId: string;
+    };
+}>;
+
+export declare function getNetworksHandler({ mastra }: Pick<NetworkContext, 'mastra'>): Promise<{
+    id: string;
+    name: string;
+    instructions: string;
+    agents: {
+        name: string;
+        provider: string;
+        modelId: string;
+    }[];
+    routingModel: {
+        provider: string;
+        modelId: string;
+    };
+}[]>;
+
+/**
+ * Get available speakers for an agent
+ */
+export declare function getSpeakersHandler({ mastra, agentId }: VoiceContext): Promise<{
+    voiceId: string;
+}[]>;
+
+export declare function getTelemetryHandler({ mastra, body }: TelemetryContext): Promise<{
+    traces: any[];
+}>;
+
+export declare function getThreadByIdHandler({ mastra, agentId, threadId, }: Pick<MemoryContext, 'mastra' | 'agentId' | 'threadId'>): Promise<StorageThreadType>;
+
+export declare function getThreadsHandler({ mastra, agentId, resourceId, }: Pick<MemoryContext, 'mastra' | 'agentId' | 'resourceId'>): Promise<StorageThreadType[]>;
+
+export declare function getToolByIdHandler({ tools, toolId }: Pick<ToolsContext, 'tools' | 'toolId'>): Promise<any>;
+
+export declare function getToolsHandler({ tools }: Pick<ToolsContext, 'tools'>): Promise<Record<string, any>>;
+
+export declare function getWorkflowByIdHandler({ mastra, workflowId }: WorkflowContext): Promise<{
+    stepGraph: StepGraph;
+    stepSubscriberGraph: Record<string, StepGraph>;
+    serializedStepGraph: StepGraph;
+    serializedStepSubscriberGraph: Record<string, StepGraph>;
+    name: string;
+    triggerSchema: string | undefined;
+    steps: any;
+}>;
+
+export declare function getWorkflowRunHandler({ mastra, workflowId, runId, }: Pick<WorkflowContext, 'mastra' | 'workflowId' | 'runId'>): Promise<ReturnType<Workflow['getRun']>>;
+
+export declare function getWorkflowsHandler({ mastra }: WorkflowContext): Promise<any>;
+
+export declare function handleError(error: unknown, defaultMessage: string): never;
+
+/**
+ * `HTTPException` must be used when a fatal error such as authentication failure occurs.
+ *
+ * @see {@link https://hono.dev/docs/api/exception}
+ *
+ * @param {StatusCode} status - status code of HTTPException
+ * @param {HTTPExceptionOptions} options - options of HTTPException
+ * @param {HTTPExceptionOptions["res"]} options.res - response of options of HTTPException
+ * @param {HTTPExceptionOptions["message"]} options.message - message of options of HTTPException
+ * @param {HTTPExceptionOptions["cause"]} options.cause - cause of options of HTTPException
+ *
+ * @example
+ * ```ts
+ * import { HTTPException } from 'hono/http-exception'
+ *
+ * // ...
+ *
+ * app.post('/auth', async (c, next) => {
+ *   // authentication
+ *   if (authorized === false) {
+ *     throw new HTTPException(401, { message: 'Custom error message' })
+ *   }
+ *   await next()
+ * })
+ * ```
+ */
+export declare class HTTPException extends Error {
+    readonly res?: Response;
+    readonly status: StatusCode;
+    /**
+     * Creates an instance of `HTTPException`.
+     * @param status - HTTP status code for the exception. Defaults to 500.
+     * @param options - Additional options for the exception.
+     */
+    constructor(status?: StatusCode, options?: HTTPExceptionOptions);
+    /**
+     * Returns the response object associated with the exception.
+     * If a response object is not provided, a new response is created with the error message and status code.
+     * @returns The response object.
+     */
+    getResponse(): Response;
+}
+
+/**
+ * Options for creating an `HTTPException`.
+ * @property res - Optional response object to use.
+ * @property message - Optional custom error message.
+ * @property cause - Optional cause of the error.
+ */
+declare type HTTPExceptionOptions = {
+    res?: Response;
+    message?: string;
+    cause?: unknown;
+};
+
+/**
+ * @module
+ * This module provides the `HTTPException` class.
+ */
+declare type InfoStatusCode = 100 | 101 | 102 | 103;
+
+export declare function listIndexes({ mastra, vectorName }: Pick<VectorContext, 'mastra' | 'vectorName'>): Promise<string[]>;
+
+export declare namespace logs {
+    export {
+        getLogsHandler,
+        getLogsByRunIdHandler,
+        getLogTransports
+    }
+}
+
+declare type LogsContext = {
+    mastra: Mastra;
+    transportId?: string;
+    runId?: string;
+};
+
+export declare namespace memory {
+    export {
+        getMemoryStatusHandler,
+        getThreadsHandler,
+        getThreadByIdHandler,
+        saveMessagesHandler,
+        createThreadHandler,
+        updateThreadHandler,
+        deleteThreadHandler,
+        getMessagesHandler
+    }
+}
+
+declare interface MemoryContext extends Context {
+    agentId?: string;
+    resourceId?: string;
+    threadId?: string;
+}
+
+export declare namespace network {
+    export {
+        getNetworksHandler,
+        getNetworkByIdHandler,
+        generateHandler_alias_1 as generateHandler,
+        streamGenerateHandler_alias_1 as streamGenerateHandler
+    }
+}
+
+declare interface NetworkContext extends Context {
+    networkId?: string;
+}
+
+declare interface QueryRequest {
+    indexName: string;
+    queryVector: number[];
+    topK?: number;
+    filter?: Record<string, any>;
+    includeVector?: boolean;
+}
+
+export declare function queryVectors({ mastra, vectorName, query, }: Pick<VectorContext, 'mastra' | 'vectorName'> & {
+    query: QueryRequest;
+}): Promise<QueryResult[]>;
+
+declare type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | DeprecatedStatusCode | 307 | 308;
+
+export declare function resumeAsyncWorkflowHandler({ mastra, workflowId, runId, body, }: WorkflowContext & {
+    body: {
+        stepId: string;
+        context: any;
+    };
+}): Promise<Omit<WorkflowRunResult<any, Step<string, any, any, StepExecutionContext<any, WorkflowContext_2<any, Step<string, any, any, any>[], Record<string, any>>>>[], any>, "runId"> | undefined>;
+
+export declare function resumeWorkflowHandler({ mastra, workflowId, runId, body, }: WorkflowContext & {
+    body: {
+        stepId: string;
+        context: any;
+    };
+}): Promise<{
+    message: string;
+}>;
+
+export declare function saveMessagesHandler({ mastra, agentId, body, }: Pick<MemoryContext, 'mastra' | 'agentId'> & {
+    body: {
+        messages: Parameters<MastraMemory['saveMessages']>[0]['messages'];
+    };
+}): Promise<MessageType[]>;
+
+declare type ServerErrorStatusCode = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
+
+export declare function startAsyncWorkflowHandler({ mastra, workflowId, runId, triggerData, }: Pick<WorkflowContext, 'mastra' | 'workflowId' | 'runId'> & {
+    triggerData?: unknown;
+}): Promise<{
+    runId: string;
+    timestamp: number;
+    result?: any;
+    results: {
+        [x: string]: {
+            status: "failed";
+            error: string;
+        } | {
+            status: "waiting";
+        } | {
+            status: "skipped";
+        } | {
+            status: "success";
+            output: unknown;
+        } | {
+            status: "suspended";
+            suspendPayload?: any;
+            output?: unknown;
+        } | {
+            status: "success";
+            output: any;
+        } | {
+            status: "suspended";
+            suspendPayload?: any;
+            output?: any;
+        };
+    };
+    triggerData?: any;
+    activePaths: Map<string, {
+        status: string;
+        suspendPayload?: any;
+        stepPath: string[];
+    }>;
+}>;
+
+export declare function startWorkflowRunHandler({ mastra, workflowId, runId, triggerData, }: Pick<WorkflowContext, 'mastra' | 'workflowId' | 'runId'> & {
+    triggerData?: unknown;
+}): Promise<{
+    message: string;
+}>;
+
+/**
+ * If you want to use an unofficial status, use `UnofficialStatusCode`.
+ */
+export declare type StatusCode = InfoStatusCode | SuccessStatusCode | RedirectStatusCode | ClientErrorStatusCode | ServerErrorStatusCode | UnofficialStatusCode;
+
+export declare function storeTelemetryHandler({ mastra, body }: Context & {
+    body: {
+        resourceSpans: any[];
+    };
+}): Promise<{
+    status: string;
+    message: string;
+    traceCount: number;
+} | {
+    status: string;
+    message: string;
+    error: any;
+}>;
+
+export declare function streamGenerateHandler({ mastra, agentId, body, }: Context & {
+    agentId: string;
+    body: GetBody<'stream'>;
+}): Promise<Response | undefined>;
+
+export declare function streamGenerateHandler_alias_1({ mastra, networkId, body, }: NetworkContext & {
+    body: {
+        messages?: Parameters<AgentNetwork['stream']>[0];
+    } & Parameters<AgentNetwork['stream']>[1];
+}): Promise<Response>;
+
+declare type SuccessStatusCode = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226;
+
+export declare namespace telemetry {
+    export {
+        getTelemetryHandler,
+        storeTelemetryHandler
+    }
+}
+
+declare interface TelemetryContext extends Context {
+    body?: {
+        name?: string;
+        scope?: string;
+        page?: number;
+        perPage?: number;
+        attribute?: string | string[];
+    };
+}
+
+export declare namespace tools {
+    export {
+        getToolsHandler,
+        getToolByIdHandler,
+        executeToolHandler,
+        executeAgentToolHandler
+    }
+}
+
+declare interface ToolsContext extends Context {
+    tools?: Record<string, ToolAction | VercelTool>;
+    toolId?: string;
+    runId?: string;
+}
+
+/**
+ * Transcribe speech to text
+ */
+export declare function transcribeSpeechHandler({ mastra, agentId, body, }: VoiceContext & {
+    body?: {
+        audioData?: Buffer;
+        options?: Parameters<NonNullable<Agent['voice']>['listen']>[1];
+    };
+}): Promise<{
+    text: string | void | NodeJS.ReadableStream;
+}>;
+
+/**
+ * @deprecated
+ * Use `UnofficialStatusCode` instead.
+ */
+export declare type UnOfficalStatusCode = UnofficialStatusCode;
+
+/**
+ * `UnofficialStatusCode` can be used to specify an unofficial status code.
+ * @example
+ *
+ * ```ts
+ * app.get('/unknown', (c) => {
+ *   return c.text("Unknown Error", 520 as UnofficialStatusCode)
+ * })
+ * ```
+ */
+export declare type UnofficialStatusCode = -1;
+
+export declare function updateThreadHandler({ mastra, agentId, threadId, body, }: Pick<MemoryContext, 'mastra' | 'agentId' | 'threadId'> & {
+    body?: Parameters<MastraMemory['saveThread']>[0]['thread'];
+}): Promise<StorageThreadType>;
+
+declare interface UpsertRequest {
+    indexName: string;
+    vectors: number[][];
+    metadata?: Record<string, any>[];
+    ids?: string[];
+}
+
+export declare function upsertVectors({ mastra, vectorName, index }: VectorContext & {
+    index: UpsertRequest;
+}): Promise<{
+    ids: string[];
+}>;
+
+export declare function validateBody(body: Record<string, unknown>): void;
+
+export declare namespace vector {
+    export {
+        upsertVectors,
+        createIndex,
+        queryVectors,
+        listIndexes,
+        describeIndex,
+        deleteIndex
+    }
+}
+
+declare interface VectorContext extends Context {
+    vectorName?: string;
+}
+
+export declare namespace voice {
+    export {
+        getSpeakersHandler,
+        generateSpeechHandler,
+        transcribeSpeechHandler
+    }
+}
+
+declare interface VoiceContext extends Context {
+    agentId?: string;
+}
+
+export declare function watchWorkflowHandler({ mastra, workflowId, runId, }: Pick<WorkflowContext, 'mastra' | 'workflowId' | 'runId'>): Promise<ReadableStream_2<string>>;
+
+declare interface WorkflowContext {
+    mastra: Mastra_2;
+    workflowId?: string;
+    runId?: string;
+}
+
+export declare namespace workflows {
+    export {
+        getWorkflowsHandler,
+        getWorkflowByIdHandler,
+        startAsyncWorkflowHandler,
+        getWorkflowRunHandler,
+        createRunHandler,
+        startWorkflowRunHandler,
+        watchWorkflowHandler,
+        resumeAsyncWorkflowHandler,
+        resumeWorkflowHandler
+    }
+}
+
+export { }