@o-zakstam/voltagent-convex 1.1.1 → 1.1.3

package/dist/index.d.cts

@@ -1,322 +0,0 @@
-import { StorageAdapter, OperationContext, GetMessagesOptions, ConversationStepRecord, GetConversationStepsOptions, CreateConversationInput, Conversation, ConversationQueryOptions, WorkingMemoryScope, WorkflowStateEntry } from '@voltagent/core';
-import { UIMessage } from 'ai';
-
-/**
- * Type definitions for VoltAgent Convex Memory Adapter
- */
-/**
- * Logger interface for the adapter
- */
-interface Logger {
-    debug: (message: string, ...args: unknown[]) => void;
-    info: (message: string, ...args: unknown[]) => void;
-    warn: (message: string, ...args: unknown[]) => void;
-    error: (message: string, ...args: unknown[]) => void;
-}
-/**
- * Convex client interface - compatible with ConvexHttpClient and ConvexReactClient.
- *
- * This interface is intentionally loose to accommodate different Convex client
- * implementations (ConvexHttpClient, ConvexReactClient) which have slightly
- * different method signatures.
- */
-interface ConvexClient {
-    query: (functionReference: any, ...args: any[]) => Promise<any>;
-    mutation: (functionReference: any, ...args: any[]) => Promise<any>;
-}
-/**
- * The VoltAgent API structure.
- * This matches the wrapper functions exported from the convex/api.ts file.
- */
-interface VoltAgentApi {
-    createConversation: unknown;
-    getConversation: unknown;
-    getConversations: unknown;
-    getConversationsByUserId: unknown;
-    queryConversations: unknown;
-    updateConversation: unknown;
-    deleteConversation: unknown;
-    addMessage: unknown;
-    addMessages: unknown;
-    getMessages: unknown;
-    clearMessages: unknown;
-    saveConversationSteps: unknown;
-    getConversationSteps: unknown;
-    getWorkingMemory: unknown;
-    setWorkingMemory: unknown;
-    deleteWorkingMemory: unknown;
-    getWorkflowState: unknown;
-    queryWorkflowRuns: unknown;
-    setWorkflowState: unknown;
-    updateWorkflowState: unknown;
-    getSuspendedWorkflowStates: unknown;
-}
-/**
- * Configuration options for ConvexMemoryAdapter
- */
-interface ConvexMemoryAdapterOptions {
-    /**
-     * The Convex client instance to use for queries and mutations.
-     * Can be a ConvexHttpClient or ConvexReactClient.
-     */
-    client: ConvexClient;
-    /**
-     * Whether to enable debug logging.
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Custom logger instance.
-     * If not provided, a default console logger will be used when debug is enabled.
-     */
-    logger?: Logger;
-    /**
-     * The VoltAgent API from your Convex generated code.
-     *
-     * After adding the voltagent.ts file to your convex folder that re-exports
-     * the wrapper functions, import the api and pass api.voltagent here.
-     *
-     * @example
-     * ```ts
-     * import { api } from "./convex/_generated/api";
-     *
-     * const adapter = new ConvexMemoryAdapter({
-     *   client,
-     *   api: api.voltagent,
-     * });
-     * ```
-     */
-    api: VoltAgentApi;
-}
-/**
- * Internal representation of a conversation in Convex
- */
-interface ConvexConversation {
-    _id: string;
-    visibleId: string;
-    resourceId: string;
-    userId: string;
-    title: string;
-    metadata: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Internal representation of a message in Convex
- */
-interface ConvexMessage {
-    _id: string;
-    visibleId: string;
-    conversationId: string;
-    userId: string;
-    role: string;
-    parts: unknown[];
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-}
-/**
- * Internal representation of a user in Convex
- */
-interface ConvexUser {
-    _id: string;
-    visibleId: string;
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Internal representation of a workflow state in Convex
- */
-interface ConvexWorkflowState {
-    _id: string;
-    visibleId: string;
-    workflowId: string;
-    workflowName: string;
-    status: string;
-    input?: unknown;
-    context?: unknown;
-    suspension?: unknown;
-    events?: unknown[];
-    output?: unknown;
-    cancellation?: unknown;
-    userId?: string;
-    conversationId?: string;
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Internal representation of a conversation step in Convex
- */
-interface ConvexConversationStep {
-    _id: string;
-    visibleId: string;
-    conversationId: string;
-    userId: string;
-    agentId: string;
-    agentName?: string;
-    operationId?: string;
-    stepIndex: number;
-    type: string;
-    role: string;
-    content?: string;
-    arguments?: Record<string, unknown>;
-    result?: Record<string, unknown>;
-    usage?: Record<string, unknown>;
-    subAgentId?: string;
-    subAgentName?: string;
-    createdAt: string;
-}
-
-/**
- * Convex Memory Adapter for VoltAgent
- *
- * A StorageAdapter implementation that persists conversation data
- * to Convex database using the VoltAgent Convex component.
- */
-
-/**
- * Convex Memory Adapter for VoltAgent
- *
- * Implements the StorageAdapter interface to persist conversation history,
- * working memory, and workflow state to a Convex database.
- *
- * @example
- * ```ts
- * import { ConvexHttpClient } from "convex/browser";
- * import { api } from "./convex/_generated/api";
- * import { ConvexMemoryAdapter } from "@voltagent/convex";
- *
- * const client = new ConvexHttpClient(process.env.CONVEX_URL);
- *
- * const adapter = new ConvexMemoryAdapter({
- *   client,
- *   api: api.voltagent,
- * });
- *
- * const memory = new Memory({ storage: adapter });
- * ```
- */
-declare class ConvexMemoryAdapter implements StorageAdapter {
-    private client;
-    private api;
-    private debug;
-    private logger;
-    constructor(options: ConvexMemoryAdapterOptions);
-    /**
-     * Log debug messages
-     */
-    private log;
-    /**
-     * Generate a cryptographically secure random ID
-     */
-    private generateId;
-    /**
-     * Add a single message to a conversation
-     */
-    addMessage(message: UIMessage, userId: string, conversationId: string, _context?: OperationContext): Promise<void>;
-    /**
-     * Add multiple messages to a conversation
-     */
-    addMessages(messages: UIMessage[], userId: string, conversationId: string, _context?: OperationContext): Promise<void>;
-    /**
-     * Get messages from a conversation with optional filtering
-     */
-    getMessages(userId: string, conversationId: string, options?: GetMessagesOptions, _context?: OperationContext): Promise<UIMessage<{
-        createdAt: Date;
-    }>[]>;
-    /**
-     * Clear messages for a user (optionally for a specific conversation)
-     */
-    clearMessages(userId: string, conversationId?: string, _context?: OperationContext): Promise<void>;
-    /**
-     * Save conversation steps for observability
-     */
-    saveConversationSteps(steps: ConversationStepRecord[]): Promise<void>;
-    /**
-     * Get conversation steps for observability
-     */
-    getConversationSteps(userId: string, conversationId: string, options?: GetConversationStepsOptions): Promise<ConversationStepRecord[]>;
-    /**
-     * Create a new conversation
-     */
-    createConversation(input: CreateConversationInput): Promise<Conversation>;
-    /**
-     * Get a conversation by ID
-     */
-    getConversation(id: string): Promise<Conversation | null>;
-    /**
-     * Get conversations by resource ID
-     */
-    getConversations(resourceId: string): Promise<Conversation[]>;
-    /**
-     * Get conversations by user ID with optional query options
-     */
-    getConversationsByUserId(userId: string, options?: Omit<ConversationQueryOptions, "userId">): Promise<Conversation[]>;
-    /**
-     * Query conversations with filters
-     */
-    queryConversations(options: ConversationQueryOptions): Promise<Conversation[]>;
-    /**
-     * Update a conversation
-     */
-    updateConversation(id: string, updates: Partial<Omit<Conversation, "id" | "createdAt" | "updatedAt">>): Promise<Conversation>;
-    /**
-     * Delete a conversation and its associated data
-     */
-    deleteConversation(id: string): Promise<void>;
-    /**
-     * Get working memory content
-     */
-    getWorkingMemory(params: {
-        conversationId?: string;
-        userId?: string;
-        scope: WorkingMemoryScope;
-    }): Promise<string | null>;
-    /**
-     * Set working memory content
-     */
-    setWorkingMemory(params: {
-        conversationId?: string;
-        userId?: string;
-        content: string;
-        scope: WorkingMemoryScope;
-    }): Promise<void>;
-    /**
-     * Delete working memory content
-     */
-    deleteWorkingMemory(params: {
-        conversationId?: string;
-        userId?: string;
-        scope: WorkingMemoryScope;
-    }): Promise<void>;
-    /**
-     * Get workflow state by execution ID
-     */
-    getWorkflowState(executionId: string): Promise<WorkflowStateEntry | null>;
-    /**
-     * Query workflow runs with optional filters
-     */
-    queryWorkflowRuns(query: {
-        workflowId?: string;
-        status?: WorkflowStateEntry["status"];
-        from?: Date;
-        to?: Date;
-        limit?: number;
-        offset?: number;
-    }): Promise<WorkflowStateEntry[]>;
-    /**
-     * Set workflow state
-     */
-    setWorkflowState(executionId: string, state: WorkflowStateEntry): Promise<void>;
-    /**
-     * Update workflow state
-     */
-    updateWorkflowState(executionId: string, updates: Partial<WorkflowStateEntry>): Promise<void>;
-    /**
-     * Get suspended workflow states for a workflow
-     */
-    getSuspendedWorkflowStates(workflowId: string): Promise<WorkflowStateEntry[]>;
-}
-
-export { type ConvexClient, type ConvexConversation, type ConvexConversationStep, ConvexMemoryAdapter, type ConvexMemoryAdapterOptions, type ConvexMessage, type ConvexUser, type ConvexWorkflowState, type Logger, type VoltAgentApi };