koishi-plugin-chat-analyse 0.3.0 → 0.3.1

package/lib/Stat.d.ts

@@ -17,7 +17,7 @@ export declare class Stat {
     constructor(ctx: Context, config: Config);
     /**
      * @method registerCommands
-     * @description 根据插件配置，动态地将 `.command`, `.message`, `.rank` 子命令注册到主 `analyse` 命令下。
+     * @description 根据插件配置，动态地将 `.cmd`, `.msg`, `.rank` 子命令注册到主 `analyse` 命令下。
      * @param {Command} analyse - 主 `analyse` 命令实例。
      */
     registerCommands(analyse: Command): void;
@@ -28,7 +28,10 @@ export declare class Stat {
      * @description 通用的标题生成器。根据查询参数和类型选项动态生成易于理解的图片标题。
      * @param {string} [guildId] - (可选) 查询的群组 ID。
      * @param {string} [userId] - (可选) 查询的用户 ID。
-     * @param {TitleOptions} options - 标题的配置选项。
+     * @param {object} options - 标题的配置选项。
+     * @param {'命令' | '消息' | '排行'} options.main - 标题主类型。
+     * @param {string} [options.subtype] - (可选) 消息类型的子类型。
+     * @param {number} [options.timeRange] - (可选) 排行的时间范围（小时）。
      * @returns {Promise<string>} 生成的标题字符串。
      */
     private generateTitle;

package/lib/index.d.ts

@@ -14,7 +14,8 @@ export interface Config {
     enableListener: boolean;
     enableCmdStat: boolean;
     enableMsgStat: boolean;
-    enableAdvanced: boolean;
+    enableRankStat: boolean;
+    enableOriRecord: boolean;
 }
 /**
  * @const {Schema<Config>} Config

package/lib/index.js

@@ -42,7 +42,7 @@ var Collector = class _Collector {
     this.config = config;
     this.defineModels();
     ctx.on("message", (session) => this.handleMessage(session));
-    if (this.config.enableAdvanced) {
+    if (this.config.enableOriRecord) {
       this.flushInterval = setInterval(() => this.flushCacheBuffer(), _Collector.FLUSH_INTERVAL);
       ctx.on("dispose", () => {
         clearInterval(this.flushInterval);
@@ -90,7 +90,7 @@ var Collector = class _Collector {
       count: "unsigned",
       timestamp: "timestamp"
     }, { primary: ["uid", "type", "hour"] });
-    if (this.config.enableAdvanced) {
+    if (this.config.enableOriRecord) {
       this.ctx.model.extend("analyse_cache", {
         id: "unsigned",
         uid: "unsigned",
@@ -133,7 +133,7 @@ var Collector = class _Collector {
           timestamp: messageTime
         }]);
       }
-      if (this.config.enableAdvanced) {
+      if (this.config.enableOriRecord) {
         this.cacheBuffer.push({
           uid,
           content: this.sanitizeContent(elements),
@@ -360,12 +360,12 @@ var Stat = class {
   renderer;
   /**
    * @method registerCommands
-   * @description 根据插件配置，动态地将 `.command`, `.message`, `.rank` 子命令注册到主 `analyse` 命令下。
+   * @description 根据插件配置，动态地将 `.cmd`, `.msg`, `.rank` 子命令注册到主 `analyse` 命令下。
    * @param {Command} analyse - 主 `analyse` 命令实例。
    */
   registerCommands(analyse) {
     if (this.config.enableCmdStat) {
-      analyse.subcommand(".command", "命令使用统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").usage("查询用户或群组的命令使用统计，默认展示全局统计。").action(async ({ session, options }) => {
+      analyse.subcommand(".cmd", "命令使用统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").usage("查询用户或群组的命令使用统计，默认展示全局统计。").action(async ({ session, options }) => {
         const userId = options.user ? import_koishi3.h.select(options.user, "user")[0]?.attrs.id : void 0;
         let guildId = options.guild;
         if (!userId && !guildId && session.guildId) {
@@ -393,7 +393,7 @@ var Stat = class {
       });
     }
     if (this.config.enableMsgStat) {
-      analyse.subcommand(".message", "消息发送统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").option("type", "-t <type:string> 指定类型").usage("查询用户或群组的消息发送统计，默认展示全局统计。").action(async ({ session, options }) => {
+      analyse.subcommand(".msg", "消息发送统计").option("user", "-u [user:user] 指定用户").option("guild", "-g [guildId:string] 指定群组").option("type", "-t <type:string> 指定类型").usage("查询用户或群组的消息发送统计，默认展示全局统计。").action(async ({ session, options }) => {
         const userId = options.user ? import_koishi3.h.select(options.user, "user")[0]?.attrs.id : void 0;
         let guildId = options.guild;
         if (!userId && !guildId && !options.type && session.guildId) {
@@ -434,7 +434,9 @@ var Stat = class {
           return "渲染消息统计图片失败";
         }
       });
-      analyse.subcommand(".rank", "用户发言排行").option("guild", "-g [guildId:string] 指定群组").option("hours", "-h <hours:number> 查看过去 N 小时的排行", { fallback: 24 }).usage("查询用户或群组的用户发言排行，默认展示全局统计。").action(async ({ session, options }) => {
+    }
+    if (this.config.enableRankStat) {
+      analyse.subcommand(".rank", "用户发言排行").option("guild", "-g [guildId:string] 指定群组").option("hours", "-h <hours:number> 指定时长", { fallback: 24 }).usage("查询用户或群组的用户发言排行，默认展示全局统计。").action(async ({ session, options }) => {
         let guildId = options.guild;
         if (!guildId && session.guildId) guildId = session.guildId;
         if (!guildId) return "请指定查询范围";
@@ -470,7 +472,10 @@ var Stat = class {
    * @description 通用的标题生成器。根据查询参数和类型选项动态生成易于理解的图片标题。
    * @param {string} [guildId] - (可选) 查询的群组 ID。
    * @param {string} [userId] - (可选) 查询的用户 ID。
-   * @param {TitleOptions} options - 标题的配置选项。
+   * @param {object} options - 标题的配置选项。
+   * @param {'命令' | '消息' | '排行'} options.main - 标题主类型。
+   * @param {string} [options.subtype] - (可选) 消息类型的子类型。
+   * @param {number} [options.timeRange] - (可选) 排行的时间范围（小时）。
    * @returns {Promise<string>} 生成的标题字符串。
    */
   async generateTitle(guildId, userId, options) {
@@ -635,13 +640,14 @@ var name = "chat-analyse";
 var using = ["database", "puppeteer"];
 var Config = import_koishi4.Schema.intersect([
   import_koishi4.Schema.object({
-    enableListener: import_koishi4.Schema.boolean().default(true).description("开启监听")
-  }).description("基本设置"),
+    enableListener: import_koishi4.Schema.boolean().default(true).description("启用消息监听"),
+    enableOriRecord: import_koishi4.Schema.boolean().default(true).description("启用原始记录")
+  }).description("监听配置"),
   import_koishi4.Schema.object({
     enableCmdStat: import_koishi4.Schema.boolean().default(true).description("启用命令统计"),
     enableMsgStat: import_koishi4.Schema.boolean().default(true).description("启用消息统计"),
-    enableAdvanced: import_koishi4.Schema.boolean().default(true).description("启用原始记录")
-  }).description("功能开关")
+    enableRankStat: import_koishi4.Schema.boolean().default(true).description("启用发言排行")
+  }).description("命令配置")
 ]);
 function apply(ctx, config) {
   if (config.enableListener) new Collector(ctx, config);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-chat-analyse",
   "description": "聊天记录分析",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "contributors": [
     "Yis_Rime <yis_rime@outlook.com>"
   ],