chattercatcher 0.1.19 → 0.1.21

package/dist/index.d.ts

@@ -59,6 +59,9 @@ declare const appSecretsSchema: z.ZodObject<{
     multimodal: z.ZodPipe<z.ZodTransform<{}, unknown>, z.ZodObject<{
         apiKey: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
+    web: z.ZodPipe<z.ZodTransform<{}, unknown>, z.ZodObject<{
+        actionToken: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 type AppConfig = z.infer<typeof appConfigSchema>;
 type AppSecrets = z.infer<typeof appSecretsSchema>;
@@ -83,11 +86,217 @@ declare function resolveEmbeddingApiKey(input: {
     llmApiKey: string;
 }): string;
 
+interface ChatRecord {
+    id: string;
+    platform: string;
+    platformChatId: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface MessageRecord {
+    id: string;
+    platform: string;
+    platformMessageId: string;
+    chatId: string;
+    senderId: string;
+    senderName: string;
+    messageType: string;
+    text: string;
+    rawPayloadJson: string;
+    sentAt: string;
+    receivedAt: string;
+    createdAt: string;
+}
+interface FileRecord {
+    messageId: string;
+    fileName: string;
+    sourcePath?: string;
+    storedPath?: string;
+    bytes?: number;
+    characters: number;
+    parser?: string;
+    parserWarnings?: string[];
+    importedAt: string;
+}
+interface IngestMessageInput {
+    platform: string;
+    platformChatId: string;
+    chatName: string;
+    platformMessageId: string;
+    senderId: string;
+    senderName: string;
+    messageType: string;
+    text: string;
+    rawPayload?: unknown;
+    sentAt: string;
+}
+interface CreateImageSummaryMessageInput {
+    sourceMessageId: string;
+    imageKey: string;
+    summary: string;
+    reason?: string;
+    multimodalModel: string;
+    generatedAt: string;
+}
+interface MessageSearchScope {
+    platform?: string;
+    platformChatId?: string;
+}
+interface MessageSearchResult {
+    chunkId: string;
+    messageId: string;
+    platform: string;
+    text: string;
+    score: number;
+    messageType: string;
+    chatName: string;
+    senderName: string;
+    sentAt: string;
+}
+
+type SourceType = "message" | "episode" | "file" | "image" | "audio" | "link" | "feishu_doc";
+interface EvidenceSource {
+    type: SourceType;
+    label: string;
+    timestamp?: string;
+    sender?: string;
+    location?: string;
+}
+interface EvidenceBlock {
+    id: string;
+    text: string;
+    score: number;
+    source: EvidenceSource;
+}
+interface Citation {
+    marker: string;
+    evidenceId: string;
+    source: EvidenceSource;
+    text: string;
+}
+interface GroundedAnswer {
+    answer: string;
+    citations: Citation[];
+}
+interface ToolCall {
+    id: string;
+    name: string;
+    input: unknown;
+}
+interface ChatMessage {
+    role: "system" | "user" | "assistant" | "tool";
+    content: string;
+    toolCallId?: string;
+    toolCalls?: ToolCall[];
+    reasoningContent?: string;
+}
+interface ChatTool {
+    name: string;
+    description: string;
+    inputSchema: Record<string, unknown>;
+}
+interface ToolChatResult {
+    content: string;
+    toolCalls: ToolCall[];
+    reasoningContent?: string;
+}
+interface ChatModel {
+    complete(messages: ChatMessage[]): Promise<string>;
+    completeWithTools?(messages: ChatMessage[], tools: ChatTool[]): Promise<ToolChatResult>;
+}
+
+type RetrievalScope = MessageSearchScope;
+interface Retriever {
+    retrieve(question: string, scope?: RetrievalScope): Promise<EvidenceBlock[]>;
+}
+
+interface RagSearchTool extends ChatTool {
+    execute(input: unknown): Promise<EvidenceBlock[]>;
+}
+
+interface GenerateCronJobMessageInput {
+    prompt: string;
+    model: ChatModel;
+    tools: RagSearchTool[];
+    now: Date;
+    maxModelTurns?: number;
+    maxToolCalls?: number;
+}
+declare function generateCronJobMessage(input: GenerateCronJobMessageInput): Promise<string>;
+
 type SqliteDatabase = Database.Database;
 declare function getDatabasePath(config: AppConfig): string;
 declare function openDatabase(config: AppConfig): SqliteDatabase;
 declare function migrateDatabase(database: SqliteDatabase): void;
 
+type CronJobStatus = "active" | "deleted";
+interface CronJobRecord {
+    id: string;
+    chatId: string;
+    createdByOpenId?: string;
+    schedule: string;
+    prompt: string;
+    status: CronJobStatus;
+    lastRunAt?: string;
+    nextRunAt: string;
+    lastError?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CronJobRepositoryOptions {
+    now?: () => Date;
+}
+declare class CronJobRepository {
+    private readonly database;
+    private readonly now;
+    constructor(database: SqliteDatabase, options?: CronJobRepositoryOptions);
+    create(input: {
+        chatId: string;
+        createdByOpenId?: string;
+        schedule: string;
+        prompt: string;
+    }): CronJobRecord;
+    get(id: string): CronJobRecord | null;
+    list(limit?: number): CronJobRecord[];
+    listByChat(chatId: string, limit?: number): CronJobRecord[];
+    listDue(now: Date, limit?: number): CronJobRecord[];
+    deleteByChat(id: string, chatId: string): boolean;
+    markSuccess(id: string, ranAt: Date): void;
+    markFailure(id: string, error: string, failedAt: Date): void;
+    private listByWhere;
+}
+
+declare function isValidCronSchedule(schedule: string): boolean;
+declare function matchesCronSchedule(schedule: string, date: Date): boolean;
+declare function getNextCronRun(schedule: string, after: Date): Date | null;
+
+interface CronJobScheduler {
+    start(): void;
+    stop(): void;
+    runDueNow(): Promise<void>;
+}
+interface CreateCronJobSchedulerOptions {
+    repository: Pick<CronJobRepository, "listDue" | "markSuccess" | "markFailure">;
+    generateMessage: (job: CronJobRecord, now: Date) => Promise<string>;
+    sendTextToChat: (chatId: string, text: string) => Promise<void>;
+    now?: () => Date;
+    setIntervalFn?: typeof setInterval;
+    clearIntervalFn?: typeof clearInterval;
+    logger?: Pick<Console, "error">;
+}
+declare function createCronJobScheduler(options: CreateCronJobSchedulerOptions): CronJobScheduler;
+
+interface CronJobTool extends ChatTool {
+    execute(input: unknown): Promise<string>;
+}
+interface CreateCronJobToolsInput {
+    repository: CronJobRepository;
+    chatId: string;
+    createdByOpenId?: string;
+}
+declare function createCronJobTools(input: CreateCronJobToolsInput): CronJobTool[];
+
 type DeleteTargetType = "message" | "chat" | "file";
 interface DeleteLocalDataResult {
     targetType: DeleteTargetType;
@@ -146,55 +355,6 @@ declare function restoreLocalData(input: {
     replace?: boolean;
 }): Promise<DataRestoreResult>;
 
-type SourceType = "message" | "episode" | "file" | "image" | "audio" | "link" | "feishu_doc";
-interface EvidenceSource {
-    type: SourceType;
-    label: string;
-    timestamp?: string;
-    sender?: string;
-    location?: string;
-}
-interface EvidenceBlock {
-    id: string;
-    text: string;
-    score: number;
-    source: EvidenceSource;
-}
-interface Citation {
-    marker: string;
-    evidenceId: string;
-    source: EvidenceSource;
-    text: string;
-}
-interface GroundedAnswer {
-    answer: string;
-    citations: Citation[];
-}
-interface ToolCall {
-    id: string;
-    name: string;
-    input: unknown;
-}
-interface ChatMessage {
-    role: "system" | "user" | "assistant" | "tool";
-    content: string;
-    toolCallId?: string;
-    toolCalls?: ToolCall[];
-}
-interface ChatTool {
-    name: string;
-    description: string;
-    inputSchema: Record<string, unknown>;
-}
-interface ToolChatResult {
-    content: string;
-    toolCalls: ToolCall[];
-}
-interface ChatModel {
-    complete(messages: ChatMessage[]): Promise<string>;
-    completeWithTools?(messages: ChatMessage[], tools: ChatTool[]): Promise<ToolChatResult>;
-}
-
 interface ProcessEpisodesResult {
     created: number;
 }
@@ -206,71 +366,6 @@ declare function processEpisodesNow(input: {
     now?: Date;
 }): Promise<ProcessEpisodesResult>;
 
-interface ChatRecord {
-    id: string;
-    platform: string;
-    platformChatId: string;
-    name: string;
-    createdAt: string;
-    updatedAt: string;
-}
-interface MessageRecord {
-    id: string;
-    platform: string;
-    platformMessageId: string;
-    chatId: string;
-    senderId: string;
-    senderName: string;
-    messageType: string;
-    text: string;
-    rawPayloadJson: string;
-    sentAt: string;
-    receivedAt: string;
-    createdAt: string;
-}
-interface FileRecord {
-    messageId: string;
-    fileName: string;
-    sourcePath?: string;
-    storedPath?: string;
-    bytes?: number;
-    characters: number;
-    parser?: string;
-    parserWarnings?: string[];
-    importedAt: string;
-}
-interface IngestMessageInput {
-    platform: string;
-    platformChatId: string;
-    chatName: string;
-    platformMessageId: string;
-    senderId: string;
-    senderName: string;
-    messageType: string;
-    text: string;
-    rawPayload?: unknown;
-    sentAt: string;
-}
-interface CreateImageSummaryMessageInput {
-    sourceMessageId: string;
-    imageKey: string;
-    summary: string;
-    reason?: string;
-    multimodalModel: string;
-    generatedAt: string;
-}
-interface MessageSearchResult {
-    chunkId: string;
-    messageId: string;
-    platform: string;
-    text: string;
-    score: number;
-    messageType: string;
-    chatName: string;
-    senderName: string;
-    sentAt: string;
-}
-
 interface EpisodeMessage {
     id: string;
     chatId: string;
@@ -327,7 +422,7 @@ declare class EpisodeRepository {
     }): Promise<EpisodeSummaryRecord | undefined>;
     getEpisodeCount(): number;
     listRecentEpisodes(limit?: number): EpisodeListItem[];
-    searchEpisodes(query: string, limit?: number): EpisodeSearchResult[];
+    searchEpisodes(query: string, limit?: number, scope?: MessageSearchScope): EpisodeSearchResult[];
 }
 
 declare function sanitizeEpisodeSummary(summary: string): string;
@@ -633,6 +728,12 @@ interface FeishuGatewayOptions {
         database: SqliteDatabase;
     };
     indexingScheduler?: IndexingScheduler;
+    cronJobProcessor?: {
+        database: SqliteDatabase;
+        model: ChatModel;
+        sender: Pick<MessageSender, "sendTextToChat">;
+    };
+    cronJobScheduler?: CronJobScheduler;
     wsClientFactory?: (params: {
         appId: string;
         appSecret: string;
@@ -675,6 +776,7 @@ declare class MessageRepository {
     listMessageChunksByMessageIds(messageIds: string[], limit?: number): MessageSearchResult[];
     searchMessages(query: string, limit?: number, options?: {
         excludeMessageIds?: string[];
+        scope?: MessageSearchScope;
     }): MessageSearchResult[];
     getChatCount(): number;
     getMessageCount(): number;
@@ -870,18 +972,15 @@ declare function formatCitations(citations: Citation[], options?: {
     maxTextLength?: number;
 }): string;
 
-interface Retriever {
-    retrieve(question: string): Promise<EvidenceBlock[]>;
-}
-
 interface HybridRetrieverOptions {
     limit?: number;
+    scope?: RetrievalScope;
 }
 declare class HybridRetriever implements Retriever {
     private readonly retrievers;
     private readonly options;
     constructor(retrievers: Retriever[], options?: HybridRetrieverOptions);
-    retrieve(question: string): Promise<EvidenceBlock[]>;
+    retrieve(question: string, scope?: RetrievalScope): Promise<EvidenceBlock[]>;
 }
 
 interface VectorRecord {
@@ -894,12 +993,12 @@ interface VectorSearchResult extends EvidenceBlock {
 }
 interface VectorStore {
     upsert(records: VectorRecord[]): Promise<void>;
-    search(vector: number[], limit: number): Promise<VectorSearchResult[]>;
+    search(vector: number[], limit: number, scope?: MessageSearchScope): Promise<VectorSearchResult[]>;
 }
 declare class MemoryVectorStore implements VectorStore {
     private readonly records;
     upsert(records: VectorRecord[]): Promise<void>;
-    search(vector: number[], limit: number): Promise<VectorSearchResult[]>;
+    search(vector: number[], limit: number, _scope?: MessageSearchScope): Promise<VectorSearchResult[]>;
 }
 
 interface VectorIndexStats {
@@ -914,10 +1013,6 @@ declare function indexMessageChunks(input: {
     messageIds?: string[];
 }): Promise<VectorIndexStats>;
 
-interface RagSearchTool extends ChatTool {
-    execute(input: unknown): Promise<EvidenceBlock[]>;
-}
-
 declare function hasEmbeddingConfig(config: AppConfig, secrets: AppSecrets): boolean;
 declare function createHybridRetriever(input: {
     config: AppConfig;
@@ -925,6 +1020,7 @@ declare function createHybridRetriever(input: {
     database: SqliteDatabase;
     messages: MessageRepository;
     excludeMessageIds?: string[];
+    scope?: MessageSearchScope;
 }): Promise<{
     retriever: Retriever;
     close: () => void;
@@ -935,6 +1031,7 @@ declare function createAgenticRagSearchTools(input: {
     database: SqliteDatabase;
     messages: MessageRepository;
     excludeMessageIds?: string[];
+    scope?: MessageSearchScope;
 }): Promise<{
     tools: RagSearchTool[];
     close: () => void;
@@ -962,7 +1059,7 @@ declare class MessageFtsRetriever implements Retriever {
     constructor(messages: MessageRepository, options?: {
         excludeMessageIds?: string[];
     });
-    retrieve(question: string): Promise<EvidenceBlock[]>;
+    retrieve(question: string, scope?: RetrievalScope): Promise<EvidenceBlock[]>;
 }
 
 interface AskWithRagInput {
@@ -977,10 +1074,10 @@ declare class VectorRetriever implements Retriever {
     private readonly store;
     private readonly limit;
     constructor(embedding: EmbeddingModel, store: VectorStore, limit?: number);
-    retrieve(question: string): Promise<EvidenceBlock[]>;
+    retrieve(question: string, scope?: RetrievalScope): Promise<EvidenceBlock[]>;
 }
 
 declare function createWebApp(config: AppConfig): FastifyInstance;
 declare function startWebServer(config: AppConfig): Promise<void>;
 
-export { type AppConfig, type AppSecrets, type AskWithRagInput, type BuildEvidencePromptOptions, type ChatMessage, type ChatModel, type ChatRecord, type ChatTool, type Citation, type CreateImageSummaryMessageInput, type DataExportResult, type DataRestoreResult, type DeleteLocalDataResult, type DeleteTargetType, type DoctorCheck, type DoctorOptions, type DoctorStatus, type EmbeddingModel, type EpisodeListItem, type EpisodeMessage, EpisodeRepository, type EpisodeSearchResult, type EpisodeSummaryRecord, type EpisodeWindow, type EvidenceBlock, type EvidencePrompt, type EvidenceSource, type FeishuAttachmentMetadata, type FeishuDownloadResourceInput, type FeishuDownloadedResource, type FeishuGatewayOptions, type FeishuGatewayRuntime, FeishuMessageSender, type FeishuQuestionDecision, FeishuQuestionHandler, type FeishuQuestionHandlerOptions, type FeishuReceiveMessageEvent, FeishuResourceDownloader, type FileJobRecord, FileJobRepository, type FileJobStatus, type FileRecord, type GatewayAttachmentIngestResult, type GatewayIngestAndDownloadResult, type GatewayIngestResult, GatewayIngestor, type GatewayPidRecord, type GatewayRuntimeState, type GroundedAnswer, HybridRetriever, type HybridRetrieverOptions, type IngestLocalFileResult, type IngestMessageInput, type LogFileInfo, type LogTailResult, type ManualMessageIndexResult, MemoryVectorStore, MessageFtsRetriever, type MessageRecord, MessageRepository, type MessageSearchResult, type MessageSender, OpenAICompatibleChatModel, type OpenAICompatibleChatOptions, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingOptions, type ParsedFile, type ProcessEpisodesResult, type SourceType, type SqliteDatabase, type StopGatewayResult, type TextChunk, type ToolCall, type ToolChatResult, type VectorIndexStats, type VectorRecord, VectorRetriever, type VectorSearchResult, type VectorStore, appConfigSchema, appSecretsSchema, applySecretInput, askWithRag, buildEvidencePrompt, chunkText, cosineSimilarity, createAgenticRagSearchTools, createChatModel, createDefaultConfig, createDefaultSecrets, createEmbeddingModel, createFeishuEventDispatcher, createFeishuGateway, createHybridRetriever, createWebApp, deleteLocalData, describeSupportedParseTypes, ensureConfigFiles, exportLocalData, extractFeishuAttachment, followLogFile, formatCitation, formatCitations, formatDoctorChecks, generateGroundedAnswer, getDatabasePath, getFeishuQuestionDecision, getGatewayLogPath, getGatewayPidPath, getGatewayRuntimeState, getLogsDirectory, hasEmbeddingConfig, indexMessageChunks, ingestLocalFile, isFeishuMessageAddressedToBot, isProcessRunning, isSupportedParseFile, isSupportedTextFile, listLogFiles, loadConfig, loadSecrets, mapDomain, maskSecret, migrateDatabase, normalizeFeishuReceiveMessageEvent, normalizeLineCount, openDatabase, parseFileToText, processEpisodesNow, processMessagesNow, rankEvidenceForPrompt, readGatewayPidRecord, readLatestLogTail, readLogTail, removeGatewayPidRecord, resetConfigFiles, resolveEmbeddingApiKey, resolveLogPath, restoreLocalData, runDoctor, sanitizeEpisodeSummary, saveConfig, saveSecrets, startWebServer, stopGatewayProcess, summarizeEpisodeWindow, writeGatewayPidRecord };
+export { type AppConfig, type AppSecrets, type AskWithRagInput, type BuildEvidencePromptOptions, type ChatMessage, type ChatModel, type ChatRecord, type ChatTool, type Citation, type CreateImageSummaryMessageInput, type CronJobRecord, CronJobRepository, type CronJobScheduler, type CronJobStatus, type CronJobTool, type DataExportResult, type DataRestoreResult, type DeleteLocalDataResult, type DeleteTargetType, type DoctorCheck, type DoctorOptions, type DoctorStatus, type EmbeddingModel, type EpisodeListItem, type EpisodeMessage, EpisodeRepository, type EpisodeSearchResult, type EpisodeSummaryRecord, type EpisodeWindow, type EvidenceBlock, type EvidencePrompt, type EvidenceSource, type FeishuAttachmentMetadata, type FeishuDownloadResourceInput, type FeishuDownloadedResource, type FeishuGatewayOptions, type FeishuGatewayRuntime, FeishuMessageSender, type FeishuQuestionDecision, FeishuQuestionHandler, type FeishuQuestionHandlerOptions, type FeishuReceiveMessageEvent, FeishuResourceDownloader, type FileJobRecord, FileJobRepository, type FileJobStatus, type FileRecord, type GatewayAttachmentIngestResult, type GatewayIngestAndDownloadResult, type GatewayIngestResult, GatewayIngestor, type GatewayPidRecord, type GatewayRuntimeState, type GroundedAnswer, HybridRetriever, type HybridRetrieverOptions, type IngestLocalFileResult, type IngestMessageInput, type LogFileInfo, type LogTailResult, type ManualMessageIndexResult, MemoryVectorStore, MessageFtsRetriever, type MessageRecord, MessageRepository, type MessageSearchResult, type MessageSearchScope, type MessageSender, OpenAICompatibleChatModel, type OpenAICompatibleChatOptions, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingOptions, type ParsedFile, type ProcessEpisodesResult, type SourceType, type SqliteDatabase, type StopGatewayResult, type TextChunk, type ToolCall, type ToolChatResult, type VectorIndexStats, type VectorRecord, VectorRetriever, type VectorSearchResult, type VectorStore, appConfigSchema, appSecretsSchema, applySecretInput, askWithRag, buildEvidencePrompt, chunkText, cosineSimilarity, createAgenticRagSearchTools, createChatModel, createCronJobScheduler, createCronJobTools, createDefaultConfig, createDefaultSecrets, createEmbeddingModel, createFeishuEventDispatcher, createFeishuGateway, createHybridRetriever, createWebApp, deleteLocalData, describeSupportedParseTypes, ensureConfigFiles, exportLocalData, extractFeishuAttachment, followLogFile, formatCitation, formatCitations, formatDoctorChecks, generateCronJobMessage, generateGroundedAnswer, getDatabasePath, getFeishuQuestionDecision, getGatewayLogPath, getGatewayPidPath, getGatewayRuntimeState, getLogsDirectory, getNextCronRun, hasEmbeddingConfig, indexMessageChunks, ingestLocalFile, isFeishuMessageAddressedToBot, isProcessRunning, isSupportedParseFile, isSupportedTextFile, isValidCronSchedule, listLogFiles, loadConfig, loadSecrets, mapDomain, maskSecret, matchesCronSchedule, migrateDatabase, normalizeFeishuReceiveMessageEvent, normalizeLineCount, openDatabase, parseFileToText, processEpisodesNow, processMessagesNow, rankEvidenceForPrompt, readGatewayPidRecord, readLatestLogTail, readLogTail, removeGatewayPidRecord, resetConfigFiles, resolveEmbeddingApiKey, resolveLogPath, restoreLocalData, runDoctor, sanitizeEpisodeSummary, saveConfig, saveSecrets, startWebServer, stopGatewayProcess, summarizeEpisodeWindow, writeGatewayPidRecord };