@zhin.js/plugin-group-admin 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/lib/index.js

@@ -0,0 +1,139 @@
+/**
+ * @zhin.js/plugin-group-admin
+ *
+ * 群管理插件 —— 入群欢迎、关键词回复、撤回提示、AI 群公告工具
+ *
+ * 功能：
+ *   - 入群欢迎：监听 notice.receive 中的成员加入事件，发送可自定义欢迎语
+ *   - 关键词回复：中间件匹配消息关键词并自动回复，支持增删查命令管理
+ *   - 撤回提示：监听 notice.receive 中的群消息撤回事件，通知群内
+ *   - AI 工具：group_announce，AI 可调用发送群公告
+ *
+ * 命令：
+ *   添加关键词 <keyword:text> <reply:text>  添加关键词回复对
+ *   删除关键词 <keyword:text>               删除关键词
+ *   关键词列表                               查看所有关键词
+ */
+import { usePlugin, MessageCommand, ZhinTool } from 'zhin.js';
+const plugin = usePlugin();
+const { addCommand, addMiddleware, addTool, logger } = plugin;
+// ─── 入群欢迎 ───────────────────────────────────────────────────────────────
+const WELCOME_TEMPLATE = '欢迎新成员加入本群！';
+plugin.on('notice.receive', async (notice) => {
+    if (notice.$type !== 'group_member_increase')
+        return;
+    if (notice.$channel.type !== 'group')
+        return;
+    const targetName = notice.$target?.name || notice.$target?.id || '新成员';
+    const welcomeMsg = `🎉 ${targetName}，${WELCOME_TEMPLATE}`;
+    try {
+        const adapter = plugin.inject(notice.$adapter);
+        if (!adapter)
+            return;
+        const bot = adapter.bots?.find((b) => b.$config?.name === notice.$bot || b.$id === notice.$bot);
+        if (!bot)
+            return;
+        await bot.$sendMessage({
+            context: notice.$adapter,
+            bot: notice.$bot,
+            content: welcomeMsg,
+            id: notice.$channel.id,
+            type: notice.$channel.type,
+        });
+    }
+    catch (e) {
+        logger.warn(`发送入群欢迎消息失败: ${e.message}`);
+    }
+});
+// ─── 关键词回复 ──────────────────────────────────────────────────────────────
+const keywords = new Map();
+// 中间件：匹配关键词自动回复
+addMiddleware(async (message, next) => {
+    if (message.$channel.type !== 'group') {
+        await next();
+        return;
+    }
+    const raw = message.$raw?.trim();
+    if (!raw) {
+        await next();
+        return;
+    }
+    for (const [keyword, reply] of keywords) {
+        if (raw.includes(keyword)) {
+            await message.$reply(reply);
+            return;
+        }
+    }
+    await next();
+});
+// 命令：添加关键词
+addCommand(new MessageCommand('添加关键词 <keyword:text> <reply:text>')
+    .desc('添加一个关键词自动回复对')
+    .action(async (_message, result) => {
+    const { keyword, reply } = result.params;
+    if (!keyword || !reply)
+        return '请提供关键词和回复内容';
+    keywords.set(keyword, reply);
+    return `已添加关键词「${keyword}」→「${reply}」`;
+}));
+// 命令：删除关键词
+addCommand(new MessageCommand('删除关键词 <keyword:text>')
+    .desc('删除一个关键词')
+    .action(async (_message, result) => {
+    const { keyword } = result.params;
+    if (!keyword)
+        return '请提供要删除的关键词';
+    if (!keywords.has(keyword))
+        return `关键词「${keyword}」不存在`;
+    keywords.delete(keyword);
+    return `已删除关键词「${keyword}」`;
+}));
+// 命令：关键词列表
+addCommand(new MessageCommand('关键词列表')
+    .desc('查看所有关键词回复对')
+    .action(async () => {
+    if (keywords.size === 0)
+        return '当前没有设置任何关键词';
+    const lines = Array.from(keywords.entries()).map(([k, v], i) => `${i + 1}. 「${k}」→「${v}」`);
+    return `关键词列表（共 ${keywords.size} 条）：\n${lines.join('\n')}`;
+}));
+// ─── 撤回提示 ───────────────────────────────────────────────────────────────
+plugin.on('notice.receive', async (notice) => {
+    if (notice.$type !== 'group_recall')
+        return;
+    if (notice.$channel.type !== 'group')
+        return;
+    const operatorName = notice.$operator?.name || notice.$operator?.id || '某人';
+    const msg = `⚠️ ${operatorName} 撤回了一条消息`;
+    try {
+        const adapter = plugin.inject(notice.$adapter);
+        if (!adapter)
+            return;
+        const bot = adapter.bots?.find((b) => b.$config?.name === notice.$bot || b.$id === notice.$bot);
+        if (!bot)
+            return;
+        await bot.$sendMessage({
+            context: notice.$adapter,
+            bot: notice.$bot,
+            content: msg,
+            id: notice.$channel.id,
+            type: notice.$channel.type,
+        });
+    }
+    catch (e) {
+        logger.warn(`发送撤回提示失败: ${e.message}`);
+    }
+});
+// ─── AI 工具：群公告 ─────────────────────────────────────────────────────────
+addTool(new ZhinTool('group_announce')
+    .desc('向群聊发送公告/通知消息')
+    .keyword('群公告', '通知', 'announce')
+    .param('message', { type: 'string', description: '要发送的公告内容' }, true)
+    .execute(async (args) => {
+    const content = args.message;
+    if (!content?.trim())
+        return '公告内容不能为空';
+    return `📢 群公告：\n${content}`;
+})
+    .toTool());
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;AAC1B,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;AAE7D,2EAA2E;AAE3E,MAAM,gBAAgB,GAAG,YAAY,CAAA;AAErC,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;IAC3C,IAAI,MAAM,CAAC,KAAK,KAAK,uBAAuB;QAAE,OAAM;IACpD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,OAAO;QAAE,OAAM;IAE5C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,EAAE,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,IAAI,KAAK,CAAA;IACtE,MAAM,UAAU,GAAG,MAAM,UAAU,IAAI,gBAAgB,EAAE,CAAA;IAEzD,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAe,CAAQ,CAAA;QAC5D,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,CAAA;QACpG,IAAI,CAAC,GAAG;YAAE,OAAM;QAChB,MAAM,GAAG,CAAC,YAAY,CAAC;YACrB,OAAO,EAAE,MAAM,CAAC,QAAQ;YACxB,GAAG,EAAE,MAAM,CAAC,IAAI;YAChB,OAAO,EAAE,UAAU;YACnB,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;YACtB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;SAC3B,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACzC,CAAC;AACH,CAAC,CAAC,CAAA;AAEF,2EAA2E;AAE3E,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAA;AAE1C,gBAAgB;AAChB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACpC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACtC,MAAM,IAAI,EAAE,CAAA;QACZ,OAAM;IACR,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,CAAA;IAChC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,EAAE,CAAA;QACZ,OAAM;IACR,CAAC;IAED,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;QACxC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAM;QACR,CAAC;IACH,CAAC;IAED,MAAM,IAAI,EAAE,CAAA;AACd,CAAC,CAAC,CAAA;AAEF,WAAW;AACX,UAAU,CACR,IAAI,cAAc,CAAC,mCAAmC,CAAC;KACpD,IAAI,CAAC,cAAc,CAAC;KACpB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAA4C,CAAA;IAC9E,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK;QAAE,OAAO,aAAa,CAAA;IAC5C,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IAC5B,OAAO,UAAU,OAAO,MAAM,KAAK,GAAG,CAAA;AACxC,CAAC,CAAC,CACL,CAAA;AAED,WAAW;AACX,UAAU,CACR,IAAI,cAAc,CAAC,sBAAsB,CAAC;KACvC,IAAI,CAAC,SAAS,CAAC;KACf,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;IACjC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAA6B,CAAA;IACxD,IAAI,CAAC,OAAO;QAAE,OAAO,YAAY,CAAA;IACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,OAAO,MAAM,CAAA;IACvD,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACxB,OAAO,UAAU,OAAO,GAAG,CAAA;AAC7B,CAAC,CAAC,CACL,CAAA;AAED,WAAW;AACX,UAAU,CACR,IAAI,cAAc,CAAC,OAAO,CAAC;KACxB,IAAI,CAAC,YAAY,CAAC;KAClB,MAAM,CAAC,KAAK,IAAI,EAAE;IACjB,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,aAAa,CAAA;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAC9C,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CACzC,CAAA;IACD,OAAO,WAAW,QAAQ,CAAC,IAAI,SAAS,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;AAC5D,CAAC,CAAC,CACL,CAAA;AAED,2EAA2E;AAE3E,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;IAC3C,IAAI,MAAM,CAAC,KAAK,KAAK,cAAc;QAAE,OAAM;IAC3C,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,OAAO;QAAE,OAAM;IAE5C,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAA;IAC3E,MAAM,GAAG,GAAG,MAAM,YAAY,UAAU,CAAA;IAExC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAe,CAAQ,CAAA;QAC5D,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,CAAA;QACpG,IAAI,CAAC,GAAG;YAAE,OAAM;QAChB,MAAM,GAAG,CAAC,YAAY,CAAC;YACrB,OAAO,EAAE,MAAM,CAAC,QAAQ;YACxB,GAAG,EAAE,MAAM,CAAC,IAAI;YAChB,OAAO,EAAE,GAAG;YACZ,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;YACtB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;SAC3B,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACvC,CAAC;AACH,CAAC,CAAC,CAAA;AAEF,0EAA0E;AAE1E,OAAO,CACL,IAAI,QAAQ,CAAC,gBAAgB,CAAC;KAC3B,IAAI,CAAC,cAAc,CAAC;KACpB,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC;KAChC,KAAK,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,IAAI,CAAC;KACnE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACtB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAiB,CAAA;IACtC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE;QAAE,OAAO,UAAU,CAAA;IACvC,OAAO,YAAY,OAAO,EAAE,CAAA;AAC9B,CAAC,CAAC;KACD,MAAM,EAAE,CACZ,CAAA"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@zhin.js/plugin-group-admin",
+  "version": "0.0.1",
+  "description": "Group management plugin for Zhin.js — welcome, keyword reply, recall detection",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "development": "./src/index.ts",
+      "import": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": ["src", "lib", "README.md"],
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf lib"
+  },
+  "keywords": ["zhin", "zhin.js", "bot", "plugin", "group", "admin", "welcome", "keyword-reply"],
+  "author": { "name": "lc-cn", "email": "admin@liucl.cn", "url": "https://github.com/lc-cn" },
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": { "typescript": "^5.9.3", "zhin.js": "workspace:*" },
+  "peerDependencies": { "zhin.js": ">=1.0.60" },
+  "repository": { "type": "git", "url": "git+https://github.com/zhinjs/zhin.git", "directory": "plugins/utils/group-admin" },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

package/src/index.ts

@@ -0,0 +1,154 @@
+/**
+ * @zhin.js/plugin-group-admin
+ *
+ * 群管理插件 —— 入群欢迎、关键词回复、撤回提示、AI 群公告工具
+ *
+ * 功能：
+ *   - 入群欢迎：监听 notice.receive 中的成员加入事件，发送可自定义欢迎语
+ *   - 关键词回复：中间件匹配消息关键词并自动回复，支持增删查命令管理
+ *   - 撤回提示：监听 notice.receive 中的群消息撤回事件，通知群内
+ *   - AI 工具：group_announce，AI 可调用发送群公告
+ *
+ * 命令：
+ *   添加关键词 <keyword:text> <reply:text>  添加关键词回复对
+ *   删除关键词 <keyword:text>               删除关键词
+ *   关键词列表                               查看所有关键词
+ */
+import { usePlugin, MessageCommand, ZhinTool } from 'zhin.js'
+
+const plugin = usePlugin()
+const { addCommand, addMiddleware, addTool, logger } = plugin
+
+// ─── 入群欢迎 ───────────────────────────────────────────────────────────────
+
+const WELCOME_TEMPLATE = '欢迎新成员加入本群！'
+
+plugin.on('notice.receive', async (notice) => {
+  if (notice.$type !== 'group_member_increase') return
+  if (notice.$channel.type !== 'group') return
+
+  const targetName = notice.$target?.name || notice.$target?.id || '新成员'
+  const welcomeMsg = `🎉 ${targetName}，${WELCOME_TEMPLATE}`
+
+  try {
+    const adapter = plugin.inject(notice.$adapter as any) as any
+    if (!adapter) return
+    const bot = adapter.bots?.find((b: any) => b.$config?.name === notice.$bot || b.$id === notice.$bot)
+    if (!bot) return
+    await bot.$sendMessage({
+      context: notice.$adapter,
+      bot: notice.$bot,
+      content: welcomeMsg,
+      id: notice.$channel.id,
+      type: notice.$channel.type,
+    })
+  } catch (e: any) {
+    logger.warn(`发送入群欢迎消息失败: ${e.message}`)
+  }
+})
+
+// ─── 关键词回复 ──────────────────────────────────────────────────────────────
+
+const keywords = new Map<string, string>()
+
+// 中间件：匹配关键词自动回复
+addMiddleware(async (message, next) => {
+  if (message.$channel.type !== 'group') {
+    await next()
+    return
+  }
+
+  const raw = message.$raw?.trim()
+  if (!raw) {
+    await next()
+    return
+  }
+
+  for (const [keyword, reply] of keywords) {
+    if (raw.includes(keyword)) {
+      await message.$reply(reply)
+      return
+    }
+  }
+
+  await next()
+})
+
+// 命令：添加关键词
+addCommand(
+  new MessageCommand('添加关键词 <keyword:text> <reply:text>')
+    .desc('添加一个关键词自动回复对')
+    .action(async (_message, result) => {
+      const { keyword, reply } = result.params as { keyword: string; reply: string }
+      if (!keyword || !reply) return '请提供关键词和回复内容'
+      keywords.set(keyword, reply)
+      return `已添加关键词「${keyword}」→「${reply}」`
+    }),
+)
+
+// 命令：删除关键词
+addCommand(
+  new MessageCommand('删除关键词 <keyword:text>')
+    .desc('删除一个关键词')
+    .action(async (_message, result) => {
+      const { keyword } = result.params as { keyword: string }
+      if (!keyword) return '请提供要删除的关键词'
+      if (!keywords.has(keyword)) return `关键词「${keyword}」不存在`
+      keywords.delete(keyword)
+      return `已删除关键词「${keyword}」`
+    }),
+)
+
+// 命令：关键词列表
+addCommand(
+  new MessageCommand('关键词列表')
+    .desc('查看所有关键词回复对')
+    .action(async () => {
+      if (keywords.size === 0) return '当前没有设置任何关键词'
+      const lines = Array.from(keywords.entries()).map(
+        ([k, v], i) => `${i + 1}. 「${k}」→「${v}」`,
+      )
+      return `关键词列表（共 ${keywords.size} 条）：\n${lines.join('\n')}`
+    }),
+)
+
+// ─── 撤回提示 ───────────────────────────────────────────────────────────────
+
+plugin.on('notice.receive', async (notice) => {
+  if (notice.$type !== 'group_recall') return
+  if (notice.$channel.type !== 'group') return
+
+  const operatorName = notice.$operator?.name || notice.$operator?.id || '某人'
+  const msg = `⚠️ ${operatorName} 撤回了一条消息`
+
+  try {
+    const adapter = plugin.inject(notice.$adapter as any) as any
+    if (!adapter) return
+    const bot = adapter.bots?.find((b: any) => b.$config?.name === notice.$bot || b.$id === notice.$bot)
+    if (!bot) return
+    await bot.$sendMessage({
+      context: notice.$adapter,
+      bot: notice.$bot,
+      content: msg,
+      id: notice.$channel.id,
+      type: notice.$channel.type,
+    })
+  } catch (e: any) {
+    logger.warn(`发送撤回提示失败: ${e.message}`)
+  }
+})
+
+// ─── AI 工具：群公告 ─────────────────────────────────────────────────────────
+
+addTool(
+  new ZhinTool('group_announce')
+    .desc('向群聊发送公告/通知消息')
+    .keyword('群公告', '通知', 'announce')
+    .param('message', { type: 'string', description: '要发送的公告内容' }, true)
+    .execute(async (args) => {
+      const content = args.message as string
+      if (!content?.trim()) return '公告内容不能为空'
+      return `📢 群公告：\n${content}`
+    })
+    .toTool(),
+)