@zhin.js/plugin-group-suite 1.0.1 → 1.1.2

package/skills/group-daily-analysis/tools/stats_user/index.ts

@@ -0,0 +1,46 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { getStatsModel } from '../../../../src/db-store.js';
+import { groupSuiteRuntimeToken } from '../../../../src/runtime-state.js';
+import { todayStr } from '../../../../src/shared-runtime.js';
+import { flushStatsBuffer, weekStartStr } from '../../../../src/stats-lib.js';
+
+export default defineAgentTool<{ user_id: string; group_id?: string }>({
+  description: '查询指定用户在当前群或指定群的消息统计',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      user_id: { type: 'string', description: '用户 ID' },
+      group_id: { type: 'string', description: '群 ID；省略时使用当前 IM 会话' },
+    },
+    required: ['user_id'],
+  },
+  requiresApproval: 'never',
+  async execute({ user_id: userId, group_id: requestedGroupId }, context) {
+    const runtime = context.use(groupSuiteRuntimeToken);
+    await flushStatsBuffer(runtime);
+    const model = getStatsModel(runtime.db);
+    if (!model) return '统计数据库尚未就绪';
+    const groupId = requestedGroupId
+      ?? (context.origin.kind === 'im' && context.origin.scope !== 'private'
+        ? context.origin.sceneId
+        : '');
+    const rows = await model.select().where({
+      user_id: userId,
+      ...(groupId ? { group_id: groupId } : {}),
+    });
+    if (rows.length === 0) return `用户 ${userId} 暂无消息记录`;
+    const today = todayStr();
+    const weekStart = weekStartStr();
+    let todayCount = 0;
+    let weekCount = 0;
+    let totalCount = 0;
+    for (const row of rows) {
+      const count = Number(row.count ?? 0);
+      totalCount += count;
+      if (String(row.date) >= weekStart) weekCount += count;
+      if (row.date === today) todayCount += count;
+    }
+    const name = String(rows[0]!.user_name ?? userId);
+    return `${name} 的统计\n今日: ${todayCount}条\n本周: ${weekCount}条\n总计: ${totalCount}条\n活跃天数: ${rows.length}天`;
+  },
+});

package/src/checkin-lib.ts

@@ -0,0 +1,167 @@
+import type { GroupSuiteConfig } from './config.js';
+import { getCheckinModel } from './db-store.js';
+import {
+  randomInt,
+  resolveContextKey,
+  resolveSender,
+  todayStr,
+  ts,
+  yesterdayStr,
+} from './shared-runtime.js';
+import type { GroupSuiteRuntime } from './runtime-state.js';
+
+async function getOrCreateUser(
+  model: any,
+  userId: string,
+  userName: string,
+  ctxType: string,
+  ctxId: string,
+): Promise<Record<string, unknown> | null> {
+  const rows = (await model.select().where({
+    user_id: userId,
+    context_type: ctxType,
+    context_id: ctxId,
+  })) as Record<string, unknown>[];
+  if (rows.length > 0) return rows[0];
+
+  await model.insert({
+    user_id: userId,
+    user_name: userName,
+    points: 0,
+    total_checkins: 0,
+    streak: 0,
+    max_streak: 0,
+    last_checkin: '',
+    context_type: ctxType,
+    context_id: ctxId,
+    created_at: ts(),
+    updated_at: ts(),
+  });
+
+  const created = (await model.select().where({
+    user_id: userId,
+    context_type: ctxType,
+    context_id: ctxId,
+  })) as Record<string, unknown>[];
+  return created[0] ?? null;
+}
+
+/**
+ * 同一 user_id+context 的签到串行化（per-user promise 链），
+ * 避免 check-then-act 竞态导致连发两条都签到成功。
+ */
+function serializedCheckin<T>(
+  chains: Map<string, Promise<unknown>>,
+  key: string,
+  task: () => Promise<T>,
+): Promise<T> {
+  const prev = chains.get(key) ?? Promise.resolve();
+  const next = prev.then(task, task);
+  chains.set(key, next);
+  return next.finally(() => {
+    if (chains.get(key) === next) chains.delete(key);
+  });
+}
+
+export async function doCheckin(
+  input: { sender?: { readonly id: string; readonly name?: string }; target?: string; metadata?: Readonly<Record<string, unknown>> },
+  cfg: GroupSuiteConfig,
+  runtime: GroupSuiteRuntime,
+): Promise<string> {
+  const M = getCheckinModel(runtime.db);
+  if (!M) return '签到数据库尚未就绪，请稍后重试';
+
+  const { id: userId, name: userName } = resolveSender(input);
+  if (!userId) return '无法获取用户信息';
+
+  const { type: ctxType, id: ctxId } = resolveContextKey(input);
+  return serializedCheckin(runtime.checkinChains, `${userId}:${ctxType}:${ctxId}`, async () => {
+    const user = await getOrCreateUser(M, userId, userName, ctxType, ctxId);
+    if (!user) return '签到失败，请重试';
+
+    const today = todayStr();
+    if (user.last_checkin === today) {
+      return `你今天已经签到过了哦～\n当前积分: ${user.points}\n连续签到: ${user.streak} 天`;
+    }
+
+    const isConsecutive = user.last_checkin === yesterdayStr();
+    const newStreak = isConsecutive ? Number(user.streak) + 1 : 1;
+    const base = randomInt(cfg.basePointsMin, cfg.basePointsMax);
+    const bonus = Math.min(newStreak * cfg.streakBonus, cfg.streakCap);
+    const earned = base + bonus;
+    const newPoints = Number(user.points || 0) + earned;
+
+    await M.update({
+      points: newPoints,
+      total_checkins: Number(user.total_checkins || 0) + 1,
+      streak: newStreak,
+      max_streak: Math.max(Number(user.max_streak || 0), newStreak),
+      last_checkin: today,
+      user_name: userName,
+      updated_at: ts(),
+    }).where({
+      user_id: userId,
+      context_type: ctxType,
+      context_id: ctxId,
+    });
+
+    const lines = [`签到成功！`, `基础积分: +${base}`];
+    if (bonus > 0) lines.push(`连续奖励: +${bonus} (连续${newStreak}天)`);
+    lines.push(`本次获得: +${earned}`, `当前积分: ${newPoints}`);
+    return lines.join('\n');
+  });
+}
+
+export async function myPoints(
+  input: { sender?: { readonly id: string; readonly name?: string }; target?: string; metadata?: Readonly<Record<string, unknown>> },
+  runtime: GroupSuiteRuntime,
+): Promise<string> {
+  const M = getCheckinModel(runtime.db);
+  if (!M) return '签到数据库尚未就绪';
+  const { id: userId } = resolveSender(input);
+  const { type: ctxType, id: ctxId } = resolveContextKey(input);
+  const rows = (await M.select().where({
+    user_id: userId,
+    context_type: ctxType,
+    context_id: ctxId,
+  })) as Record<string, unknown>[];
+  if (rows.length === 0) return '你还没有签到记录哦，发送「checkin」开始吧！';
+  const u = rows[0];
+  const checkedToday = u.last_checkin === todayStr();
+  return [
+    `${u.user_name || '用户'} 的积分信息`,
+    `积分: ${u.points}`,
+    `累计签到: ${u.total_checkins} 天`,
+    `连续签到: ${u.streak} 天`,
+    `最长连续: ${u.max_streak} 天`,
+    checkedToday ? '今日已签到 ✓' : '今日未签到',
+  ].join('\n');
+}
+
+export async function pointsRank(
+  input: { sender?: { readonly id: string; readonly name?: string }; target?: string; metadata?: Readonly<Record<string, unknown>> },
+  cfg: GroupSuiteConfig,
+  runtime: GroupSuiteRuntime,
+): Promise<string> {
+  const M = getCheckinModel(runtime.db);
+  if (!M) return '签到数据库尚未就绪';
+  const { type: ctxType, id: ctxId } = resolveContextKey(input);
+  const all = (await M.select().where(
+    ctxType === 'global'
+      ? { context_type: 'global' }
+      : { context_type: ctxType, context_id: ctxId },
+  )) as Record<string, unknown>[];
+  if (all.length === 0) return '还没有人签到过哦～';
+  const sorted = all.sort((a, b) => Number(b.points || 0) - Number(a.points || 0));
+  const top = sorted.slice(0, cfg.rankSize);
+  const medals = ['🥇', '🥈', '🥉'];
+  const lines = top.map((u, i) => {
+    const prefix = i < 3 ? medals[i] : `${i + 1}.`;
+    return `${prefix} ${u.user_name || u.user_id} — ${u.points}分 (${u.total_checkins}天)`;
+  });
+  const title = ctxType === 'group' ? '本群积分排行' : '全局积分排行';
+  const { id: userId } = resolveSender(input);
+  const myRank = sorted.findIndex((u) => u.user_id === userId);
+  const footer = myRank >= 0 ? `\n你的排名: 第${myRank + 1}名` : '';
+  return `${title}\n${lines.join('\n')}${footer}`;
+}

package/src/config.ts

@@ -1,68 +1,34 @@
-import { Schema } from "zhin.js";
-
-/** 扁平 groupSuite 配置（单层字段，默认值覆盖多数场景） */
-export const groupSuiteSchema = Schema.object({
-  welcome: Schema.string()
-    .default("欢迎新成员加入本群！")
-    .description("入群欢迎语"),
-  recallNotify: Schema.boolean()
-    .default(true)
-    .description("群消息撤回时是否提示"),
-  keywordReply: Schema.boolean()
-    .default(false)
-    .description("内置关键词回复（默认关闭，用 teach 问答）"),
-  noticeAdapters: Schema.list(Schema.string())
-    .default(["icqq"])
-    .description("处理 notice 的适配器（欢迎/撤回）"),
-
-  basePointsMin: Schema.number().default(10).min(1).max(100),
-  basePointsMax: Schema.number().default(30).min(1).max(200),
-  streakBonus: Schema.number().default(5).min(0).max(100),
-  streakCap: Schema.number().default(50).min(0).max(500),
-
-  rankSize: Schema.number()
-    .default(10)
-    .min(3)
-    .max(50)
-    .description("签到排行与消息统计排行显示人数"),
-  statsRetentionDays: Schema.number().default(90).min(7).max(365),
-
-  analysisDays: Schema.number().default(1).min(1).max(30),
-  autoAnalysisEnabled: Schema.boolean().default(false),
-  autoAnalysisCron: Schema.string().default("0 9 * * *"),
-  analysisGroups: Schema.list(Schema.string())
-    .default([])
-    .description("启用群日报的群 ID 白名单（空=不限制）"),
-  analysisGroupsBlock: Schema.list(Schema.string())
-    .default([])
-    .description("禁用群日报的群 ID"),
-  analysisMaxMessages: Schema.number().default(500).min(100).max(5000),
-
-  teachMaxPerGroup: Schema.number().default(200).min(1).max(1000),
-  teachCooldownMs: Schema.number().default(3000).min(0).max(60000),
-  teachAllowRegex: Schema.boolean().default(true),
-  teachPageSize: Schema.number().default(10).min(5).max(50),
-});
-
-export type GroupSuiteConfig = {
-  welcome: string;
-  recallNotify: boolean;
+export interface GroupSuiteConfig {
   keywordReply: boolean;
-  noticeAdapters: string[];
   basePointsMin: number;
   basePointsMax: number;
   streakBonus: number;
   streakCap: number;
   rankSize: number;
-  statsRetentionDays: number;
-  analysisDays: number;
-  autoAnalysisEnabled: boolean;
-  autoAnalysisCron: string;
-  analysisGroups: string[];
-  analysisGroupsBlock: string[];
-  analysisMaxMessages: number;
   teachMaxPerGroup: number;
   teachCooldownMs: number;
   teachAllowRegex: boolean;
   teachPageSize: number;
+}
+
+export const DEFAULT_GROUP_SUITE_CONFIG: GroupSuiteConfig = {
+  keywordReply: false,
+  basePointsMin: 10,
+  basePointsMax: 30,
+  streakBonus: 5,
+  streakCap: 50,
+  rankSize: 10,
+  teachMaxPerGroup: 200,
+  teachCooldownMs: 3000,
+  teachAllowRegex: true,
+  teachPageSize: 10,
 };
+
+export function resolveGroupSuiteConfig(
+  raw: Partial<GroupSuiteConfig> | undefined,
+): GroupSuiteConfig {
+  return {
+    ...DEFAULT_GROUP_SUITE_CONFIG,
+    ...raw,
+  };
+}

package/src/db-store.ts

@@ -0,0 +1,19 @@
+import {
+  CHECKIN_TABLE,
+  STATS_TABLE,
+  TEACH_TABLE,
+  type GroupSuiteMemoryDb,
+  type GroupSuiteModel,
+} from './memory-store.js';
+
+export function getCheckinModel(db: GroupSuiteMemoryDb): GroupSuiteModel | undefined {
+  return db.models.get(CHECKIN_TABLE);
+}
+
+export function getTeachModel(db: GroupSuiteMemoryDb): GroupSuiteModel | undefined {
+  return db.models.get(TEACH_TABLE);
+}
+
+export function getStatsModel(db: GroupSuiteMemoryDb): GroupSuiteModel | undefined {
+  return db.models.get(STATS_TABLE);
+}

package/src/index.ts

@@ -1,33 +1,39 @@
-/**
- * @zhin.js/plugin-group-suite
- *
- * ```yaml
- * plugins:
- *   - "@zhin.js/plugin-group-suite"
- * inbox:
- *   enabled: true
- * groupSuite:
- *   noticeAdapters: [icqq]
- *   autoAnalysisEnabled: true
- * ```
- */
-import { formatCompact, usePlugin } from "zhin.js";
-import { groupSuiteSchema } from "./config.js";
-import { registerAdmin } from "./admin.js";
-import { registerCheckin } from "./checkin.js";
-import { registerDailyAnalysis } from "./daily-analysis.js";
-import { registerStats } from "./stats.js";
-import { registerTeach } from "./teach.js";
-
-const plugin = usePlugin();
-const { logger, declareConfig } = plugin;
-
-const cfg = declareConfig("groupSuite", groupSuiteSchema);
-
-registerAdmin(plugin, cfg);
-registerCheckin(plugin, cfg);
-registerStats(plugin, cfg);
-registerDailyAnalysis(plugin, cfg);
-registerTeach(plugin, cfg);
-
-logger.info(formatCompact({ 模块: "群组套件", 状态: "已加载" }));
+export {
+  DEFAULT_GROUP_SUITE_CONFIG,
+  resolveGroupSuiteConfig,
+} from './config.js';
+export type { GroupSuiteConfig } from './config.js';
+export { doCheckin, myPoints, pointsRank } from './checkin-lib.js';
+export {
+  addKeyword,
+  listKeywords,
+  matchKeyword,
+  removeKeyword,
+} from './keyword-store.js';
+export {
+  getCheckinModel,
+  getStatsModel,
+  getTeachModel,
+} from './db-store.js';
+export {
+  createGroupSuiteRuntime,
+  groupSuiteRuntimeToken,
+  resolveGroupSuiteRuntime,
+} from './runtime-state.js';
+export type { GroupSuiteRuntime, PendingStatsIncrement } from './runtime-state.js';
+export {
+  parseTeachPair,
+  teachAdd,
+  teachForget,
+  teachList,
+  tryTeachReply,
+} from './teach-lib.js';
+export {
+  flushStatsBuffer,
+  monthStartStr,
+  myStatsText,
+  queryStats,
+  recordMessage,
+  statsRankText,
+  weekStartStr,
+} from './stats-lib.js';

package/src/keyword-store.ts

@@ -0,0 +1,18 @@
+export function addKeyword(keyword: string, reply: string, store: Map<string, string>): void {
+  store.set(keyword, reply);
+}
+
+export function removeKeyword(keyword: string, store: Map<string, string>): boolean {
+  return store.delete(keyword);
+}
+
+export function listKeywords(store: Map<string, string>): Array<[string, string]> {
+  return Array.from(store.entries());
+}
+
+export function matchKeyword(text: string, store: Map<string, string>): string | null {
+  for (const [keyword, reply] of store) {
+    if (text.includes(keyword)) return reply;
+  }
+  return null;
+}

package/src/memory-store.ts

@@ -0,0 +1,90 @@
+/**
+ * In-memory group-suite models used when no DatabaseHost is available.
+ *
+ * 模型表面与 `@zhin.js/plugin-runtime` 的 DatabaseHostModel 结构兼容
+ * （where 返回 PromiseLike，host 侧是链式 Selection），
+ * plugin.ts 可把 PluginDatabaseHost 直接当 GroupSuiteMemoryDb 用。
+ */
+
+export type GroupSuiteRow = Record<string, unknown>;
+
+export interface GroupSuiteModel {
+  select: (...fields: string[]) => {
+    where: (query: Record<string, unknown>) => PromiseLike<GroupSuiteRow[]>;
+    then: <TResult1 = GroupSuiteRow[], TResult2 = never>(
+      onfulfilled?: ((value: GroupSuiteRow[]) => TResult1 | PromiseLike<TResult1>) | null,
+      onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
+    ) => Promise<TResult1 | TResult2>;
+  };
+  insert: (row: Record<string, unknown>) => Promise<unknown>;
+  delete: () => { where: (query: Record<string, unknown>) => Promise<unknown> };
+  update: (patch: Record<string, unknown>) => {
+    where: (query: Record<string, unknown>) => Promise<unknown>;
+  };
+}
+
+function createMemoryModel(): GroupSuiteModel {
+  const rows: GroupSuiteRow[] = [];
+  let nextId = 1;
+
+  function matches(row: Record<string, unknown>, query: Record<string, unknown>): boolean {
+    return Object.entries(query).every(([key, value]) => row[key] === value);
+  }
+
+  function all(): GroupSuiteRow[] {
+    return rows.map((row) => ({ ...row }));
+  }
+
+  return {
+    select: () => {
+      const promise = Promise.resolve(all());
+      return {
+        where: async (query: Record<string, unknown>) =>
+          rows.filter((row) => matches(row, query)).map((row) => ({ ...row })),
+        then: (onfulfilled, onrejected) => promise.then(onfulfilled, onrejected),
+      };
+    },
+    insert: async (row: Record<string, unknown>) => {
+      const withId: GroupSuiteRow = { id: String(nextId++), ...row };
+      rows.push(withId);
+      return { ...withId };
+    },
+    delete: () => ({
+      where: async (query: Record<string, unknown>) => {
+        for (let i = rows.length - 1; i >= 0; i -= 1) {
+          if (matches(rows[i]!, query)) rows.splice(i, 1);
+        }
+      },
+    }),
+    update: (patch: Record<string, unknown>) => ({
+      where: async (query: Record<string, unknown>) => {
+        for (const row of rows) {
+          if (matches(row, query)) Object.assign(row, patch);
+        }
+      },
+    }),
+  };
+}
+
+export interface GroupSuiteMemoryDb {
+  models: {
+    get: (name: string) => GroupSuiteModel | undefined;
+  };
+}
+
+export const CHECKIN_TABLE = 'checkin_records';
+export const TEACH_TABLE = 'teach_qa';
+export const STATS_TABLE = 'message_stats';
+
+export function createInMemoryGroupSuiteDb(): GroupSuiteMemoryDb {
+  const models = new Map<string, GroupSuiteModel>([
+    [CHECKIN_TABLE, createMemoryModel()],
+    [TEACH_TABLE, createMemoryModel()],
+    [STATS_TABLE, createMemoryModel()],
+  ]);
+  return {
+    models: {
+      get: (name: string) => models.get(name),
+    },
+  };
+}

package/src/runtime-state.ts

@@ -0,0 +1,41 @@
+import { createToken, type Token } from 'zhin.js';
+import type { GroupSuiteMemoryDb } from './memory-store.js';
+
+export interface PendingStatsIncrement {
+  user_id: string;
+  user_name: string;
+  group_id: string;
+  date: string;
+  count: number;
+}
+
+/** All mutable state owned by one group-suite plugin instance. */
+export interface GroupSuiteRuntime {
+  readonly db: GroupSuiteMemoryDb;
+  readonly keywords: Map<string, string>;
+  readonly teachCooldowns: Map<string, number>;
+  readonly statsBuffer: Map<string, PendingStatsIncrement>;
+  readonly checkinChains: Map<string, Promise<unknown>>;
+}
+
+export const groupSuiteRuntimeToken = createToken<GroupSuiteRuntime>(
+  'zhin.group-suite.runtime',
+  'Owner-scoped Group Suite database and ephemeral state',
+);
+
+export function createGroupSuiteRuntime(db: GroupSuiteMemoryDb): GroupSuiteRuntime {
+  return {
+    db,
+    keywords: new Map(),
+    teachCooldowns: new Map(),
+    statsBuffer: new Map(),
+    checkinChains: new Map(),
+  };
+}
+
+export function resolveGroupSuiteRuntime(context: {
+  readonly owner?: unknown;
+  use<T>(token: Token<T>): T;
+}): GroupSuiteRuntime {
+  return context.use(groupSuiteRuntimeToken);
+}

package/src/shared-runtime.ts

@@ -0,0 +1,44 @@
+export function todayStr(): string {
+  const d = new Date();
+  return `${d.getFullYear()}-${String(d.getMonth() + 1).padStart(2, '0')}-${String(d.getDate()).padStart(2, '0')}`;
+}
+
+export function yesterdayStr(): string {
+  const d = new Date();
+  d.setDate(d.getDate() - 1);
+  return `${d.getFullYear()}-${String(d.getMonth() + 1).padStart(2, '0')}-${String(d.getDate()).padStart(2, '0')}`;
+}
+
+export function ts(): string {
+  return new Date().toISOString();
+}
+
+export function randomInt(min: number, max: number): number {
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
+/** Runtime Message → group/global context */
+export function resolveContextKey(input: {
+  conversation?: { readonly kind?: string; readonly id?: string };
+  metadata?: Readonly<Record<string, unknown>>;
+}): { type: string; id: string } {
+  const meta = input.metadata ?? {};
+  const channelType = String(meta.type ?? meta.channelType ?? '');
+  if (channelType === 'group' || channelType === 'guild' || channelType === 'channel') {
+    return { type: 'group', id: String(meta.channelId ?? input.conversation?.id ?? '') };
+  }
+  if (input.conversation && channelType !== 'private') {
+    return { type: 'group', id: String(input.conversation.id ?? '') };
+  }
+  return { type: 'global', id: '' };
+}
+
+export function resolveSender(input: {
+  sender?: { readonly id: string; readonly name?: string };
+  metadata?: Readonly<Record<string, unknown>>;
+}): { id: string; name: string } {
+  const meta = input.metadata ?? {};
+  const id = input.sender?.id ?? String(meta.senderId ?? '');
+  const name = input.sender?.name ?? String(meta.senderName ?? meta.name ?? '用户');
+  return { id, name };
+}