koishi-plugin-prism 0.1.15 → 0.1.19

package/README.md

@@ -8,7 +8,7 @@
 
 * 🎮 **玩家入场与结算**：通过 `/login` 和 `/logout` 指令开启或结算计费场次，支持 `/入场` 别名；命令回复会引用触发消息，结账账单可私聊通知管理员与指定用户。
 * 💳 **账户钱包与资产管理**：支持查询钱包余额（`/wallet`）和持有的道具资产（`/items`）。
-* 🀄 **麻将桌位集成**：包含 `/mahjong <tableId>` 以及便捷的 `/上桌` / `/下桌` 控制。`上桌` 仅允许已通过 `login`/`入场` 开启默认入场会话的玩家使用。`list` 按 session 标签分组：有非音乐游戏 session 的玩家归入最新的非音乐标签，纯音乐玩家归入音乐标签；麻将桌额外显示当前人数和容量。已开局桌位会从后端活跃 session 自动恢复，未满桌候座仍由机器人进程暂存，重启后不会保留。
+* 🀄 **麻将桌位集成**：包含 `/mahjong <tableId>`、`/上桌 <桌号>`、自动识别当前桌位的 `/下桌`，以及用于查看桌名、别名和状态的 `/麻将列表`。`上桌` 仅允许已通过 `login`/`入场` 开启默认入场会话的玩家使用。`list` 按 session 标签分组：有非音乐游戏 session 的玩家归入最新的非音乐标签，纯音乐玩家归入音乐标签；麻将桌额外显示当前人数和容量。已开局桌位会从后端活跃 session 自动恢复，未满桌候座仍由机器人进程暂存，重启后不会保留。
 * 🔌 **硬件设备状态与电源管理**：可直接在聊天中查看设备状态（`/show`）、远程开启/关闭电源（`/on`、`/off`）、远程投币（`/coin`）和模拟刷卡（`/scan`）。
 * 🎟️ **礼物兑换码**：使用 `/redeem <code>` 兑换系统发放的福利礼包。
 * 🛠️ **管理员快捷指令**：允许管理员为指定平台用户增加或扣除余额，并覆盖结账金额后立即结账。
@@ -32,6 +32,20 @@
 | `enableStaffCommands` | `boolean` | `false` | 是否开启管理员快捷指令。 |
 | `staffUserIds` | `string[]` | `[]` | 允许执行管理员快捷指令的平台用户 ID（如 QQ 号）白名单。空列表不授予目标用户操作权限。 |
 | `logoutNotifyUserIds` | `string[]` | `[]` | 结账成功后额外私聊完整账单的平台用户 ID。通知收件人为该列表与 `staffUserIds` 的去重并集。 |
+| `mahjongTableConfigs` | `object[]` | `[]` | 推荐的结构化麻将桌列表。每项填写显示名称、命令别名列表与计费方案 ID 列表。显示名称同时作为内部桌位锚点与 session 标签。 |
+| `mahjongTables` | `string` | - | 旧版文本配置，仅在 `mahjongTableConfigs` 为空时读取；建议迁移到结构化列表。 |
+
+### 麻将桌配置
+
+在 Koishi 配置页的 `mahjongTableConfigs` 中新增桌位，每一项填写：
+
+```yaml
+displayName: "🀄️ M.LEAGUE联名比赛专用机"
+aliases: [a, 四麻A, 比赛机]
+pricingConfigIds: [pricing-mahjong-a]
+```
+
+`displayName` 是该桌的稳定锚点和 session 标签；玩家输入的桌号、简称等均写入 `aliases`（至少一个）。结构化配置有内容时优先于旧 `mahjongTables` 文本；已有旧配置不会失效，可逐桌迁移。
 
 管理员快捷指令必须同时配置 `enableStaffCommands: true` 与 `staffUserIds`。它们使用现有 `integrationToken` 调用受限的余额调整和立即结账接口；目标用户参数使用 Koishi 的 `user` 选择器，只有白名单内的管理员可以操作其他用户。
 
@@ -43,6 +57,7 @@
 * `logout` - 结算当前玩家的计费场次。
 玩家在未产生任何费用时退场，机器人会简洁显示“本次未产生费用”和当前余额；存在收费或优惠明细时仍显示完整结算账单。
 结账成功后，机器人会向 `staffUserIds` 与 `logoutNotifyUserIds` 中的用户私聊同一份账单，账单会明确显示结账玩家身份。
+账单和管理员代操作回执均使用“平台昵称（QQ：号码）”称呼玩家；平台暂时无法提供昵称时显示“未知昵称（QQ：号码）”，不会显示内部玩家 ID。
 * `billing` - 预览当前玩家本场计费的消费费用。
 * `wallet` - 查看当前玩家的钱包余额。
 * `items` - 查看当前玩家持有的道具或资产。
@@ -55,8 +70,9 @@
 * `coin <deviceId> [count]` - 请求向指定设备投币指定枚数。
 * `scan <deviceId> <subject>` - 请求向设备发送模拟刷卡。
 * `redeem <code>` - 兑换礼物码。
-* `mahjong <tableId>` / `上桌 <tableId>` - 加入指定麻将桌；仅允许已通过 `login`/`入场` 开启默认入场会话的玩家使用。
-* `下桌 <tableId>` - 离开指定麻将桌。
+* `mahjong <tableId>` / `上桌 [tableId]` - 加入指定麻将桌；`/上桌` 未提供桌号时会引导查看 `/麻将列表`。仅允许已通过 `login`/`入场` 开启默认入场会话的玩家使用。
+* `下桌` - 自动离开当前所在麻将桌。
+* `麻将列表` - 查看已配置机器的桌名、命令别名，以及空闲、等位或游玩中状态。
 
 ### 管理员快捷指令
 启用 `enableStaffCommands`、配置 `staffUserIds` 白名单与 `staffSessionToken` 后可使用：

package/lib/index.d.ts

@@ -14,6 +14,7 @@ export type MahjongTableConfig = {
     aliases: string[];
     pricingConfigIds: string[];
 };
+export type MahjongTableConfigInput = Omit<MahjongTableConfig, "tableId">;
 export type PrismKoishiPluginConfig = {
     provider: string;
     autoRegister: boolean;
@@ -25,6 +26,7 @@ export type PrismKoishiPluginConfig = {
     enableStaffCommands?: boolean;
     staffUserIds?: string[];
     logoutNotifyUserIds?: string[];
+    mahjongTableConfigs?: MahjongTableConfigInput[];
     mahjongTables?: string;
     mahjongTableSize?: number;
     mahjongLabelPrefix?: string;
@@ -75,6 +77,7 @@ export type Sender = {
 };
 export declare function humanReadableBotError(error: PrismBotClientError): string;
 export declare function parseMahjongTables(value: string, labelPrefix: string): Map<string, MahjongTableConfig>;
+export declare function resolveMahjongTableConfigs(structured: readonly MahjongTableConfigInput[], legacyValue: string, labelPrefix: string): Map<string, MahjongTableConfig>;
 declare const _default: {
     name: string;
     Config: Schema<PrismKoishiPluginConfig>;

package/lib/index.js

@@ -5,6 +5,7 @@ exports.apply = apply;
 exports.applyPrismKoishiPlugin = applyPrismKoishiPlugin;
 exports.humanReadableBotError = humanReadableBotError;
 exports.parseMahjongTables = parseMahjongTables;
+exports.resolveMahjongTableConfigs = resolveMahjongTableConfigs;
 const koishi_1 = require("koishi");
 exports.name = "prism";
 exports.Config = koishi_1.Schema.object({
@@ -21,7 +22,12 @@ exports.Config = koishi_1.Schema.object({
     staffUserIds: koishi_1.Schema.array(koishi_1.Schema.string()).default([]).description("允许执行管理员指令的平台用户ID列表"),
     logoutNotifyUserIds: koishi_1.Schema.array(koishi_1.Schema.string()).default([]).description("结账账单私聊通知的平台用户ID列表"),
     powerOffInterval: koishi_1.Schema.number().default(0).description("无人自动关机等待秒数 (0为禁用)"),
-    mahjongTables: koishi_1.Schema.string().description("麻将桌配置"),
+    mahjongTableConfigs: koishi_1.Schema.array(koishi_1.Schema.object({
+        displayName: koishi_1.Schema.string().required().description("桌位显示名称和 session 标签"),
+        aliases: koishi_1.Schema.array(koishi_1.Schema.string()).default([]).description("命令别名（至少一个），例如 a、四麻A"),
+        pricingConfigIds: koishi_1.Schema.array(koishi_1.Schema.string()).default([]).description("开局时绑定的计费方案 ID"),
+    })).default([]).description("麻将桌配置"),
+    mahjongTables: koishi_1.Schema.string().description("旧版麻将桌文本配置（已废弃；仅在结构化配置为空时使用）"),
     mahjongTableSize: koishi_1.Schema.number().default(4).description("麻将桌人数限制"),
     mahjongLabelPrefix: koishi_1.Schema.string().default("麻将桌").description("麻将账单前缀"),
 });
@@ -44,7 +50,8 @@ exports.PrismBotClientError = PrismBotClientError;
 const LOCAL_TZ_OFFSET_MINUTES = 8 * 60;
 const USAGE = {
     mahjong_join: "/上桌 <桌号>",
-    mahjong_leave: "/下桌 <桌号>",
+    mahjong_leave: "/下桌",
+    mahjong_list: "/麻将列表",
     prism_on: "/prism on <设备ID>",
     prism_off: "/prism off <设备ID|all>",
     prism_coin: "/prism coin <设备ID> [数量]",
@@ -69,8 +76,9 @@ function applyPrismKoishiPlugin(ctx, config) {
     ctx.command("login [target:user]", "开启玩家计费场次").action(wrap(async (context, target) => service.loginForTarget(await service.sender(context), target, context.session?.bot)));
     ctx.command("入场 [target:user]", "入场").action(wrap(async (context, target) => service.loginForTarget(await service.sender(context), target, context.session?.bot)));
     ctx.command("mahjong <tableId>", "加入指定麻将桌").action(wrap(async (context, tableId) => service.mahjongJoin(await service.sender(context), tableId)));
-    ctx.command("上桌 <tableId>", "加入指定麻将桌").action(wrap(async (context, tableId) => service.mahjongJoin(await service.sender(context), tableId)));
-    ctx.command("下桌 <tableId>", "离开指定麻将桌").action(wrap(async (context, tableId) => service.mahjongLeave(await service.sender(context), tableId)));
+    ctx.command("上桌 [tableId]", "加入指定麻将桌").action(wrap(async (context, tableId) => service.mahjongJoin(await service.sender(context), tableId)));
+    ctx.command("下桌", "离开当前所在麻将桌").action(wrap(async (context) => service.mahjongLeave(await service.sender(context))));
+    ctx.command("麻将列表", "查看麻将机状态与别名").action(wrap(async () => service.listMahjongTables()));
     ctx.command("logout [target:user]", "结算玩家计费场次").action(wrap(async (context, target) => service.withTarget(await service.sender(context), target, (sender) => service.logout(sender, context.session?.bot), context.session?.bot)));
     ctx.command("billing [target:user]", "预览玩家结账费用").action(wrap(async (context, target) => service.withTarget(await service.sender(context), target, (sender) => service.billing(sender), context.session?.bot)));
     ctx.command("wallet [target:user]", "查看玩家钱包").action(wrap(async (context, target) => service.withTarget(await service.sender(context), target, (sender) => service.wallet(sender), context.session?.bot)));
@@ -324,7 +332,7 @@ class PrismKoishiService {
     }
     async sender(context) {
         const id = context.session?.senderId || context.session?.userId || "";
-        let name = id;
+        let name = context.session?.username || context.session?.senderName || id;
         try {
             if (context.session?.bot?.getUser) {
                 const user = await context.session.bot.getUser(id);
@@ -333,9 +341,7 @@ class PrismKoishiService {
                 }
             }
         }
-        catch {
-            name = context.session?.username || context.session?.senderName || id;
-        }
+        catch { }
         return { id, name };
     }
     async register(sender) {
@@ -345,7 +351,7 @@ class PrismKoishiService {
     async loginForTarget(actor, targetSubject, bot) {
         return this.withTarget(actor, targetSubject, async (sender, isTargeted) => {
             await this.client.startSessionByIdentity(this.identity(sender), this.loginSessionBody());
-            return isTargeted ? `✅ 已为用户 ${formatPlayerReference(sender)} 入场成功` : "✅ 入场成功";
+            return isTargeted ? `✅ 已为用户 ${formatPlayerReference(sender, this.config.provider)} 入场成功` : "✅ 入场成功";
         }, bot);
     }
     async login(sender) {
@@ -370,7 +376,7 @@ class PrismKoishiService {
                     quantityDelta: amount * direction,
                     reason: isAddition ? "Koishi 管理员增加余额" : "Koishi 管理员扣除余额",
                 }]);
-            return `✅ 已为用户 ${sender.id}${isAddition ? "增加" : "扣除"} ${formatNumber(amount)} ${this.config.currencyName}`;
+            return `✅ 已为用户 ${formatPlayerReference(sender, this.config.provider)}${isAddition ? "增加" : "扣除"} ${formatNumber(amount)} ${this.config.currencyName}`;
         }, bot);
     }
     async overwriteTargetCheckout(actor, targetSubject, rawAmount, rawReason, bot) {
@@ -380,16 +386,16 @@ class PrismKoishiService {
                 return "金额必须为非负数";
             const reason = cleanText(rawReason) || "Koishi 管理员手动调价";
             await this.client.checkoutWithOverrideByIdentity(this.identity(sender), total, reason);
-            return `✅ 已为用户 ${formatPlayerReference(sender)} 覆盖结账为 ${formatNumber(total)} ${this.config.currencyName}`;
+            return `✅ 已为用户 ${formatPlayerReference(sender, this.config.provider)} 覆盖结账为 ${formatNumber(total)} ${this.config.currencyName}`;
         }, bot);
     }
     async mahjongJoin(sender, rawTableId) {
         const tableId = cleanText(rawTableId);
         if (!tableId)
-            return commandUsage("mahjong_join");
+            return "请指定麻将桌，例如 /上桌 a；可先使用 /麻将列表 查看可用桌位。";
         const tableConfig = this.mahjongTableConfigs().get(tableId);
         if (!tableConfig)
-            return `找不到 ${tableId} 桌的麻将计费配置。`;
+            return `未找到麻将桌「${tableId}」。可先使用 /麻将列表 查看可用桌位。`;
         const tableKey = tableConfig.tableId;
         const tableSubject = tableConfig.displayName || `${tableKey} 桌`;
         const player = await this.resolvePlayer(sender);
@@ -402,11 +408,11 @@ class PrismKoishiService {
         }
         const existing = this.mahjongTableForPlayer(playerId);
         if (existing)
-            return `你已经在 ${existing} 桌了。`;
+            return `你已经在 ${existing}，无需重复上桌。`;
         const state = this.mahjongTables.get(tableKey) ?? { waiting: [], activeSessions: {} };
         this.mahjongTables.set(tableKey, state);
         if (Object.keys(state.activeSessions).length > 0) {
-            return `${tableSubject}已经开始计费，请先等当前这一桌结束。`;
+            return `「${tableSubject}」正在游玩中（${Object.keys(state.activeSessions).length}/${this.config.mahjongTableSize ?? 4}），请等待本局结束后再上桌。`;
         }
         state.waiting.push({
             playerId,
@@ -433,20 +439,19 @@ class PrismKoishiService {
         }
         return `${tableSubject}已满，麻将计费已开始。`;
     }
-    async mahjongLeave(sender, rawTableId) {
-        const tableId = cleanText(rawTableId);
-        if (!tableId)
-            return commandUsage("mahjong_leave");
-        const tableConfig = this.mahjongTableConfigs().get(tableId);
-        const tableKey = tableConfig?.tableId ?? tableId;
-        const tableSubject = tableConfig?.displayName || `${tableId} 桌`;
+    async mahjongLeave(sender) {
         const activeResult = (await this.client.listActiveSessions());
         this.syncMahjongTableStates((activeResult.sessions ?? []));
-        const state = this.mahjongTables.get(tableKey);
-        if (!state)
-            return `你不在 ${tableSubject}。`;
         const player = await this.resolvePlayer(sender);
         const playerId = String(player.id ?? "");
+        const tableKey = this.mahjongTableForPlayer(playerId);
+        if (!tableKey)
+            return "你当前未在任何麻将桌上。";
+        const tableConfig = uniqueMahjongConfigs(this.mahjongTableConfigs()).find((table) => table.tableId === tableKey);
+        const tableSubject = tableConfig?.displayName || tableKey;
+        const state = this.mahjongTables.get(tableKey);
+        if (!state)
+            return "你当前未在任何麻将桌上。";
         const waitingBefore = state.waiting.length;
         state.waiting = state.waiting.filter((seat) => seat.playerId !== playerId);
         if (state.waiting.length !== waitingBefore) {
@@ -454,11 +459,31 @@ class PrismKoishiService {
         }
         const sessionId = state.activeSessions[playerId];
         if (!sessionId)
-            return `你不在 ${tableSubject}。`;
+            return "你当前未在任何麻将桌上。";
         delete state.activeSessions[playerId];
         await this.client.stopSessionByIdentity(this.identity(sender), sessionId);
         return `已离开 ${tableSubject}，麻将计费已停止。`;
     }
+    async listMahjongTables() {
+        const activeResult = (await this.client.listActiveSessions());
+        this.syncMahjongTableStates((activeResult.sessions ?? []));
+        const tableSize = this.config.mahjongTableSize ?? 4;
+        const tables = uniqueMahjongConfigs(this.mahjongTableConfigs());
+        if (tables.length === 0)
+            return "当前没有配置任何麻将机。";
+        const lines = [`🀄️ 麻将机列表（${tables.length} 台）`];
+        for (const table of tables) {
+            const state = this.mahjongTables.get(table.tableId) ?? { waiting: [], activeSessions: {} };
+            const activeCount = Object.keys(state.activeSessions).length;
+            const waitingCount = state.waiting.length;
+            const statuses = [
+                ...(activeCount > 0 ? [`游玩中 ${activeCount}/${tableSize}`] : []),
+                ...(waitingCount > 0 ? [`等位 ${waitingCount}/${tableSize}`] : []),
+            ];
+            lines.push(`- ${table.displayName}｜别名：${table.aliases.length > 0 ? table.aliases.join("、") : "无"}｜${statuses.join("；") || "空闲"}`);
+        }
+        return lines.join("\n");
+    }
     async billing(sender) {
         const result = (await this.client.previewCheckoutByIdentity(this.identity(sender)));
         return this.formatCheckoutPreview(result, sender);
@@ -675,7 +700,7 @@ class PrismKoishiService {
     }
     mergeWaitingSeats(groups) {
         for (const [tableId, state] of this.mahjongTables) {
-            const table = this.mahjongTableConfigs().get(tableId);
+            const table = uniqueMahjongConfigs(this.mahjongTableConfigs()).find((candidate) => candidate.tableId === tableId);
             if (!table)
                 continue;
             const label = mahjongSessionLabel(table, this.config.mahjongLabelPrefix ?? "麻将桌");
@@ -702,8 +727,8 @@ class PrismKoishiService {
             return playerId || "未知玩家";
         const platformName = await this.resolvePlatformName(sender.id);
         const name = platformName
-            || (sender.name && sender.name !== sender.id ? sender.name : playerId)
-            || sender.id;
+            || (sender.name && sender.name !== sender.id ? sender.name : "")
+            || "未知昵称";
         return `玩家：${name}（${this.config.provider.toUpperCase()}：${sender.id}）`;
     }
     mahjongTableForPlayer(playerId) {
@@ -716,7 +741,7 @@ class PrismKoishiService {
         return null;
     }
     mahjongTableConfigs() {
-        return parseMahjongTables(this.config.mahjongTables ?? "", this.config.mahjongLabelPrefix ?? "麻将桌");
+        return resolveMahjongTableConfigs(this.config.mahjongTableConfigs ?? [], this.config.mahjongTables ?? "", this.config.mahjongLabelPrefix ?? "麻将桌");
     }
     syncMahjongTableStates(sessions) {
         const tables = uniqueMahjongConfigs(this.mahjongTableConfigs());
@@ -969,6 +994,23 @@ function parseMahjongTables(value, labelPrefix) {
     }
     return tables;
 }
+function resolveMahjongTableConfigs(structured, legacyValue, labelPrefix) {
+    if (structured.length === 0)
+        return parseMahjongTables(legacyValue, labelPrefix);
+    const tables = new Map();
+    for (const input of structured) {
+        const displayName = cleanText(input.displayName);
+        const tableId = displayName;
+        const aliases = [...new Set((input.aliases ?? []).map(cleanText).filter(Boolean))];
+        const pricingConfigIds = (input.pricingConfigIds ?? []).map(cleanText).filter(Boolean);
+        if (!tableId || !displayName || pricingConfigIds.length === 0)
+            continue;
+        const table = { tableId, displayName, aliases, pricingConfigIds };
+        for (const alias of aliases)
+            tables.set(alias, table);
+    }
+    return tables;
+}
 function uniqueMahjongConfigs(tables) {
     return [...new Map([...tables.values()].map((table) => [table.tableId, table])).values()];
 }
@@ -1001,7 +1043,7 @@ function formatPlayerGroups(groups, tableSize, mahjongLabelPrefix) {
         const heading = group.table
             ? `${formatMahjongTableLabel(group.table, mahjongLabelPrefix)} ( ${group.players.length}/${tableSize} )`
             : `${group.label} ( ${group.players.length}人 )`;
-        lines.push(`${heading}：\n${formatPlayerNames(group.players)}`);
+        lines.push(`\n${heading}：\n${formatPlayerNames(group.players)}`);
     }
     return lines.join("\n");
 }
@@ -1042,10 +1084,9 @@ function normalizeTargetSubject(value) {
     const separator = subject.indexOf(":");
     return separator > 0 ? subject.slice(separator + 1) : subject;
 }
-function formatPlayerReference(sender) {
-    return sender.name && sender.name !== sender.id
-        ? `${sender.name}（QQ：${sender.id}）`
-        : sender.id;
+function formatPlayerReference(sender, provider = "qq") {
+    const name = sender.name && sender.name !== sender.id ? sender.name : "未知昵称";
+    return `${name}（${provider.toUpperCase()}：${sender.id}）`;
 }
 function toNumber(value) {
     if (value == null)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koishi-plugin-prism",
-  "version": "0.1.15",
+  "version": "0.1.19",
   "description": "PRiSM Next 计费与设备管理系统的 Koishi 机器人集成插件",
   "main": "./lib/index.js",
   "exports": {