npm - koishi-plugin-chat-analyse - Versions diffs - 0.5.2 → 0.5.3 - Mend

koishi-plugin-chat-analyse 0.5.2 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/lib/Renderer.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import { Context } from 'koishi';
 export type RenderListItem = (string | number | Date)[];
 /**
  * @interface ListRenderData
- * @description 定义了调用 `renderList` 方法所需的数据结构，包含了渲染一张完整列表图片所必需的所有信息。
+ * @description 定义了调用 `renderList` 方法所需的数据结构。
  */
 export interface ListRenderData {
     title: string;
@@ -11,39 +11,39 @@ export interface ListRenderData {
     total?: string | number;
     list: RenderListItem[];
 }
+/**
+ * @interface CircadianChartData
+ * @description 定义了调用 `renderCircadianChart` 方法所需的数据结构。
+ */
+export interface CircadianChartData {
+    title: string;
+    time: Date;
+    total: string | number;
+    data: number[];
+}
 /**
  * @class Renderer
- * @description 负责将结构化的列表数据渲染为设计精美的 PNG 图片。其核心特性是能够动态计算内容尺寸，生成布局紧凑、自适应的图片。
+ * @description 负责将结构化的列表数据渲染为设计精美的 PNG 图片。
  */
 export declare class Renderer {
     private ctx;
     /**
-     * @param ctx - Koishi 的插件上下文，用于访问 `puppeteer` 等核心服务。
+     * @private @readonly
+     * @property COMMON_STYLE - 存储所有卡片共享的基础 CSS 样式。
      */
+    private readonly COMMON_STYLE;
     constructor(ctx: Context);
     /**
      * @private
-     * @method htmlToImage
-     * @description 将一个完整的 HTML 文档字符串转换为 PNG 图片 Buffer。
-     * @param fullHtmlContent - 要渲染的、包含 `<html>...</html>` 的完整HTML字符串。
-     * @returns 返回一个包含 PNG 图片数据的 Buffer，失败则返回 null。
+     * @method generateFullHtml
+     * @description 将卡片内容和特定样式组合成一个完整的 HTML 文档。
+     * @param cardContent - 卡片部分的 HTML 字符串。
+     * @param specificStyles - 该卡片类型独有的 CSS 样式字符串。
+     * @returns 完整的 HTML 字符串。
      */
+    private generateFullHtml;
     private htmlToImage;
-    /**
-     * @private
-     * @method formatDate
-     * @description 将 `Date` 对象格式化为易于理解的相对时间或绝对日期字符串。
-     * @param date - 需要格式化的日期对象。
-     * @returns 格式化后的时间字符串。
-     */
     private formatDate;
-    /**
-     * @public
-     * @method renderList
-     * @description 构建并渲染一个包含标题、统计信息和数据表格的 HTML 卡片为图片。如果数据过多，则会分片渲染成多张图片。
-     * @param data - 包含渲染所需全部信息的对象。
-     * @param headers - (可选) 表格的表头字符串数组。
-     * @returns 成功时返回包含 PNG 图片的 Buffer 数组，若列表为空则返回提示字符串。
-     */
     renderList(data: ListRenderData, headers?: string[]): Promise<string | Buffer[]>;
+    renderCircadianChart(data: CircadianChartData): Promise<string | Buffer[]>;
 }

package/lib/Stat.d.ts ADDED Viewed

@@ -0,0 +1,37 @@
+import { Context, Command } from 'koishi';
+import { Renderer } from './Renderer';
+import { Config } from './index';
+/**
+ * @class Stat
+ * @description 提供统一的统计查询服务。负责注册查询命令，从数据库获取数据，并调用渲染器生成图表。
+ */
+export declare class Stat {
+    private ctx;
+    private config;
+    renderer: Renderer;
+    /**
+     * @param ctx - Koishi 的插件上下文。
+     * @param config - 插件的配置对象。
+     */
+    constructor(ctx: Context, config: Config);
+    /**
+     * @public @method registerCommands
+     * @description 根据配置，动态地将子命令注册到主 `analyse` 命令下。
+     * @param analyse - 主 `analyse` 命令实例。
+     */
+    registerCommands(analyse: Command): void;
+    /**
+     * @private @method parseQueryScope
+     * @description 解析命令选项，转换为包含 UIDs 和描述性信息的统一查询范围对象。
+     * @param session - 当前会话对象。
+     * @param options - 命令选项。
+     * @returns 包含 uids、错误或范围描述的查询范围对象。
+     */
+    private parseQueryScope;
+    /**
+     * @private @method generateTitle
+     * @description 根据查询范围和类型动态生成易于理解的图片标题。
+     * @returns 生成的标题字符串。
+     */
+    private generateTitle;
+}

package/lib/index.d.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import { Context, Schema } from 'koishi';
+/** @name 插件使用说明 */
+export declare const usage = "\n<div style=\"border-radius: 10px; border: 1px solid #ddd; padding: 16px; margin-bottom: 20px; box-shadow: 0 2px 5px rgba(0,0,0,0.1);\">\n  <h2 style=\"margin-top: 0; color: #4a6ee0;\">\uD83D\uDCCC \u63D2\u4EF6\u8BF4\u660E</h2>\n  <p>\uD83D\uDCD6 <strong>\u4F7F\u7528\u6587\u6863</strong>\uFF1A\u8BF7\u70B9\u51FB\u5DE6\u4E0A\u89D2\u7684 <strong>\u63D2\u4EF6\u4E3B\u9875</strong> \u67E5\u770B\u63D2\u4EF6\u4F7F\u7528\u6587\u6863</p>\n  <p>\uD83D\uDD0D <strong>\u66F4\u591A\u63D2\u4EF6</strong>\uFF1A\u53EF\u8BBF\u95EE <a href=\"https://github.com/YisRime\" style=\"color:#4a6ee0;text-decoration:none;\">\u82E1\u6DDE\u7684 GitHub</a> \u67E5\u770B\u672C\u4EBA\u7684\u6240\u6709\u63D2\u4EF6</p>\n</div>\n<div style=\"border-radius: 10px; border: 1px solid #ddd; padding: 16px; margin-bottom: 20px; box-shadow: 0 2px 5px rgba(0,0,0,0.1);\">\n  <h2 style=\"margin-top: 0; color: #e0574a;\">\u2764\uFE0F \u652F\u6301\u4E0E\u53CD\u9988</h2>\n  <p>\uD83C\uDF1F \u559C\u6B22\u8FD9\u4E2A\u63D2\u4EF6\uFF1F\u8BF7\u5728 <a href=\"https://github.com/YisRime\" style=\"color:#e0574a;text-decoration:none;\">GitHub</a> \u4E0A\u7ED9\u6211\u4E00\u4E2A Star\uFF01</p>\n  <p>\uD83D\uDC1B \u9047\u5230\u95EE\u9898\uFF1F\u8BF7\u901A\u8FC7 <strong>Issues</strong> \u63D0\u4EA4\u53CD\u9988\uFF0C\u6216\u52A0\u5165 QQ \u7FA4 <a href=\"https://qm.qq.com/q/PdLMx9Jowq\" style=\"color:#e0574a;text-decoration:none;\"><strong>855571375</strong></a> \u8FDB\u884C\u4EA4\u6D41</p>\n</div>\n";
+export declare const name = "chat-analyse";
+export declare const using: string[];
+/**
+ * @interface Config
+ * @description 定义插件的配置项结构。
+ */
+export interface Config {
+    enableListener: boolean;
+    enableCmdStat: boolean;
+    enableMsgStat: boolean;
+    enableRankStat: boolean;
+    enableActivityStat: boolean;
+    enableOriRecord: boolean;
+    enableWhoAt: boolean;
+    enableData: boolean;
+    atRetentionDays: number;
+    rankRetentionDays: number;
+}
+/** @description 插件的配置项定义，使用 Koishi Schema 构建。 */
+export declare const Config: Schema<Config>;
+/**
+ * @function apply
+ * @description Koishi 插件的主入口函数，负责初始化和注册所有功能模块。
+ * @param ctx - Koishi 的插件上下文。
+ * @param config - 用户配置对象。
+ */
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js CHANGED Viewed

@@ -210,22 +210,37 @@ var import_koishi3 = require("koishi");
 // src/Renderer.ts
 var import_koishi2 = require("koishi");
 var Renderer = class {
-  /**
-   * @param ctx - Koishi 的插件上下文，用于访问 `puppeteer` 等核心服务。
-   */
   constructor(ctx) {
     this.ctx = ctx;
   }
   static {
     __name(this, "Renderer");
   }
+  /**
+   * @private @readonly
+   * @property COMMON_STYLE - 存储所有卡片共享的基础 CSS 样式。
+   */
+  COMMON_STYLE = `:root{--card-bg:#fff;--text-color:#111827;--header-color:#111827;--sub-text-color:#6b7280;--border-color:#e5e7eb;--accent-color:#4a6ee0;--chip-bg:#f3f4f6;--stripe-bg:#f9fafb;--gold:#f59e0b;--silver:#9ca3af;--bronze:#a16207}body{display:inline-block;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif;background:0 0;margin:0;padding:8px;-webkit-font-smoothing:antialiased}.container{display:inline-block;background:var(--card-bg);border-radius:12px;padding:0;overflow:hidden;box-shadow:0 2px 4px rgba(0,0,0,.05)}.header{padding:10px 14px}.header-table{border-collapse:collapse;width:100%}.header-table-left,.header-table-right{width:1%;white-space:nowrap}.header-table-left{text-align:left}.header-table-center{text-align:center}.header-table-right{text-align:right}.title-text{font-size:18px;font-weight:600;color:var(--header-color);margin:0}.stat-chip,.time-label{display:inline-flex;align-items:baseline;padding:4px 8px;border-radius:8px;background:var(--chip-bg);font-size:13px;color:var(--sub-text-color)}.stat-chip span{font-weight:600;color:var(--text-color);margin-left:4px}`;
   /**
    * @private
-   * @method htmlToImage
-   * @description 将一个完整的 HTML 文档字符串转换为 PNG 图片 Buffer。
-   * @param fullHtmlContent - 要渲染的、包含 `<html>...</html>` 的完整HTML字符串。
-   * @returns 返回一个包含 PNG 图片数据的 Buffer，失败则返回 null。
+   * @method generateFullHtml
+   * @description 将卡片内容和特定样式组合成一个完整的 HTML 文档。
+   * @param cardContent - 卡片部分的 HTML 字符串。
+   * @param specificStyles - 该卡片类型独有的 CSS 样式字符串。
+   * @returns 完整的 HTML 字符串。
    */
+  generateFullHtml(cardContent, specificStyles) {
+    return `<!DOCTYPE html>
+      <html>
+      <head>
+        <meta charset="UTF-8">
+        <style>${this.COMMON_STYLE}${specificStyles}</style>
+      </head>
+      <body>
+        ${cardContent}
+      </body>
+      </html>`;
+  }
   async htmlToImage(fullHtmlContent) {
     const page = await this.ctx.puppeteer.page();
     try {
@@ -241,13 +256,6 @@ var Renderer = class {
       if (page) await page.close().catch((e) => this.ctx.logger.error("关闭页面失败:", e));
     }
   }
-  /**
-   * @private
-   * @method formatDate
-   * @description 将 `Date` 对象格式化为易于理解的相对时间或绝对日期字符串。
-   * @param date - 需要格式化的日期对象。
-   * @returns 格式化后的时间字符串。
-   */
   formatDate(date) {
     if (!date) return "未知";
     const diff = Date.now() - date.getTime();
@@ -255,20 +263,10 @@ var Renderer = class {
     if (diff > 365 * import_koishi2.Time.day) return date.toLocaleDateString("zh-CN").replace(/\//g, "-");
     const timeUnits = [["月", 30 * import_koishi2.Time.day], ["天", import_koishi2.Time.day], ["时", import_koishi2.Time.hour], ["分", import_koishi2.Time.minute]];
     for (const [unit, ms] of timeUnits) {
-      if (diff >= ms) {
-        return `${Math.floor(diff / ms)}${unit}前`;
-      }
+      if (diff >= ms) return `${Math.floor(diff / ms)}${unit}前`;
     }
     return "刚刚";
   }
-  /**
-   * @public
-   * @method renderList
-   * @description 构建并渲染一个包含标题、统计信息和数据表格的 HTML 卡片为图片。如果数据过多，则会分片渲染成多张图片。
-   * @param data - 包含渲染所需全部信息的对象。
-   * @param headers - (可选) 表格的表头字符串数组。
-   * @returns 成功时返回包含 PNG 图片的 Buffer 数组，若列表为空则返回提示字符串。
-   */
   async renderList(data, headers) {
     const { title, time, list } = data;
     if (!list?.length) return "暂无数据可供渲染";
@@ -288,6 +286,7 @@ var Renderer = class {
       return `<td class="name-cell">${String(cell)}</td>`;
     }, "renderCell");
     const totalPages = Math.ceil(totalItems / CHUNK_SIZE);
+    const listStyles = `.table-container{border-top:1px solid var(--border-color)}.main-table{border-collapse:collapse;width:100%}.main-table th,.main-table td{padding:8px 14px;vertical-align:middle}.main-table th{font-size:12px;font-weight:500;color:var(--sub-text-color);text-transform:uppercase;letter-spacing:.05em;background:var(--stripe-bg)}.main-table td{font-size:14px;color:var(--text-color)}.main-table tbody tr:nth-child(even){background-color:var(--stripe-bg)}.main-table .name-cell,.main-table .name-header{text-align:left}.main-table .rank-cell,.main-table .count-cell,.main-table .date-cell,.main-table .percent-cell,.main-table .header-right-align{text-align:right;white-space:nowrap;width:1%;font-variant-numeric:tabular-nums}.name-cell{font-weight:500}.rank-cell{font-weight:500;color:var(--sub-text-color)}.count-cell{font-weight:600;color:var(--accent-color)}.date-cell{color:var(--sub-text-color)}.rank-gold,.rank-silver,.rank-bronze{font-weight:600}.rank-gold{color:var(--gold)!important}.rank-silver{color:var(--silver)!important}.rank-bronze{color:var(--bronze)!important}.percent-cell{position:relative}.percent-bar{position:absolute;top:0;right:0;height:100%;background-color:var(--accent-color);opacity:.15}.percent-text{position:relative;z-index:1}`;
     for (let i = 0; i < totalItems; i += CHUNK_SIZE) {
       const chunk = list.slice(i, i + CHUNK_SIZE);
       const pageNum = Math.floor(i / CHUNK_SIZE) + 1;
@@ -299,23 +298,27 @@ var Renderer = class {
       }).join("");
       const tableHeadHtml = headers?.length ? `<thead><tr><th class="rank-cell">#</th>${headers.map((h4) => `<th class="${typeof list[0]?.[headers.indexOf(h4)] === "string" ? "name-header" : "header-right-align"}">${h4}</th>`).join("")}</tr></thead>` : "";
       const cardHtml = `<div class="container"><div class="header"><table class="header-table"><tr><td class="header-table-left"><div class="stat-chip">总计: <span>${typeof totalCount === "number" ? totalCount.toLocaleString() : totalCount}</span></div></td><td class="header-table-center"><h1 class="title-text">${pageTitle}</h1></td><td class="header-table-right"><div class="time-label">${time.toLocaleString("zh-CN", { hour12: false }).replace(/\//g, "-")}</div></td></tr></table></div><div class="table-container"><table class="main-table">${tableHeadHtml}<tbody>${tableRowsHtml}</tbody></table></div></div>`;
-      const fullHtml = `<!DOCTYPE html>
-        <html>
-        <head>
-          <meta charset="UTF-8">
-          <style>:root{--card-bg:#fff;--text-color:#111827;--header-color:#111827;--sub-text-color:#6b7280;--border-color:#e5e7eb;--accent-color:#4a6ee0;--chip-bg:#f3f4f6;--stripe-bg:#f9fafb;--gold:#f59e0b;--silver:#9ca3af;--bronze:#a16207}body{display:inline-block;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif;background:0 0;margin:0;padding:8px;-webkit-font-smoothing:antialiased}.container{display:inline-block;background:var(--card-bg);border-radius:12px;padding:0;overflow:hidden;box-shadow:0 2px 4px rgba(0,0,0,.05)}.header{padding:10px 14px}.header-table{border-collapse:collapse;width:100%}.header-table-left,.header-table-right{width:1%;white-space:nowrap}.header-table-left{text-align:left}.header-table-center{text-align:center}.header-table-right{text-align:right}.title-text{font-size:18px;font-weight:600;color:var(--header-color);margin:0}.stat-chip,.time-label{display:inline-flex;align-items:baseline;padding:4px 8px;border-radius:8px;background:var(--chip-bg);font-size:13px;color:var(--sub-text-color)}.stat-chip span{font-weight:600;color:var(--text-color);margin-left:4px}.table-container{border-top:1px solid var(--border-color)}.main-table{border-collapse:collapse;width:100%}.main-table th,.main-table td{padding:8px 14px;vertical-align:middle}.main-table th{font-size:12px;font-weight:500;color:var(--sub-text-color);text-transform:uppercase;letter-spacing:.05em;background:var(--stripe-bg)}.main-table td{font-size:14px;color:var(--text-color)}.main-table tbody tr:nth-child(even){background-color:var(--stripe-bg)}.main-table .name-cell,.main-table .name-header{text-align:left}.main-table .rank-cell,.main-table .count-cell,.main-table .date-cell,.main-table .percent-cell,.main-table .header-right-align{text-align:right;white-space:nowrap;width:1%;font-variant-numeric:tabular-nums}.name-cell{font-weight:500}.rank-cell{font-weight:500;color:var(--sub-text-color)}.count-cell{font-weight:600;color:var(--accent-color)}.date-cell{color:var(--sub-text-color)}.rank-gold,.rank-silver,.rank-bronze{font-weight:600}.rank-gold{color:var(--gold)!important}.rank-silver{color:var(--silver)!important}.rank-bronze{color:var(--bronze)!important}.percent-cell{position:relative}.percent-bar{position:absolute;top:0;right:0;height:100%;background-color:var(--accent-color);opacity:.15}.percent-text{position:relative;z-index:1}</style>
-        </head>
-        <body>
-          ${cardHtml}
-        </body>
-        </html>`;
+      const fullHtml = this.generateFullHtml(cardHtml, listStyles);
       const imageBuffer = await this.htmlToImage(fullHtml);
-      if (imageBuffer) {
-        imageBuffers.push(imageBuffer);
-      }
+      if (imageBuffer) imageBuffers.push(imageBuffer);
     }
     return imageBuffers.length > 0 ? imageBuffers : "图片渲染失败";
   }
+  async renderCircadianChart(data) {
+    const { title, time, total, data: hourlyCounts } = data;
+    if (!hourlyCounts || hourlyCounts.every((c) => c === 0)) return "暂无数据可供渲染";
+    const maxCount = Math.max(...hourlyCounts, 1);
+    const barsHtml = hourlyCounts.map((count, hour) => {
+      const barHeight = count / maxCount * 100;
+      const isPeak = count > 0 && count === maxCount;
+      return `<div class="bar-wrapper"><div class="bar-value ${count === 0 ? "hidden" : ""}">${count}</div><div class="bar-container"><div class="bar ${isPeak ? "peak" : ""}" style="height: ${barHeight}%;"></div></div><div class="bar-label">${hour}</div></div>`;
+    }).join("");
+    const cardHtml = `<div class="container"><div class="header"><table class="header-table"><tr><td class="header-table-left"><div class="stat-chip">总计: <span>${typeof total === "number" ? total.toLocaleString() : total}</span></div></td><td class="header-table-center"><h1 class="title-text">${title}</h1></td><td class="header-table-right"><div class="time-label">${time.toLocaleString("zh-CN", { hour12: false }).replace(/\//g, "-")}</div></td></tr></table></div><div class="chart-container">${barsHtml}</div></div>`;
+    const chartStyles = `.chart-container{display:flex;align-items:flex-end;gap:4px;height:180px;padding:30px 15px 10px;border-top:1px solid var(--border-color)}.bar-wrapper{flex:1;text-align:center;display:flex;flex-direction:column;height:100%;justify-content:flex-end}.bar-value{font-size:11px;color:var(--sub-text-color);height:16px;line-height:16px;font-weight:500}.bar-value.hidden{visibility:hidden}.bar-container{flex-grow:1;display:flex;align-items:flex-end;width:100%}.bar{width:100%;background-color:var(--accent-color);opacity:.7;border-radius:3px 3px 0 0;transition:height .3s ease-out}.bar.peak{opacity:1;background-color:var(--gold)!important}.bar-label{font-size:10px;color:var(--sub-text-color);margin-top:4px;height:12px}`;
+    const fullHtml = this.generateFullHtml(cardHtml, chartStyles);
+    const imageBuffer = await this.htmlToImage(fullHtml);
+    return imageBuffer ? [imageBuffer] : "图片渲染失败";
+  }
 };
 // src/Stat.ts
@@ -341,7 +344,7 @@ var Stat = class {
   renderer;
   /**
    * @public @method registerCommands
-   * @description 根据配置，动态地将 `.cmd`, `.msg`, `.rank` 子命令注册到主 `analyse` 命令下。
+   * @description 根据配置，动态地将子命令注册到主 `analyse` 命令下。
    * @param analyse - 主 `analyse` 命令实例。
    */
   registerCommands(analyse) {
@@ -426,6 +429,28 @@ var Stat = class {
         return "渲染发言排行图片失败";
       }
     });
+    if (this.config.enableActivityStat) analyse.subcommand(".activity", "用户活跃分析").option("user", "-u <user:string> 指定用户").option("guild", "-g <guildId:string> 指定群组").option("all", "-a 全局").action(createHandler(async (scope) => {
+      const hourlyStats = await this.ctx.database.select("analyse_rank").where({ uid: { $in: scope.uids } }).groupBy(
+        ["timestamp"],
+        { count: /* @__PURE__ */ __name((row) => import_koishi3.$.sum(row.count), "count") }
+      ).execute();
+      if (hourlyStats.length === 0) return "暂无消息数据";
+      const hourlyCounts = Array(24).fill(0);
+      let totalMessages = 0;
+      hourlyStats.forEach((stat) => {
+        const hour = stat.timestamp.getHours();
+        hourlyCounts[hour] = stat.count;
+        totalMessages += stat.count;
+      });
+      const title = await this.generateTitle(scope.scopeDesc, { main: "活跃分析" });
+      const result = await this.renderer.renderCircadianChart({
+        title,
+        time: /* @__PURE__ */ new Date(),
+        total: totalMessages,
+        data: hourlyCounts
+      });
+      return result;
+    }));
   }
   /**
    * @private @method parseQueryScope
@@ -670,6 +695,7 @@ var Config = import_koishi6.Schema.intersect([
   import_koishi6.Schema.object({
     enableCmdStat: import_koishi6.Schema.boolean().default(true).description("启用命令统计"),
     enableMsgStat: import_koishi6.Schema.boolean().default(true).description("启用消息统计"),
+    enableActivityStat: import_koishi6.Schema.boolean().default(true).description("启用活跃分析"),
     enableOriRecord: import_koishi6.Schema.boolean().default(true).description("启用原始记录")
   }).description("功能配置"),
   import_koishi6.Schema.object({

package/package.json CHANGED Viewed

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