@ai-setting/roy-agent-core 1.5.17-beta.1 → 1.5.22

package/dist/env/session/storage/index.d.ts

@@ -1,564 +0,0 @@
-/**
-* Checkpoint type
-*/
-type CheckpointType = "compact" | "manual";
-/**
-* Checkpoint metadata (stored in Session.metadata)
-*/
-interface CheckpointMeta {
-	id: string;
-	messageIndex: number;
-	title: string;
-	createdAt: number;
-	type: CheckpointType;
-}
-/**
-* User Intent type - represents a user's intent extracted from conversation
-*/
-type UserIntent = string;
-/**
-* Recent message for checkpoint
-* 
-* Stores a simplified version of a message for context preservation
-*/
-interface RecentMessage {
-	role: string;
-	content: string;
-}
-/**
-* Complete checkpoint information (includes generated content)
-*/
-interface SessionCheckpoint extends CheckpointMeta {
-	summary: string;
-	processKeyPoints: string[];
-	currentState: string;
-	nextSteps: string[];
-	messageCountBefore: number;
-	metadata?: Record<string, unknown>;
-	/** User intents extracted from the conversation */
-	userIntents: UserIntent[];
-	/**
-	* Recent messages preserved from the compacted conversation
-	* 
-	* Contains the last N turns of user query + assistant text response
-	* (excluding tool calls and tool results).
-	* This allows the checkpoint to serve as a fresh history context.
-	* 
-	* Format: [user, assistant, user, assistant, ...] from most recent
-	*/
-	recentMessages?: RecentMessage[];
-}
-/**
-* Checkpoints metadata in session
-*/
-interface SessionCheckpointsMeta {
-	latestCheckpointId?: string;
-	checkpoints: CheckpointMeta[];
-}
-/**
-* Session entity
-*/
-interface Session {
-	id: string;
-	title: string;
-	directory: string;
-	parentID?: string;
-	createdAt: number;
-	updatedAt: number;
-	messageCount: number;
-	metadata?: SessionMetadata;
-}
-/**
-* Session metadata
-*/
-interface SessionMetadata extends Record<string, unknown> {
-	/** Total number of messages in the session */
-	messageCount?: number;
-	checkpoints?: SessionCheckpointsMeta;
-	checkpointDetails?: Record<string, SessionCheckpoint>;
-}
-/**
-* Session message
-*/
-interface SessionMessage {
-	id: string;
-	sessionID: string;
-	role: Role;
-	content: string;
-	timestamp: number;
-	parts?: MessagePart[];
-	/** Whether the message has been archived (compacted) */
-	isArchived?: boolean;
-	/** Timestamp when the message was archived */
-	archivedAt?: number;
-	/** Checkpoint ID this message belongs to */
-	checkpointId?: string;
-	/** Message metadata (includes checkpoint info if this is a checkpoint message) */
-	metadata?: MessageMetadata;
-}
-/**
-* Message metadata
-*/
-interface MessageMetadata extends Record<string, unknown> {
-	/** 消息类型标识，用于过滤和分类 */
-	type?: "tool_call" | "tool_result" | "checkpoint" | "user_intent" | "workflow.node.start" | "workflow.node.interrupt" | "workflow.node.end" | "workflow.node.resume";
-	isCheckpoint?: boolean;
-	checkpointId?: string;
-	checkpointMeta?: SessionCheckpoint;
-	/** Workflow node ID (for workflow.node.* messages) */
-	workflowNodeId?: string;
-	/** Workflow node type (for workflow.node.* messages) */
-	workflowNodeType?: string;
-	/** Agent session ID (for agent nodes in workflow) */
-	agentSessionId?: string;
-	/** User response (for workflow.node.resume messages) */
-	response?: string;
-	/** Success flag (for workflow.node.end messages) */
-	success?: boolean;
-}
-/**
-* Message role
-*/
-type Role = "user" | "assistant" | "system" | "tool" | "workflow.node.start" | "workflow.node.interrupt" | "workflow.node.end" | "workflow.node.resume";
-/**
-* Message part
-*/
-type MessagePart = SessionPart;
-/**
-* Text part - plain text content
-*/
-interface TextPart {
-	type: "text";
-	content: string;
-	/** If true, this part was generated by the system (e.g., auto-summary) */
-	synthetic?: boolean;
-	/** If true, this part should be ignored (e.g., replaced by reasoning) */
-	ignored?: boolean;
-}
-/**
-* Tool call part - represents a tool invocation
-*/
-interface ToolCallPart {
-	type: "tool-call";
-	/** AI SDK standard field name */
-	toolCallId: string;
-	toolName: string;
-	/** Tool arguments - can be string (JSON) or object */
-	arguments: string | Record<string, unknown>;
-	state: "pending" | "running";
-}
-/**
-* Tool result part - represents the result of a tool execution
-*/
-interface ToolResultPart {
-	type: "tool-result";
-	toolCallId: string;
-	toolName: string;
-	output: string;
-	error?: string;
-	state: "completed" | "error";
-}
-/**
-* Reasoning part - AI thinking/thought content
-*/
-interface ReasoningPart {
-	type: "reasoning";
-	/** Reasoning content */
-	content: string;
-	/** Reasoning type (for different models) */
-	reasoningType?: "core" | "effort" | "summary";
-	/** State */
-	state?: "thinking" | "completed";
-	/** Whether to collapse by default (like AI SDK default) */
-	isCollapsed?: boolean;
-	/** Metadata */
-	metadata?: {
-		tokenCount?: number;
-		time?: {
-			start: number;
-			end?: number;
-		};
-	};
-}
-/**
-* File part - file attachment
-*/
-interface FilePart {
-	type: "file";
-	mime: string;
-	url: string;
-	filename?: string;
-}
-/**
-* Checkpoint part - compaction checkpoint marker
-* 
-* Represents a checkpoint message in the conversation history.
-* This is stored as a user role message with markdown content summarizing
-* the compacted conversation segment.
-*/
-interface CheckpointPart {
-	type: "checkpoint";
-	/** Checkpoint ID reference */
-	checkpointId: string;
-	/** Markdown content summarizing the checkpoint */
-	content: string;
-	/** Title of the checkpoint */
-	title?: string;
-	/** Process key points */
-	processKeyPoints?: string[];
-	/** Current state description */
-	currentState?: string;
-	/** Next steps */
-	nextSteps?: string[];
-	/** Number of messages that were compacted */
-	messageCountBefore?: number;
-	/** Creation timestamp */
-	createdAt?: number;
-}
-/**
-* Union type for all Session Part types
-*/
-type SessionPart = TextPart | ToolCallPart | ToolResultPart | ReasoningPart | FilePart | CheckpointPart | WorkflowNodeStartPart | WorkflowNodeInterruptPart | WorkflowNodeEndPart | WorkflowNodeResumePart;
-/**
-* workflow.node.start 消息 part (对应 tool-call)
-*/
-interface WorkflowNodeStartPart {
-	type: "workflow-node-start";
-	nodeId: string;
-	nodeType: string;
-	input?: unknown;
-	startTime: number;
-	/** Agent session ID (only for agent nodes) */
-	agentSessionId?: string;
-}
-/**
-* workflow.node.interrupt 消息 part
-*/
-interface WorkflowNodeInterruptPart {
-	type: "workflow-node-interrupt";
-	nodeId: string;
-	nodeType: string;
-	query: string;
-	options?: string[];
-	timestamp: number;
-	/** Agent session ID (only for agent nodes) */
-	agentSessionId?: string;
-}
-/**
-* workflow.node.end 消息 part (对应 tool-result)
-*/
-interface WorkflowNodeEndPart {
-	type: "workflow-node-end";
-	nodeId: string;
-	nodeType: string;
-	output?: unknown;
-	error?: string;
-	durationMs: number;
-	/** Agent session ID (only for agent nodes) */
-	agentSessionId?: string;
-}
-/**
-* workflow.node.resume 消息 part
-*/
-interface WorkflowNodeResumePart {
-	type: "workflow-node-resume";
-	nodeId: string;
-	response: string;
-	timestamp: number;
-	/** Agent session ID (only for agent nodes) */
-	agentSessionId?: string;
-}
-/**
-* Options for creating a session
-*/
-interface CreateSessionOptions {
-	/** Custom session ID (optional, will be generated if not provided) */
-	id?: string;
-	title?: string;
-	directory?: string;
-	parentID?: string;
-	metadata?: Record<string, unknown>;
-	hooks?: SessionHooksConfig;
-}
-/**
-* Options for updating a session
-*/
-interface UpdateSessionOptions {
-	title?: string;
-	metadata?: Record<string, unknown>;
-}
-/**
-* Options for listing sessions
-*/
-interface ListSessionsOptions {
-	filter?: {
-		metadata?: Record<string, unknown>;
-		startTime?: number;
-		endTime?: number;
-	};
-	sort?: {
-		field: "updatedAt" | "createdAt" | "title";
-		order: "asc" | "desc";
-	};
-	offset?: number;
-	limit?: number;
-}
-/**
-* Options for getting messages
-*/
-interface GetMessagesOptions {
-	/** Include archived messages */
-	includeArchived?: boolean;
-	/** From checkpoint ID */
-	fromCheckpointId?: string;
-	/** Reverse order */
-	reverse?: boolean;
-}
-/**
-* Session hook callback
-*/
-type SessionHookCallback = (context?: any) => Promise<void>;
-/**
-* Session hook definition
-*/
-interface SessionHook {
-	name: string;
-	before?: SessionHookCallback;
-	after?: SessionHookCallback;
-}
-/**
-* Session hooks configuration
-*/
-interface SessionHooksConfig {
-	[key: string]: SessionHook[];
-}
-/**
-* Options for searching messages
-*/
-interface SearchMessagesOptions {
-	/** Search query (supports AND/OR/NOT syntax) */
-	query: string;
-	/** Limit search to specific session ID */
-	sessionId?: string;
-	/** Maximum number of results per session */
-	limit?: number;
-	/** Maximum total results */
-	maxResults?: number;
-	/** Only search messages before this timestamp */
-	beforeTime?: number;
-	/** Only search messages after this timestamp */
-	afterTime?: number;
-	/** Include archived messages */
-	includeArchived?: boolean;
-	/** Include context (messages before/after matches) */
-	includeContext?: boolean;
-	/** Number of context lines before/after */
-	contextLines?: number;
-}
-/**
-* A single message match
-*/
-interface MessageMatch {
-	/** Message ID */
-	messageId: string;
-	/** Session ID */
-	sessionId: string;
-	/** Message role */
-	role: Role;
-	/** Message content */
-	content: string;
-	/** Message timestamp */
-	timestamp: number;
-	/** Context before the match (if enabled) */
-	contextBefore?: string;
-	/** Context after the match (if enabled) */
-	contextAfter?: string;
-	/** Match score (relevance) */
-	score?: number;
-}
-/**
-* Session Store Interface
-* Defines the contract for session storage implementations
-*/
-interface SessionStore {
-	/**
-	* Create a new session
-	*/
-	create(options: CreateSessionOptions): Promise<Session>;
-	/**
-	* Get a session by ID
-	*/
-	get(id: string): Promise<Session | undefined>;
-	/**
-	* List sessions with optional filtering
-	*/
-	list(options?: ListSessionsOptions): Promise<Session[]>;
-	/**
-	* Update a session
-	*/
-	update(id: string, updates: UpdateSessionOptions): Promise<boolean>;
-	/**
-	* Delete a session
-	*/
-	delete(id: string): Promise<boolean>;
-	/**
-	* Get total session count (without pagination)
-	*/
-	getCount(): Promise<number>;
-	/**
-	* Add a message to a session
-	*/
-	addMessage(sessionId: string, message: {
-		role: string;
-		content: string;
-		parts?: unknown[];
-		metadata?: Record<string, unknown>;
-	}): Promise<string>;
-	/**
-	* Get messages from a session
-	* @param sessionId - Session ID
-	* @param offset - Starting index
-	* @param limit - Number of messages to return
-	* @param options - Additional options (includeArchived, fromCheckpointId, reverse)
-	*/
-	getMessages(sessionId: string, offset?: number, limit?: number, options?: GetMessagesOptions): Promise<SessionMessage[]>;
-	/**
-	* Get message indexes by role
-	* @param sessionId - Session ID
-	* @param role - Role to filter by
-	*/
-	getMessageIndexes(sessionId: string, role: string): Promise<number[]>;
-	/**
-	* Get message count for a session
-	* @param sessionId - Session ID
-	* @param includeArchived - Whether to include archived messages
-	*/
-	getMessageCount(sessionId: string, includeArchived?: boolean): Promise<number>;
-	/**
-	* Save a checkpoint to session metadata
-	*/
-	saveCheckpoint(sessionId: string, checkpoint: SessionCheckpoint): Promise<void>;
-	/**
-	* Get all checkpoints for a session
-	*/
-	getCheckpoints(sessionId: string): Promise<SessionCheckpoint[]>;
-	/**
-	* Get a specific checkpoint
-	*/
-	getCheckpoint(sessionId: string, checkpointId: string): Promise<SessionCheckpoint | undefined>;
-	/**
-	* Delete a checkpoint and restore archived messages
-	*/
-	deleteCheckpoint(sessionId: string, checkpointId: string): Promise<boolean>;
-	/**
-	* Archive messages (mark as archived for compact)
-	* @returns Number of messages archived
-	*/
-	archiveMessages(sessionId: string, checkpointId: string, beforeIndex: number): Promise<number>;
-	/**
-	* Get active (non-archived) messages only
-	*/
-	getActiveMessages(sessionId: string, offset?: number, limit?: number): Promise<SessionMessage[]>;
-	/**
-	* Close and cleanup resources
-	*/
-	close(): Promise<void>;
-	/**
-	* Search messages across all sessions
-	* 
-	* @param options - Search options including query, session filter, time range
-	* @returns Array of message matches
-	*/
-	searchMessages(options: SearchMessagesOptions): Promise<MessageMatch[]>;
-}
-/**
-* Memory-based Session Store with checkpoint support
-*/
-declare class MemorySessionStore implements SessionStore {
-	private sessions;
-	private messages;
-	private checkpoints;
-	private messageConverter;
-	create(options: CreateSessionOptions): Promise<Session>;
-	get(id: string): Promise<Session | undefined>;
-	list(options?: ListSessionsOptions): Promise<Session[]>;
-	update(id: string, updates: UpdateSessionOptions): Promise<boolean>;
-	delete(id: string): Promise<boolean>;
-	getCount(): Promise<number>;
-	addMessage(sessionId: string, message: {
-		role: string;
-		content: string;
-		parts?: unknown[];
-		metadata?: Record<string, unknown>;
-	}): Promise<string>;
-	getMessages(sessionId: string, offset?: number, limit?: number, options?: GetMessagesOptions): Promise<SessionMessage[]>;
-	getMessageCount(sessionId: string, includeArchived?: boolean): Promise<number>;
-	getMessageIndexes(sessionId: string, role: string): Promise<number[]>;
-	saveCheckpoint(sessionId: string, checkpoint: SessionCheckpoint): Promise<void>;
-	getCheckpoints(sessionId: string): Promise<SessionCheckpoint[]>;
-	getCheckpoint(sessionId: string, checkpointId: string): Promise<SessionCheckpoint | undefined>;
-	deleteCheckpoint(sessionId: string, checkpointId: string): Promise<boolean>;
-	archiveMessages(sessionId: string, checkpointId: string, beforeIndex: number): Promise<number>;
-	getActiveMessages(sessionId: string, offset?: number, limit?: number): Promise<SessionMessage[]>;
-	searchMessages(options: SearchMessagesOptions): Promise<MessageMatch[]>;
-	/**
-	* Parse simple query into terms
-	*/
-	private parseQuery;
-	close(): Promise<void>;
-}
-/**
-* Get default data directory for session storage
-*/
-declare function getDefaultDataDir(): string;
-/**
-* Get default database path for session storage
-*/
-declare function getDefaultSessionDbPath(): string;
-/**
-* SQLite-based Session Store with checkpoint support
-* 
-* Provides persistent storage for sessions and messages using SQLite.
-* Follows the same interface as MemorySessionStore but persists to disk.
-*/
-declare class SQLiteSessionStore implements SessionStore {
-	private db;
-	private dbPath;
-	private initialized;
-	private sessionsCache;
-	private messagesCache;
-	private checkpointsCache;
-	private messageConverter;
-	constructor(dbPath?: string);
-	private initialize;
-	create(options: CreateSessionOptions): Promise<Session>;
-	get(id: string): Promise<Session | undefined>;
-	list(options?: ListSessionsOptions): Promise<Session[]>;
-	getCount(): Promise<number>;
-	update(id: string, updates: UpdateSessionOptions): Promise<boolean>;
-	delete(id: string): Promise<boolean>;
-	addMessage(sessionId: string, message: {
-		role: string;
-		content: string;
-		parts?: unknown[];
-		metadata?: Record<string, unknown>;
-	}): Promise<string>;
-	getMessages(sessionId: string, offset?: number, limit?: number, options?: GetMessagesOptions): Promise<SessionMessage[]>;
-	getMessageCount(sessionId: string, includeArchived?: boolean): Promise<number>;
-	getMessageIndexes(sessionId: string, role: string): Promise<number[]>;
-	saveCheckpoint(sessionId: string, checkpoint: SessionCheckpoint): Promise<void>;
-	getCheckpoints(sessionId: string): Promise<SessionCheckpoint[]>;
-	getCheckpoint(sessionId: string, checkpointId: string): Promise<SessionCheckpoint | undefined>;
-	deleteCheckpoint(sessionId: string, checkpointId: string): Promise<boolean>;
-	archiveMessages(sessionId: string, checkpointId: string, beforeIndex: number): Promise<number>;
-	getActiveMessages(sessionId: string, offset?: number, limit?: number): Promise<SessionMessage[]>;
-	searchMessages(options: SearchMessagesOptions): Promise<MessageMatch[]>;
-	/**
-	* Parse simple query into terms
-	*/
-	private parseQuery;
-	close(): Promise<void>;
-	private rowToSession;
-	private rowToMessage;
-}
-export { getDefaultSessionDbPath, getDefaultDataDir, SQLiteSessionStore, MemorySessionStore };