@koishi-ce/plugin-callme 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,82 @@
+# @koishi-ce/plugin-callme
+
+**简体中文** | [English](#english)
+
+用户昵称插件，移植自上游 [koishijs/koishi](https://github.com/koishijs/koishi) 的 `plugins/common/callme`。用户可以查询或设置自己在机器人处的称呼，称呼会显示在部分插件的回复中。
+
+## 指令
+
+| 指令 | 权限 | 说明 |
+| --- | --- | --- |
+| `callme [name:text]` | 1 | 查询或设置当前用户的称呼，别名 `nn`，并注册快捷调用「叫我 XX」 |
+
+- 不带参数时查询当前称呼。
+- 新称呼与其他用户重名时会拒绝修改。
+
+## 配置项
+
+本插件无需配置。
+
+## 用法
+
+```bash
+bun add @koishi-ce/plugin-callme
+```
+
+也可以在控制台的插件市场中直接安装。随后在配置文件中启用：
+
+```yaml
+plugins:
+  callme: {}
+```
+
+## 备注
+
+- 依赖数据库服务（读写内置 `user` 表的 `name` 字段）。
+- 昵称仅保留纯文本，其余消息元素会被自动剥离。
+- 其他插件可以通过 `common/callme` 事件（`ctx.bail`）返回字符串来拦截昵称修改。
+
+## 许可证
+
+[MIT](https://github.com/Koishi-CE/koishi/blob/main/LICENSE)。本包是上游 koishijs/koishi 的社区再分发，版权归属见 [NOTICE](https://github.com/Koishi-CE/koishi/blob/main/NOTICE)。
+
+---
+
+## English
+
+A nickname plugin, ported from `plugins/common/callme` of the upstream [koishijs/koishi](https://github.com/koishijs/koishi) repository. Users can query or set the nickname the bot uses for them.
+
+## Commands
+
+| Command | Authority | Description |
+| --- | --- | --- |
+| `callme [name:text]` | 1 | Query or set the current user's nickname; alias `nn`, with the shortcut "叫我 XX" (Chinese only) |
+
+Calling it without arguments queries the current nickname; duplicate nicknames are rejected.
+
+## Configuration
+
+None.
+
+## Usage
+
+```bash
+bun add @koishi-ce/plugin-callme
+```
+
+The plugin can also be installed from the console plugin market, then enabled in the config file:
+
+```yaml
+plugins:
+  callme: {}
+```
+
+## Notes
+
+- Requires the database service (reads and writes the `name` field of the built-in `user` table).
+- Nicknames are reduced to plain text; other message elements are stripped.
+- Other plugins may intercept nickname changes by returning a string from the `common/callme` event (`ctx.bail`).
+
+## License
+
+[MIT](https://github.com/Koishi-CE/koishi/blob/main/LICENSE). This package is a community redistribution of upstream koishijs/koishi; see [NOTICE](https://github.com/Koishi-CE/koishi/blob/main/NOTICE) for attribution.

package/lib/assets/{zh-CN-Vuobuf_Z.yml → zh-CN-DvjQLXEL.yml}

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
     description: 修改自己的称呼

package/lib/index.d.ts

@@ -6,10 +6,9 @@ declare module "@koishi-ce/koishi" {
   }
 }
 /** 配置项（当前无可用配置） */
-type Config = Record<never, never>;
-declare const name = "callme";
-declare const inject: string[];
-declare const Config: Schema<Config>;
-declare function apply(ctx: Context): void;
-//#endregion
-export { Config, apply, inject, name };
+export type Config = Record<never, never>;
+export declare const name = "callme";
+export declare const inject: string[];
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context): void;
+//#endregion

package/lib/index.mjs

@@ -1,5 +1,5 @@
 import { RuntimeError, Schema, h } from "@koishi-ce/koishi";
-import zhCN from "./assets/zh-CN-Vuobuf_Z.yml";
+import zhCN from "./assets/zh-CN-DvjQLXEL.yml";
 //#region src/index.ts
 /**
 * 称呼设置插件（callme）。

package/locales/de-DE.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
-    description: 修改自己的称呼
+    description: Eigenen Spitznamen ändern
     messages:
-      current: 好的呢，{0}！
-      unnamed: 你还没有给自己起一个称呼呢~
-      unchanged: 称呼未发生变化。
-      empty: 称呼不能为空。
-      invalid: 称呼中禁止包含纯文本以外的内容。
-      duplicate: 禁止与其他用户重名。
-      updated: 好的，{0}，请多指教！
-      failed: 修改称呼失败。
+      current: Na klar, {0}!
+      unnamed: Sie haben sich noch keinen Spitznamen gegeben~
+      unchanged: Der Spitzname hat sich nicht geändert.
+      empty: Der Spitzname darf nicht leer sein.
+      invalid: Der Spitzname darf nur reinen Text enthalten.
+      duplicate: Der Spitzname darf nicht bereits von einem anderen Benutzer verwendet werden.
+      updated: Alles klar, {0}, freut mich, Sie kennenzulernen!
+      failed: Der Spitzname konnte nicht geändert werden.

package/locales/en-US.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
-    description: 修改自己的称呼
+    description: Change your nickname
     messages:
-      current: 好的呢，{0}！
-      unnamed: 你还没有给自己起一个称呼呢~
-      unchanged: 称呼未发生变化。
-      empty: 称呼不能为空。
-      invalid: 称呼中禁止包含纯文本以外的内容。
-      duplicate: 禁止与其他用户重名。
-      updated: 好的，{0}，请多指教！
-      failed: 修改称呼失败。
+      current: Okay, {0}!
+      unnamed: You haven't set a nickname for yourself yet~
+      unchanged: Nickname unchanged.
+      empty: Nickname cannot be empty.
+      invalid: The nickname must not contain anything other than plain text.
+      duplicate: This nickname is already taken by another user.
+      updated: Alright, {0}, nice to meet you!
+      failed: Failed to change your nickname.

package/locales/fr-FR.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
-    description: 修改自己的称呼
+    description: Modifier votre surnom
     messages:
-      current: 好的呢，{0}！
-      unnamed: 你还没有给自己起一个称呼呢~
-      unchanged: 称呼未发生变化。
-      empty: 称呼不能为空。
-      invalid: 称呼中禁止包含纯文本以外的内容。
-      duplicate: 禁止与其他用户重名。
-      updated: 好的，{0}，请多指教！
-      failed: 修改称呼失败。
+      current: "Entendu, {0} !"
+      unnamed: Vous ne vous êtes pas encore choisi de surnom~
+      unchanged: Le surnom n'a pas changé.
+      empty: Le surnom ne peut pas être vide.
+      invalid: Le surnom ne doit contenir que du texte brut.
+      duplicate: Ce surnom est déjà utilisé par un autre utilisateur.
+      updated: "Très bien, {0}, ravi de faire votre connaissance !"
+      failed: Échec de la modification du surnom.

package/locales/ja-JP.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
-    description: 修改自己的称呼
+    description: 自分の呼び名を変更する
     messages:
-      current: 好的呢，{0}！
-      unnamed: 你还没有给自己起一个称呼呢~
-      unchanged: 称呼未发生变化。
-      empty: 称呼不能为空。
-      invalid: 称呼中禁止包含纯文本以外的内容。
-      duplicate: 禁止与其他用户重名。
-      updated: 好的，{0}，请多指教！
-      failed: 修改称呼失败。
+      current: わかったよ、{0}！
+      unnamed: まだ自分の呼び名を設定していないよ〜
+      unchanged: 呼び名は変更されていません。
+      empty: 呼び名は空にできません。
+      invalid: 呼び名にはプレーンテキスト以外の内容を含めることはできません。
+      duplicate: 他のユーザーと同じ呼び名は使用できません。
+      updated: わかった、{0}、これからよろしく！
+      failed: 呼び名の変更に失敗しました。

package/locales/ru-RU.yml

@@ -1,12 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
-    description: 修改自己的称呼
+    description: Изменить своё обращение
     messages:
-      current: 好的呢，{0}！
-      unnamed: 你还没有给自己起一个称呼呢~
-      unchanged: 称呼未发生变化。
-      empty: 称呼不能为空。
-      invalid: 称呼中禁止包含纯文本以外的内容。
-      duplicate: 禁止与其他用户重名。
-      updated: 好的，{0}，请多指教！
-      failed: 修改称呼失败。
+      current: Конечно, {0}!
+      unnamed: Вы ещё не задали себе обращение~
+      unchanged: Обращение не изменилось.
+      empty: Обращение не может быть пустым.
+      invalid: Обращение не должно содержать ничего, кроме простого текста.
+      duplicate: Это обращение уже используется другим пользователем.
+      updated: Хорошо, {0}, приятно познакомиться!
+      failed: Не удалось изменить обращение.

package/locales/zh-CN.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
     description: 修改自己的称呼

package/locales/zh-TW.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2019-present Shigma and Koishijs contributors.
+
 commands:
   callme:
     description: 修改自己的稱呼

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@koishi-ce/plugin-callme",
     "description": "Set User Nickname in Koishi",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "type": "module",
     "main": "lib/index.mjs",
     "typings": "lib/index.d.ts",
@@ -47,11 +47,11 @@
         ]
     },
     "peerDependencies": {
-        "koishi": "^4.18.11"
+        "@koishi-ce/koishi": "^1.0.0"
     },
     "devDependencies": {
         "@koishi-ce/plugin-mock": "^1.0.0",
-        "@koishi-ce/koishi": "^1.0.0"
+        "@koishi-ce/koishi": "^1.0.8"
     },
     "exports": {
         ".": {

package/src/index.test.ts

@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2026-present Koishi-CE contributors.
+
+import {
+	afterAll,
+	beforeAll,
+	describe,
+	expect,
+	it,
+} from "bun:test";
+import {
+	App,
+	Database,
+	Logger,
+	RuntimeError,
+} from "@koishi-ce/koishi";
+import mock from "@koishi-ce/plugin-mock";
+// 同 admin 既有测试：CJS 实现配 ESM 声明，nodenext 互操作视图多包一层 default，转型取真实插件对象
+import * as memoryModule from "@koishijs/plugin-database-memory";
+import * as callme from "./index.ts";
+
+const memory =
+	memoryModule.default as unknown as typeof memoryModule.default.default;
+
+const app = new App();
+
+app.plugin(memory);
+app.plugin(mock);
+app.plugin(callme);
+
+const client = app.mock.client("123");
+
+beforeAll(async () => {
+	await app.start();
+	// 预建用户，确保后续会话走 set 更新路径而非自动 createUser
+	await app.mock.initUser("123", 1);
+});
+
+afterAll(async () => {
+	await app.stop();
+});
+
+describe("callme 指令", () => {
+	it("未设置称呼时提示未命名", async () => {
+		const replies = await client.receive("callme");
+		expect(replies[0]).toBe("你还没有给自己起一个称呼呢~");
+	});
+
+	it("设置称呼后回执新称呼并落库", async () => {
+		const replies = await client.receive("callme 小明");
+		expect(replies[0]).toBe("好的，小明，请多指教！");
+		const user = await app.database.getUser("mock", "123");
+		expect(user?.name).toBe("小明");
+	});
+
+	it("重复查询显示当前称呼", async () => {
+		const replies = await client.receive("nn");
+		expect(replies[0]).toBe("好的呢，小明！");
+	});
+
+	it("称呼未变化时提示 unchanged", async () => {
+		const replies = await client.receive("callme 小明");
+		expect(replies[0]).toBe("称呼未发生变化。");
+	});
+
+	it("纯文本以外的内容剥离后为空时提示 empty", async () => {
+		const replies = await client.receive(
+			'callme <image url="x"/>',
+		);
+		expect(replies[0]).toBe("称呼不能为空。");
+	});
+
+	it("common/callme 事件监听者返回字符串可拦截修改", async () => {
+		const dispose = app.on(
+			"common/callme",
+			(name) => `禁止设置称呼：${name}`,
+		);
+		const replies = await client.receive("callme 小红");
+		dispose();
+		expect(replies[0]).toBe("禁止设置称呼：小红");
+		// 拦截路径不应写入数据库
+		const user = await app.database.getUser("mock", "123");
+		expect(user?.name).toBe("小明");
+	});
+
+	it("快捷方式「叫我」在称呼机器人后可免指令名调用", async () => {
+		// shortcut 带 prefix: true，要求消息以 @机器人 的称呼开头
+		const replies = await client.receive(
+			'<at id="514"/>叫我小红',
+		);
+		expect(replies[0]).toBe("好的，小红，请多指教！");
+	});
+
+	it("监听者返回空字符串时不拦截", async () => {
+		const dispose = app.on("common/callme", () => "");
+		const replies = await client.receive("callme 小刚");
+		dispose();
+		expect(replies[0]).toBe("好的，小刚，请多指教！");
+	});
+
+	it("落库遇到 duplicate-entry 错误时给出重名提示", async () => {
+		const proto = Database.prototype as unknown as Record<
+			string,
+			(...args: unknown[]) => Promise<unknown>
+		>;
+		const original = proto["set"];
+		// RuntimeError.check 以 message 精确匹配 code 字符串
+		proto["set"] = async () => {
+			throw new RuntimeError(
+				"duplicate-entry",
+				"duplicate-entry",
+			);
+		};
+		const replies = await client
+			.receive("callme 小亮")
+			.finally(() => {
+				proto["set"] = original!;
+			});
+		expect(replies[0]).toBe("禁止与其他用户重名。");
+	});
+
+	it("落库遇到其他错误时提示修改失败", async () => {
+		// 落库异常的 common 域告警是被测行为的预期伴生输出，静默之
+		(Logger.levels as Record<string, number>)["common"] = 0;
+		const proto = Database.prototype as unknown as Record<
+			string,
+			(...args: unknown[]) => Promise<unknown>
+		>;
+		const original = proto["set"];
+		proto["set"] = async () => {
+			throw new Error("boom");
+		};
+		try {
+			const replies = await client.receive("callme 小强");
+			expect(replies[0]).toBe("修改称呼失败。");
+		} finally {
+			proto["set"] = original!;
+			delete (Logger.levels as Record<string, number>)[
+				"common"
+			];
+		}
+	});
+});

package/src/index.ts

@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2019-present Shigma and Koishijs contributors.
+// Copyright (c) 2026-present Koishi-CE contributors.
+
 /**
  * 称呼设置插件（callme）。
  *
@@ -5,7 +9,12 @@
  * 查询或修改当前用户的昵称（写入数据库 user.name）。
  * 其他插件可监听 `common/callme` 事件校验或拒绝昵称修改。
  */
-import { type Context, h, RuntimeError, Schema } from "@koishi-ce/koishi";
+import {
+	type Context,
+	h,
+	RuntimeError,
+	Schema,
+} from "@koishi-ce/koishi";
 import zhCN from "../locales/zh-CN.yml";
 
 // 模块增强：新增 common/callme 事件，监听者返回字符串即可拦截昵称修改。
@@ -42,7 +51,9 @@ export function apply(ctx: Context) {
 			if (!user) return;
 			if (!name) {
 				if (user.name) {
-					return session.text(".current", [session.username]);
+					return session.text(".current", [
+						session.username,
+					]);
 				} else {
 					return session.text(".unnamed");
 				}
@@ -63,7 +74,11 @@ export function apply(ctx: Context) {
 			}
 
 			// 广播 common/callme 事件：任一监听者返回字符串即视为拦截
-			const result = ctx.bail("common/callme", name, session);
+			const result = ctx.bail(
+				"common/callme",
+				name,
+				session,
+			);
 			if (result) return result;
 
 			// 昵称重名（duplicate-entry）给出专门提示，其余异常记日志并告知失败