@pynickle/koishi-plugin-chat-summarizer 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# koishi-plugin-chat-summarizer
+
+[![npm version](https://badge.fury.io/js/koishi-plugin-chat-summarizer.svg)](https://badge.fury.io/js/koishi-plugin-chat-summarizer)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Koishi 聊天记录收集和上传插件
+
+## 主要功能
+
+- 自动收集群聊消息并保存到本地
+- 自动上传图片、文件到 S3 存储
+- 支持多种格式和时间范围的聊天记录导出
+- 支持 AI 总结功能（文本/图片格式）
+- 定时任务和数据库缓存管理
+- 支持 AWS S3、MinIO 等 S3 兼容存储
+
+## 📚 API
+
+### 命令
+
+- `cs.status`: 查看插件状态
+- `cs.geturl`: 获取回复消息中图片/文件的 S3 链接（仅管理员可用）
+  - 使用方法：回复包含图片或文件的消息，然后发送 `cs.geturl` 命令
+  - 权限要求：需要在配置中的 `admin.adminIds` 列表中
+  - ⚠️ 限制：只能查询最近 24 小时内的消息（数据库缓存期限）
+- `cs.export [群组] [时间范围] [格式] [-t 消息类型] [-s]`: 导出指定时间范围的聊天记录（仅管理员可用）
+  - 时间范围：预设（today/yesterday/last7days 等）或具体日期（2024-01-01）
+  - 格式：json（默认）、txt、csv
+  - 可选参数：-t 过滤消息类型，-s 生成 AI 总结
+- `cs.summary.check [天数]`: 检查缺失的 AI 总结（仅管理员可用）
+  - 默认检查最近 7 天，可指定 1-365 天
+  - 显示哪些日期的群组缺失 AI 总结
+- `cs.summary.retry <日期> [群组ID]`: 重新生成指定日期的 AI 总结（仅管理员可用）
+  - 支持重新生成单个群组或该日期所有群组的总结
+  - 自动清除旧的总结记录并重新生成
+- `cs.summary.get <日期> [群组ID]`: 获取指定日期的 AI 总结图片（仅管理员可用）
+  - 支持预设日期（today、yesterday 等）和具体日期格式
+  - 在群聊中可省略群组参数，自动使用当前群组
+  - 群组参数：
+    - `current` - 当前群（仅在群聊中有效）
+    - `123456789` - 具体群号
+- `cs.analysis <自然语言查询>`: AI 分析聊天记录（仅管理员可用）
+  - 自动识别时间范围并转换为具体日期（如：昨天 → 2025-01-07，最近 3 天 → 2025-01-05, 2025-01-06, 2025-01-07）
+  - 根据问题生成针对性分析结果（限制 100 字以内）
+  - 支持各种类型的查询（事件总结、话题分析、金句提取等）
+  - 输出纯文本格式，简洁直接

package/lib/ai-service.d.ts

@@ -0,0 +1,83 @@
+import { Context } from 'koishi';
+import { Config, AISummaryOutput } from './types';
+export declare class AIService {
+    private logger;
+    private globalConfig;
+    constructor(ctx: Context, config: Config);
+    /**
+     * 获取全局 AI 配置
+     */
+    private get config();
+    /**
+     * 获取群组专用的 AI 配置
+     */
+    private getGroupAIConfig;
+    /**
+     * 检查 AI 服务是否已启用并配置正确
+     */
+    isEnabled(guildId?: string): boolean;
+    /**
+     * 替换模板变量
+     */
+    private replaceTemplate;
+    /**
+     * 获取群组信息描述
+     */
+    private getGroupInfo;
+    private getApiMode;
+    private getApiBaseUrl;
+    private buildModel;
+    private generateTextWithMessages;
+    /**
+     * 生成聊天记录总结
+     */
+    generateSummary(content: string, timeRange: string, messageCount: number, guildId: string): Promise<string>;
+    /**
+     * 构建文件模式的用户提示词
+     */
+    private buildFilePrompt;
+    /**
+     * 获取默认系统提示词（作为备用）
+     */
+    private getDefaultSystemPrompt;
+    /**
+     * 获取默认用户提示词模板（作为备用）
+     */
+    private getDefaultUserPromptTemplate;
+    /**
+     * 测试 AI 接口连接
+     */
+    testConnection(): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * 解析用户的自然语言分析查询
+     * 返回时间范围和分析提示词
+     */
+    parseAnalysisQuery(userQuery: string, guildId: string): Promise<{
+        timeRange: string;
+        analysisPrompt: string;
+    }>;
+    /**
+     * 执行聊天记录分析
+     */
+    analyzeChat(content: string, analysisPrompt: string, timeRange: string, messageCount: number, guildId: string): Promise<string>;
+    /**
+     * 生成结构化的 AI 总结
+     * 返回固定格式的 JSON 数据，由前端代码负责渲染
+     */
+    generateStructuredSummary(content: string, timeRange: string, messageCount: number, guildId: string, uniqueUsers: number): Promise<AISummaryOutput>;
+    /**
+     * 解析结构化响应
+     */
+    private parseStructuredResponse;
+    /**
+     * 验证并规范化输出结构
+     */
+    private validateAndNormalizeOutput;
+    /**
+     * 获取默认的 AI 总结输出
+     */
+    private getDefaultAISummaryOutput;
+}

package/lib/card-renderer.d.ts

@@ -0,0 +1,81 @@
+import { Context } from 'koishi';
+import { DailyReport } from './types';
+export declare class CardRenderer {
+    private ctx;
+    private logger;
+    private isRendering;
+    private renderQueue;
+    constructor(ctx: Context);
+    /**
+     * 等待渲染槽位
+     */
+    private waitForRenderSlot;
+    /**
+     * 释放渲染槽位
+     */
+    private releaseRenderSlot;
+    /**
+     * 渲染完整的群日报
+     */
+    renderDailyReport(report: DailyReport): Promise<Buffer>;
+    /**
+     * 生成完整的 HTML
+     */
+    private generateHTML;
+    /**
+     * 获取 CSS 样式
+     */
+    private getStyles;
+    /**
+     * 渲染头部卡片
+     */
+    private renderHeaderCard;
+    /**
+     * 渲染总结卡片
+     */
+    private renderSummaryCard;
+    /**
+     * 渲染热点话题卡片
+     */
+    private renderHotTopicsCard;
+    /**
+     * 渲染重要信息卡片
+     */
+    private renderImportantInfoCard;
+    /**
+     * 渲染金句卡片
+     */
+    private renderQuotesCard;
+    /**
+     * 渲染活跃排行卡片
+     */
+    private renderActivityRankingCard;
+    /**
+     * 渲染时段分布卡片
+     */
+    private renderHourlyDistributionCard;
+    /**
+     * 渲染互动关系卡片
+     */
+    private renderInteractionsCard;
+    /**
+     * 获取时段描述
+     */
+    private getPeriodDescription;
+    /**
+     * HTML 转义
+     */
+    private escapeHtml;
+    /**
+     * 将文本中的 emoji 转换为图片标签
+     */
+    private convertEmojiToImages;
+    /**
+     * 获取 emoji 的 Unicode 码点
+     */
+    private getEmojiCodePoint;
+    /**
+     * 清理文本中的 URL 和图片链接
+     */
+    private cleanUrlsAndImages;
+}

package/lib/commands.d.ts

@@ -0,0 +1,34 @@
+import { Context } from 'koishi';
+import { Config } from './types';
+import { DatabaseOperations } from './database';
+import { S3Uploader } from './s3-uploader';
+export declare class CommandHandler {
+    private ctx;
+    private config;
+    private dbOps;
+    private s3Uploader;
+    private getStorageDir;
+    private getNextExecutionTime;
+    private generateSummaryForRecord;
+    private exportManager;
+    private aiService;
+    private mdToImageService;
+    constructor(ctx: Context, config: Config, dbOps: DatabaseOperations, s3Uploader: S3Uploader | null, getStorageDir: (subDir: string) => string, getNextExecutionTime: (targetTime: string) => Date, generateSummaryForRecord: (record: any, skipPush?: boolean) => Promise<string | undefined>);
+    private normalizeQQId;
+    private isAdmin;
+    private sendMessage;
+    registerCommands(): void;
+    private handleGetUrlCommand;
+    private handleStatusCommand;
+    private handleExportCommand;
+    private downloadExportContent;
+    private extractMessageCount;
+    private sendSummaryAsForward;
+    private handleSummaryCheckCommand;
+    private handleSummaryRetryCommand;
+    private handleSummaryGetCommand;
+    private parseDate;
+    private handleMdTestCommand;
+    private generateTestMarkdown;
+    private handleAnalysisCommand;
+}

package/lib/config.d.ts

@@ -0,0 +1,30 @@
+import { Schema } from 'koishi';
+import { Config } from './types';
+export declare const name = "chat-summarizer";
+export declare const inject: {
+    required: string[];
+};
+export declare const ConfigSchema: Schema<Config>;
+export declare const STRUCTURED_SYSTEM_PROMPT = "\u4F60\u662F\u4E13\u4E1A\u7684\u7FA4\u804A\u8BB0\u5F55\u5206\u6790\u52A9\u624B\u3002\u4F60\u9700\u8981\u5206\u6790\u804A\u5929\u8BB0\u5F55\u5E76\u8F93\u51FA\u7ED3\u6784\u5316\u7684 JSON \u6570\u636E\u3002\n\n\u4F60\u5FC5\u987B\u4E14\u53EA\u80FD\u8F93\u51FA\u4EE5\u4E0B JSON \u683C\u5F0F\uFF0C\u4E0D\u8981\u6DFB\u52A0\u4EFB\u4F55\u89E3\u91CA\u6027\u6587\u5B57\u3001\u4EE3\u7801\u5757\u6807\u8BB0\u6216\u5176\u4ED6\u5185\u5BB9\uFF1A\n{\n  \"summary\": {\n    \"overview\": \"30-50 \u5B57\u7684\u6574\u4F53\u6982\u8FF0\uFF0C\u63CF\u8FF0\u4ECA\u5929\u7FA4\u5185\u7684\u4E3B\u8981\u6D3B\u52A8\u548C\u6C1B\u56F4\",\n    \"highlights\": [\"\u8981\u70B9 1\", \"\u8981\u70B9 2\", \"\u8981\u70B9 3\"],\n    \"atmosphere\": \"\u7528 2-4 \u4E2A\u8BCD\u63CF\u8FF0\u7FA4\u5185\u6C1B\u56F4\uFF0C\u5982\uFF1A\u8F7B\u677E\u6109\u5FEB\u3001\u70ED\u70C8\u8BA8\u8BBA\u3001\u6E29\u99A8\u4E92\u52A9\u7B49\"\n  },\n  \"hotTopics\": [\n    {\n      \"topic\": \"\u8BDD\u9898\u540D\u79F0\",\n      \"description\": \"\u7B80\u77ED\u63CF\u8FF0\u8BE5\u8BDD\u9898\u7684\u5185\u5BB9\",\n      \"participants\": [\"\u53C2\u4E0E\u8005 1\", \"\u53C2\u4E0E\u8005 2\"],\n      \"heatLevel\": \"high/medium/low\"\n    }\n  ],\n  \"importantInfo\": [\n    {\n      \"type\": \"announcement/link/resource/decision/other\",\n      \"content\": \"\u91CD\u8981\u4FE1\u606F\u5185\u5BB9\",\n      \"source\": \"\u4FE1\u606F\u6765\u6E90\uFF08\u53EF\u9009\uFF09\"\n    }\n  ],\n  \"quotes\": [\n    {\n      \"content\": \"\u6709\u8DA3\u6216\u7CBE\u5F69\u7684\u53D1\u8A00\u5185\u5BB9\",\n      \"author\": \"\u53D1\u8A00\u4EBA\"\n    }\n  ]\n}\n\n\u5206\u6790\u8981\u6C42\uFF1A\n1. summary.overview - 30-50 \u5B57\u6574\u4F53\u6982\u8FF0\uFF0C\u7528\u8BCD\u8981\u751F\u52A8\u4F46\u6E05\u6670\n2. summary.highlights - 3-5 \u4E2A\u8981\u70B9\uFF0C\u6BCF\u4E2A\u8981\u70B9\u4E00\u53E5\u8BDD\n3. summary.atmosphere - \u63CF\u8FF0\u7FA4\u5185\u6C1B\u56F4\u7684\u7B80\u77ED\u8BCD\u7EC4\n4. hotTopics - \u6309\u70ED\u5EA6\u6392\u5E8F\uFF0C\u6700\u591A 5 \u4E2A\uFF0CheatLevel \u6839\u636E\u8BA8\u8BBA\u70ED\u5EA6\u5224\u65AD\n5. importantInfo - \u63D0\u53D6\u516C\u544A\u3001\u91CD\u8981\u51B3\u5B9A\u7B49\uFF0C\u6CA1\u6709\u5219\u8FD4\u56DE\u7A7A\u6570\u7EC4\n6. quotes - \u6700\u6709\u8DA3/\u7CBE\u5F69/\u6709\u54F2\u7406\u7684\u53D1\u8A00\uFF0C\u6700\u591A 5 \u53E5\uFF0C\u6CA1\u6709\u5219\u8FD4\u56DE\u7A7A\u6570\u7EC4\n\n\u91CD\u8981\u6CE8\u610F\u4E8B\u9879\uFF1A\n- \u4E25\u683C\u6309 JSON \u683C\u5F0F\u8F93\u51FA\uFF0C\u786E\u4FDD JSON \u8BED\u6CD5\u6B63\u786E\n- \u4E0D\u8981\u5728 JSON \u524D\u540E\u6DFB\u52A0\u4EFB\u4F55\u6587\u5B57\u8BF4\u660E\n- \u4E0D\u8981\u4F7F\u7528 markdown \u4EE3\u7801\u5757\u5305\u88F9 JSON\n- \u5982\u679C\u804A\u5929\u5185\u5BB9\u8F83\u5C11\uFF0C\u5404\u5B57\u6BB5\u53EF\u4EE5\u7CBE\u7B80\u4F46\u7ED3\u6784\u5FC5\u987B\u5B8C\u6574\n- \u4FDD\u62A4\u9690\u79C1\uFF0C\u4E0D\u900F\u9732\u654F\u611F\u4E2A\u4EBA\u4FE1\u606F\n- **importantInfo \u7684 content \u5B57\u6BB5\u5FC5\u987B\u662F\u5BF9\u4FE1\u606F\u7684\u63CF\u8FF0\uFF0C\u7981\u6B62\u76F4\u63A5\u653E\u5165\u539F\u59CB URL \u94FE\u63A5\u6216\u56FE\u7247\u6807\u8BB0**\n- **\u4E0D\u8981\u628A\u7EAF\u94FE\u63A5\u3001\u7EAF\u56FE\u7247\u5F53\u4F5C\u91CD\u8981\u4FE1\u606F\uFF0C\u53EA\u63D0\u53D6\u6709\u5B9E\u9645\u5185\u5BB9\u63CF\u8FF0\u7684\u4FE1\u606F**";
+export declare const CONSTANTS: {
+    readonly STORAGE_DIRS: {
+        readonly DATA: "data";
+    };
+    readonly URL_REPLACEMENTS: {
+        readonly OLD_DOMAIN: "cn-sy1.rains3.com/qqmsg";
+        readonly NEW_DOMAIN: "qqmsg.pan.wittf.ink";
+    };
+    readonly FILE_SETTINGS: {
+        readonly ENCODING: "utf8";
+        readonly LINE_SEPARATOR: "\n";
+        readonly JSON_EXTENSION: ".jsonl";
+    };
+    readonly DEFAULTS: {
+        readonly UNKNOWN_USER: "未知用户";
+        readonly PRIVATE_GROUP: "private";
+        readonly QUOTE_AUTHOR_FALLBACK: "某用户";
+    };
+    readonly S3_REGION: "auto";
+    readonly MAX_CONTENT_PREVIEW: 50;
+    readonly IMAGE_UPLOAD_TIMEOUT: 60000;
+};

package/lib/database.d.ts

@@ -0,0 +1,32 @@
+import { Context } from 'koishi';
+import { ChatRecord, ImageRecord, FileRecord, VideoRecord, ChatLogFileRecord, PluginStats } from './types';
+export declare function extendDatabase(ctx: Context): void;
+export declare class DatabaseOperations {
+    private ctx;
+    constructor(ctx: Context);
+    createChatRecord(record: Omit<ChatRecord, 'id'>): Promise<ChatRecord>;
+    createImageRecord(record: Omit<ImageRecord, 'id'>): Promise<ImageRecord>;
+    createFileRecord(record: Omit<FileRecord, 'id'>): Promise<FileRecord>;
+    createVideoRecord(record: Omit<VideoRecord, 'id'>): Promise<VideoRecord>;
+    createChatLogFileRecord(record: Omit<ChatLogFileRecord, 'id'>): Promise<ChatLogFileRecord>;
+    updateChatLogFileRecord(id: number, updates: Partial<ChatLogFileRecord>): Promise<void>;
+    checkChatLogFileUploaded(date: string, guildId?: string): Promise<boolean>;
+    getChatLogFileRecord(date: string, guildId?: string): Promise<ChatLogFileRecord | null>;
+    updateChatLogFileSummaryImage(id: number, summaryImageUrl: string): Promise<void>;
+    getChatLogFilesForSummary(date: string): Promise<ChatLogFileRecord[]>;
+    getMissingSummaryRecords(startDate: string, endDate: string): Promise<ChatLogFileRecord[]>;
+    getChatLogFileForRetry(date: string, guildId?: string): Promise<ChatLogFileRecord | null>;
+    clearSummaryImage(id: number): Promise<void>;
+    getSummaryImageUrl(date: string, guildId?: string): Promise<string | null>;
+    getRecordsWithSummary(startDate: string, endDate: string): Promise<ChatLogFileRecord[]>;
+    updateChatRecord(messageId: string, updates: Partial<ChatRecord>): Promise<void>;
+    getUnuploadedRecords(startTime: number, endTime: number): Promise<ChatRecord[]>;
+    markAsUploaded(recordIds: number[]): Promise<void>;
+    getPluginStats(): Promise<PluginStats>;
+    cleanupExpiredRecords(retentionHours: number): Promise<{
+        deletedChatRecords: number;
+        deletedImageRecords: number;
+        deletedFileRecords: number;
+        deletedVideoRecords: number;
+    }>;
+}

package/lib/export.d.ts

@@ -0,0 +1,72 @@
+import { Context } from 'koishi';
+import { S3Uploader } from './s3-uploader';
+export interface ExportRequest {
+    guildId?: string;
+    timeRange: string;
+    format: 'json' | 'txt' | 'csv';
+    messageTypes?: string[];
+}
+export interface ExportResult {
+    success: boolean;
+    s3Url?: string;
+    error?: string;
+    message?: string;
+}
+export interface ParsedTimeRange {
+    startDate: Date;
+    endDate: Date;
+    dateStrings: string[];
+}
+export interface ChatMessage {
+    time: string;
+    username: string;
+    content: string;
+    guildId?: string;
+    messageType: string;
+}
+export declare class ExportManager {
+    private ctx;
+    private s3Uploader;
+    private getStorageDir;
+    constructor(ctx: Context, s3Uploader: S3Uploader | null, getStorageDir: (subDir: string) => string);
+    /**
+     * 解析时间范围
+     */
+    parseTimeRange(timeRange: string): ParsedTimeRange;
+    /**
+     * 解析日期字符串
+     */
+    private parseDate;
+    /**
+     * 检查本地文件是否存在
+     */
+    private checkLocalFiles;
+    /**
+     * 检查 S3 文件是否存在
+     */
+    private checkS3Files;
+    /**
+     * 从 S3 下载文件到本地临时目录
+     */
+    private downloadFromS3;
+    /**
+     * 读取和解析聊天记录文件
+     */
+    private parseMessageFiles;
+    /**
+     * 格式化导出内容
+     */
+    private formatExportContent;
+    /**
+     * 清理临时文件
+     */
+    private cleanupTempFiles;
+    /**
+     * 执行导出
+     */
+    exportChatData(request: ExportRequest): Promise<ExportResult>;
+    /**
+     * 获取内容类型
+     */
+    private getContentType;
+}

package/lib/file-writer.d.ts

@@ -0,0 +1,12 @@
+import { Logger } from 'koishi';
+export declare class SafeFileWriter {
+    private writeChains;
+    private logger;
+    constructor(logger: Logger);
+    safeAppend(filePath: string, content: string): Promise<void>;
+    safeUpdate(filePath: string, messageId: string, newContent: string): Promise<void>;
+    safeRead(filePath: string): Promise<string>;
+    private enqueueWrite;
+    flush(): Promise<void>;
+    dispose(): void;
+}