@koishi-ce/plugin-broadcast 1.0.0

package/lib/assets/zh-CN-Bnc3gtS6.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+import { Context, Schema } from "@koishi-ce/koishi";
+//#region src/index.d.ts
+/** 配置项（当前无可用配置） */
+type Config = Record<never, never>;
+declare const name = "broadcast";
+declare const inject: string[];
+declare const Config: Schema<Config>;
+declare function apply(ctx: Context): void;
+//#endregion
+export { Config, apply, inject, name };

package/lib/index.mjs

@@ -0,0 +1,32 @@
+import { Channel, Schema } from "@koishi-ce/koishi";
+import zhCN from "./assets/zh-CN-Bnc3gtS6.yml";
+//#region src/index.ts
+/**
+* 全体广播插件（broadcast）。
+*
+* 提供 `broadcast <message>` 指令（权限 4）：向全部频道推送消息，
+* 默认跳过标记为静默（silent）的频道。
+* 选项：`-f` 强制发送到静默频道；`-o` 仅发送到当前 bot 被指派的频道。
+* 依赖数据库（channel 表的 assignee / flag 字段）。
+*/
+const name = "broadcast";
+const inject = ["database"];
+const Config = Schema.object({});
+function apply(ctx) {
+	ctx.i18n.define("zh-CN", zhCN);
+	ctx.command("broadcast <message:text>", { authority: 4 }).option("forced", "-f").option("only", "-o").action(async ({ options, session }, message) => {
+		if (!session || !options) return;
+		if (!message) return session.text(".expect-text");
+		if (!options.only) {
+			await ctx.broadcast(message, Boolean(options.forced));
+			return;
+		}
+		const fields = ["id"];
+		if (!options.forced) fields.push("flag");
+		let channels = await ctx.database.getAssignedChannels(fields, { [session.platform]: [session.selfId] });
+		if (!options.forced) channels = channels.filter((g) => !(g.flag & Channel.Flag.silent));
+		await session.bot.broadcast(channels.map((channel) => channel.id), message);
+	});
+}
+//#endregion
+export { Config, apply, inject, name };

package/locales/de-DE.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/locales/en-US.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: Please type to send

package/locales/fr-FR.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/locales/ja-JP.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/locales/ru-RU.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/locales/zh-CN.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服广播
+    options:
+      forced: 无视 silent 标签进行广播
+      only: 仅向当前账号负责的群进行广播
+    messages:
+      expect-text: 请输入要发送的文本。

package/locales/zh-TW.yml

@@ -0,0 +1,8 @@
+commands:
+  broadcast:
+    description: 全服廣播
+    options:
+      forced: 無視 silent 標籤進行廣播
+      only: 僅向當前賬號負責的群進行廣播
+    messages:
+      expect-text: 請輸入要傳送的文字。

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@koishi-ce/plugin-broadcast",
+    "description": "Broadcast messages in Koishi",
+    "version": "1.0.0",
+    "type": "module",
+    "main": "lib/index.mjs",
+    "typings": "lib/index.d.ts",
+    "files": [
+        "lib",
+        "src",
+        "locales"
+    ],
+    "contributors": [
+        "Shigma <shigma10826@gmail.com>",
+        "Oppenheymu <oppenheymu@gmail.com>"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Koishi-CE/koishi.git",
+        "directory": "plugins/common/broadcast"
+    },
+    "bugs": {
+        "url": "https://github.com/Koishi-CE/koishi/issues"
+    },
+    "homepage": "https://koishi.chat/plugins/common/broadcast.html",
+    "keywords": [
+        "bot",
+        "chatbot",
+        "koishi",
+        "plugin",
+        "broadcast"
+    ],
+    "koishi": {
+        "category": "tool",
+        "description": {
+            "en": "Broadcast messages",
+            "zh": "发送广播消息"
+        },
+        "service": {
+            "required": [
+                "database"
+            ]
+        },
+        "locales": [
+            "zh"
+        ]
+    },
+    "peerDependencies": {
+        "koishi": "^4.18.11"
+    },
+    "devDependencies": {
+        "@koishi-ce/plugin-mock": "^1.0.0",
+        "@minatojs/driver-memory": "^3.7.0",
+        "@koishi-ce/koishi": "^1.0.0",
+        "minato": "^3.7.0"
+    },
+    "exports": {
+        ".": {
+            "source": "./src/index.ts",
+            "types": "./lib/index.d.ts",
+            "import": "./lib/index.mjs",
+            "default": "./lib/index.mjs"
+        }
+    }
+}

package/src/index.test.ts

@@ -0,0 +1,65 @@
+/**
+ * broadcast 插件测试：用两个 mock bot 验证全局广播、
+ * 仅本 bot 广播（-o）与静默频道过滤（-f）的目标频道集合。
+ */
+import { beforeAll, describe, expect, it, jest } from "bun:test";
+import { App, type Bot, Channel } from "@koishi-ce/koishi";
+import * as broadcast from "@koishi-ce/plugin-broadcast";
+import mock from "@koishi-ce/plugin-mock";
+import memory from "@minatojs/driver-memory";
+
+const app = new App({
+	delay: { broadcast: 0 },
+});
+
+app.plugin(mock, { selfId: "514" });
+app.plugin(mock, { selfId: "114" });
+app.plugin(memory);
+app.plugin(broadcast);
+
+const client = app.mock.client("123");
+
+beforeAll(async () => {
+	await app.start();
+	await app.mock.initUser("123", 4);
+	await app.mock.initChannel("111", "114");
+	await app.mock.initChannel("222", "514");
+	await app.mock.initChannel("333", "514", { flag: Channel.Flag.silent });
+	await app.mock.initChannel("444", "810");
+});
+
+describe("@koishi-ce/plugin-broadcast", () => {
+	// 拦截各 bot 的 sendMessage，断言广播命中了正确的频道且静默频道被正确跳过或强制发送
+	it("basic support", async () => {
+		// 在拦截前验证缺参数提示（此时回复链路完整，消息能送达 mock 客户端）
+		await client.shouldReply("broadcast", "请输入要发送的文本。");
+
+		// 替换 sendMessage 为仅记录参数的 mock；返回空 ID 列表以维持 bot.broadcast 的展开推送
+		const send1 = (app.bots.find((bot) => bot.selfId === "514")!.sendMessage =
+			jest.fn<Bot["sendMessage"]>(async () => []));
+		const send2 = (app.bots.find((bot) => bot.selfId === "114")!.sendMessage =
+			jest.fn<Bot["sendMessage"]>(async () => []));
+
+		await client.shouldNotReply("broadcast foo");
+		// 全局广播：两个 bot 各发送被指派的频道，静默频道 333 被跳过
+		expect(send1.mock.calls).toHaveLength(1);
+		expect(send1.mock.calls[0]?.[0]).toBe("222");
+		expect(send2.mock.calls).toHaveLength(1);
+		expect(send2.mock.calls[0]?.[0]).toBe("111");
+		send1.mockClear();
+		send2.mockClear();
+
+		await client.shouldNotReply("broadcast -o foo");
+		// 仅本 bot：只发送当前 bot（514）被指派的频道，114 不发送
+		expect(send1.mock.calls).toHaveLength(1);
+		expect(send1.mock.calls[0]?.[0]).toBe("222");
+		expect(send2.mock.calls).toHaveLength(0);
+		send1.mockClear();
+
+		await client.shouldNotReply("broadcast -of foo");
+		// 强制模式：静默频道 333 也被发送
+		expect(send1.mock.calls).toHaveLength(2);
+		expect(send1.mock.calls[0]?.[0]).toBe("222");
+		expect(send1.mock.calls[1]?.[0]).toBe("333");
+	});
+});

package/src/index.ts

@@ -0,0 +1,50 @@
+/**
+ * 全体广播插件（broadcast）。
+ *
+ * 提供 `broadcast <message>` 指令（权限 4）：向全部频道推送消息，
+ * 默认跳过标记为静默（silent）的频道。
+ * 选项：`-f` 强制发送到静默频道；`-o` 仅发送到当前 bot 被指派的频道。
+ * 依赖数据库（channel 表的 assignee / flag 字段）。
+ */
+import { Channel, type Context, Schema } from "@koishi-ce/koishi";
+import zhCN from "../locales/zh-CN.yml";
+
+/** 配置项（当前无可用配置） */
+export type Config = Record<never, never>;
+
+export const name = "broadcast";
+export const inject = ["database"];
+export const Config: Schema<Config> = Schema.object({});
+
+export function apply(ctx: Context) {
+	ctx.i18n.define("zh-CN", zhCN);
+
+	ctx
+		.command("broadcast <message:text>", { authority: 4 })
+		.option("forced", "-f")
+		.option("only", "-o")
+		.action(async ({ options, session }, message) => {
+			if (!session || !options) return;
+			if (!message) return session.text(".expect-text");
+			if (!options.only) {
+				// 非仅本 bot 模式：交给全局广播（覆盖所有 bot 的指派频道）
+				await ctx.broadcast(message, Boolean(options.forced));
+				return;
+			}
+
+			// -o 模式：只取当前平台、当前 bot 被指派的频道；非强制时需 flag 字段用于过滤静默频道
+			const fields: ("id" | "flag")[] = ["id"];
+			if (!options.forced) fields.push("flag");
+			let channels = await ctx.database.getAssignedChannels(fields, {
+				[session.platform]: [session.selfId],
+			});
+			if (!options.forced) {
+				channels = channels.filter((g) => !(g.flag & Channel.Flag.silent));
+			}
+			await session.bot.broadcast(
+				channels.map((channel) => channel.id),
+				message,
+			);
+			return undefined;
+		});
+}