@starhikari/koishi-plugin-group-whitelist 1.0.0 → 1.0.1

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { Context, Schema } from 'koishi';
+import { Context, Session, Schema } from 'koishi';
 export declare const name = "group-whitelist";
 /**
  * 数据库为可选依赖：
@@ -49,7 +49,32 @@ declare module 'koishi' {
     interface Events {
         /** 手动刷新白名单缓存（可选传入平台名，只刷新该平台） */
         'group-whitelist/refresh'(platform?: string): void;
+        /**
+         * onebot 适配器把戳一戳、撤回、表情回应等通知类事件派发为 notice / onebot 事件。
+         * 适配器自身没有声明这些事件类型，这里补上声明，好让本插件能监听它们做拦截与日志。
+         */
+        'notice'(session: Session): void;
+        'onebot'(session: Session): void;
     }
+    interface Context {
+        /** 由本插件提供的群白名单服务，其他插件可用它判断某个会话是否被允许 */
+        groupWhitelist: WhitelistService;
+    }
+}
+/**
+ * 群白名单服务接口。
+ *
+ * 必须 **导出**：它被 `declare module 'koishi'` 里的 `Context` 增强引用，
+ * 若声明为模块内私有接口，tsc 会认为无法命名而在生成的 .d.ts 中**静默丢弃整个增强块**，
+ * 导致其他插件（如 bot-poke）编译时报 `Property 'groupWhitelist' does not exist on type 'Context'`。
+ */
+export interface WhitelistService {
+    /** 当前会话所在群是否在白名单内；私聊按 privateChat 策略判定 */
+    isAllowed(session: Session): boolean;
+    /** 直接按平台 + 群号判定 */
+    isAllowedGroup(platform: string, groupId: string): boolean;
+    /** 强制重新载入判定表 */
+    refresh(platform?: string): Promise<void>;
 }
 export interface GroupWhitelistEntry {
     /** 平台名，如 onebot / qq */

package/lib/index.js

@@ -476,25 +476,34 @@ function apply(ctx, config) {
     return "";
   }
   __name(resolveBlockSync, "resolveBlockSync");
-  ctx.on("ready", async () => {
-    for (const platform of new Set(ctx.bots.map((bot) => bot.platform))) {
-      await ensurePlatformLoaded(platform);
-    }
-  });
+  const GATED_EVENTS = /* @__PURE__ */ new Set(["message", "message-created", "notice", "onebot"]);
   ctx.before("attach", (session) => {
     if (!session.userId || !session.event) return;
     if (!session.guildId) return;
+    if (!GATED_EVENTS.has(session.event.type)) return;
     ensurePlatformLoaded(session.platform).catch((error) => {
       logger.warn("载入白名单失败：%s", error instanceof Error ? error.message : error);
     });
   });
   ctx.on("message", (session) => {
     if (!session.userId || !session.event) return;
+    if (!GATED_EVENTS.has(session.event.type)) return;
     const blocked = resolveBlockSync(session);
     if (blocked === null) return;
     blockedMap.set(session, blocked);
     session.response = async () => blockedMap.get(session) ?? "";
   }, { prepend: true });
+  ctx.on("notice", (session) => logBlockedEvent(session), { prepend: true });
+  ctx.on("onebot", (session) => logBlockedEvent(session), { prepend: true });
+  function logBlockedEvent(session) {
+    if (!session.userId || !session.event) return;
+    if (!session.guildId) return;
+    if (resolveBlockSync(session) === null) return;
+    if (config.enableLog) {
+      logger.debug("已拦截非白名单群的非消息事件：%s / %s / %s", session.platform, session.guildId, session.event.type);
+    }
+  }
+  __name(logBlockedEvent, "logBlockedEvent");
   const sample = ctx.bots[0]?.session({ type: "message" });
   const prototype = sample ? Object.getPrototypeOf(sample) : null;
   if (prototype && typeof prototype.execute === "function") {
@@ -705,6 +714,21 @@ function apply(ctx, config) {
       logger.info("数据库服务已卸载，白名单回落到配置模式（fallbackGroups）");
     });
   });
+  const service = {
+    isAllowed(session) {
+      if (!session.guildId) {
+        if (config.privateChat === "all") return true;
+        if (config.privateChat === "whitelist") {
+          return !!session.userId && config.privateWhitelist.includes(session.userId);
+        }
+        return false;
+      }
+      return isGroupAllowedSync(session.platform, session.guildId);
+    },
+    isAllowedGroup: /* @__PURE__ */ __name((platform, groupId) => isGroupAllowedSync(platform, groupId), "isAllowedGroup"),
+    refresh
+  };
+  ctx.set("groupWhitelist", service);
   async function refresh(platform) {
     if (platform) {
       platformLoaded.delete(platform);

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@starhikari/koishi-plugin-group-whitelist",
   "description": "实现koishi全局白名单，群聊不在白名单内时bot将不再处理该群的任何消息与指令",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
+  "types": "lib/index.d.ts",
   "files": [
     "lib",
     "dist"

package/readme.md

@@ -154,6 +154,36 @@ OneBot 的群消息事件里**没有群名**（事件只带 `group_id`），群
 取不到名称时**保留原有值**，不会把已有数据清空；名称相同也不会产生多余的写库操作。
 未注册数据库（配置模式）时没有可持久化的位置，群名改为列表展示时按需查询并缓存在内存中。
 
+## 给其他插件用的服务
+
+总闸能**自动**拦下的只有消息事件：`Processor.attach` 只挂在消息事件上，所以 `session.response`
+这套机制对 notice / onebot 事件无效。必须自己查一下白名单：
+
+```ts
+// 1) 声明可选依赖
+export const inject = { optional: ['groupWhitelist'] }
+
+// 2) tsconfig 里让类型可见（模块增强只有被引入才会生效）
+//    "types": ["node", "@starhikari/koishi-plugin-group-whitelist"]
+
+// 3) 用可选链，未装白名单插件时自动退化为「不受限制」
+ctx.on('notice', async (session) => {
+  if (!ctx.groupWhitelist?.isAllowed(session)) return
+  
+})
+```
+
+服务接口：
+
+| 成员 | 说明 |
+|------|------|
+| `isAllowed(session)` | 当前会话所在群是否在白名单内；私聊按 `privateChat` 策略判定 |
+| `isAllowedGroup(platform, groupId)` | 直接按平台 + 群号判定 |
+| `refresh(platform?)` | 强制重新载入判定表 |
+
+**总闸覆盖的事件类型**：`message`、`notice`、`onebot`。入群、好友请求等管理类事件不在其中，
+否则入群提示、加好友审核会被误伤。
+
 ## 权限模型
 
 管理指令的裁决**完全由插件自己完成**（`ensureAdmin`），Koishi 内置的 `authority` 权限被刻意设为 0