koishi-plugin-statistical-ranking/lib/index.d.ts

统计命令使用和成员发言记录，支持分命令/群组/用户统计，支持统计发言排行，支持输出图片

import { Context, Schema } from 'koishi';
export declare const name = "statistical-ranking";
export declare const inject: {
    required: string[];
    optional: string[];
};
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\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";
/**
 * 插件配置接口
 * @interface Config
 * @property {boolean} [enableDataTransfer] - 是否启用数据导入导出功能
 * @property {string[]} [displayBlacklist] - 显示过滤黑名单
 * @property {string[]} [displayWhitelist] - 显示过滤白名单
 * @property {boolean} [defaultImageMode] - 是否默认使用图片模式展示
 * @property {boolean} [enableRank] - 是否启用排行榜功能
 * @property {string} [updateInterval] - 排行榜更新频率
 */
export interface Config {
    enableDataTransfer?: boolean;
    displayBlacklist?: string[];
    displayWhitelist?: string[];
    defaultImageMode?: boolean;
    enableRank?: boolean;
    updateInterval?: string;
}
/**
 * 插件配置模式
 */
export declare const Config: Schema<Schemastery.ObjectS<{}>, {} & import("cosmokit").Dict>;
/**
 * 数据表声明
 */
declare module 'koishi' {
    interface Tables {
        'analytics.stat': StatRecord;
        'analytics.rank': RankRecord;
        'analytics.command': LegacyCommandRecord;
        binding: BindingRecord;
    }
}
/**
 * 排行榜记录数据结构
 * @interface RankRecord
 * @description 存储用户统计数据的排名记录
 * @property {number} id - 排行榜记录的唯一ID（自增主键，导入导出时会自动忽略）
 * @property {number} stat - 统计记录ID，关联到统计数据
 * @property {Date} timestamp - 记录时间戳
 * @property {number} count - 统计项的计数值
 */
export interface RankRecord {
    id: number;
    stat: number;
    timestamp: Date;
    count: number;
}
/**
 * 统计记录数据结构
 * @interface StatRecord
 * @description 记录用户在不同平台、群组中的命令使用和消息发送情况
 * @property {number} id - 记录的唯一ID（自增主键，导入导出时会自动忽略）
 * @property {string} platform - 平台标识(如 onebot、telegram 等)
 * @property {string} guildId - 群组/频道 ID，私聊时为 'private'
 * @property {string} userId - 用户在该平台的唯一标识
 * @property {string} [userName] - 用户昵称，可选
 * @property {string} command - 命令名称，普通消息时为 '_message'
 * @property {number} count - 记录次数，用于统计使用频率
 * @property {Date} lastTime - 最后一次记录的时间
 * @property {string} [guildName] - 群组/频道名称，可选
 */
export interface StatRecord {
    id?: number;
    platform: string;
    guildId: string;
    userId: string;
    userName?: string;
    command: string;
    count: number;
    lastTime: Date;
    guildName?: string;
}
/**
 * 历史命令记录结构
 * @interface LegacyCommandRecord
 * @description 用于兼容旧版统计数据的结构
 */
interface LegacyCommandRecord {
    name: string;
    userId: string;
    channelId: string;
    platform?: string;
    date: number;
    hour: number;
    count: number;
}
/**
 * 用户绑定记录结构
 * @interface BindingRecord
 * @description 存储用户跨平台账号绑定关系
 * @property {string} pid - 平台用户 ID
 * @property {string} platform - 平台标识
 * @property {number} aid - 关联账号 ID
 * @property {number} bid - 绑定记录 ID
 */
interface BindingRecord {
    pid: string;
    platform: string;
    aid: number;
    bid: number;
}
/**
 * 插件主函数
 * @public
 * @param ctx - Koishi应用上下文
 * @param config - 插件配置对象
 */
export declare function apply(ctx: Context, config?: Config): Promise<void>;
export {};