@koishi-ce/plugin-bind 1.0.0

package/lib/assets/en-US-C0a1paCV.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: Bind to account
+  options:
+    remove: Unbind
+  messages:
+    generated-1: |-
+      The Bind command can be used to bind user data across multiple platforms. During the bind process, the original platform's user data is fully preserved, while the target platform's user data is overwritten with the original platform's data.
+      Please make sure that the current platform is your target platform and send the following text to the bot within the original platform using your account within 5 minutes:
+      {0}
+      Once the binding is complete, you can always use "bind -r" to unbind the status.
+    generated-2: |-
+      Token verification successful! The second step will be performed next.
+      Please use your account to send the following text to the bot on the target platform within 5 minutes:
+      {0}
+      Note: The current platform is your original platform, the user data here will overwrite the data from the target platform.
+    success: Account binding has been successful!
+    remove-success: Your account has been successfully unbundled!
+    remove-original: 'Cannot disconnect: This is your original account.'

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

@@ -0,0 +1,20 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    self-1: 请前往原始平台输入。
+    self-2: 请前往目标平台输入。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+import { Context, Schema } from "@koishi-ce/koishi";
+//#region src/index.d.ts
+/** 配置项 */
+interface Config {
+  /** 令牌前缀，默认 `koishi/` */
+  tokenPrefix?: string;
+  /** 自定义令牌生成器（测试中可注入确定性实现） */
+  generateToken?: () => string;
+}
+declare const name = "bind";
+declare const inject: string[];
+declare const Config: Schema<Config>;
+declare function apply(ctx: Context, config?: Config): void;
+//#endregion
+export { Config, apply, inject, name };

package/lib/index.mjs

@@ -0,0 +1,95 @@
+import { Schema, Time } from "@koishi-ce/koishi";
+import enUS from "./assets/en-US-C0a1paCV.yml";
+import zhCN from "./assets/zh-CN-kAS4medd.yml";
+//#region src/index.ts
+const name = "bind";
+const inject = ["database"];
+const Config = Schema.object({ generateToken: Schema.function().hidden() });
+/** 基于密码学安全的随机字节生成指定长度的纯数字串（250 以上的字节拒绝采样，保证分布均匀） */
+function randomDigits(length) {
+	const result = [];
+	while (result.length < length) {
+		const bytes = new Uint8Array(length - result.length);
+		globalThis.crypto.getRandomValues(bytes);
+		for (const byte of bytes) if (byte < 250) result.push(String(byte % 10));
+	}
+	return result.join("");
+}
+function apply(ctx, config = {}) {
+	ctx.i18n.define("zh-CN", zhCN);
+	ctx.i18n.define("en-US", enUS);
+	const tokens = Object.create(null);
+	const { tokenPrefix: prefix = "koishi/" } = config;
+	const { generateToken = () => `${prefix}${randomDigits(6)}` } = config;
+	/** 为当前会话用户签发一次性令牌并记录 phase，5 分钟后自动过期 */
+	function generate(session, phase) {
+		const { userId } = session;
+		if (!userId) return;
+		const token = generateToken();
+		tokens[token] = [
+			session.platform,
+			userId,
+			phase
+		];
+		ctx.setTimeout(() => delete tokens[token], 5 * Time.minute);
+		return token;
+	}
+	/** 将平台账号（platform + pid）绑定到指定用户（aid）名下 */
+	async function bind(aid, platform, pid) {
+		await ctx.database.set("binding", {
+			platform,
+			pid
+		}, { aid });
+	}
+	ctx.command("bind", { authority: 0 }).userFields(["id"]).option("remove", "-r").action(async ({ session, options }) => {
+		if (!session || !options) return;
+		if (options.remove) {
+			const { platform, userId: pid, user } = session;
+			if (!pid || !user) return;
+			const bindings = await ctx.database.get("binding", { aid: user.id });
+			const binding = bindings.find((item) => item.platform === platform && item.pid === pid);
+			if (!binding) return;
+			if (binding.aid !== binding.bid) {
+				await bind(binding.bid, platform, pid);
+				return session.text(".remove-success");
+			} else if (bindings.filter((item) => item.aid === item.bid).length === 1) return session.text(".remove-original");
+			else {
+				const authority = await session.resolve(ctx.root.config.autoAuthorize);
+				await bind((await ctx.database.create("user", { authority })).id, platform, pid);
+				return session.text(".remove-success");
+			}
+		}
+		const token = generate(session, +!session.isDirect);
+		return session.text(".generated-1", [token]);
+	});
+	ctx.middleware(async (session, next) => {
+		const token = session.stripped.content;
+		const data = tokens[token];
+		if (!data) return next();
+		const { userId } = session;
+		if (!userId) return next();
+		if (data[0] === session.platform && data[1] === session.userId) return session.text(`commands.bind.messages.self-${data[2] < 0 ? "2" : "1"}`);
+		delete tokens[token];
+		if (data[2] < 0) {
+			const [binding] = await ctx.database.get("binding", {
+				platform: data[0],
+				pid: data[1]
+			}, ["aid"]);
+			if (!binding) return;
+			await bind(binding.aid, session.platform, userId);
+			return session.text("commands.bind.messages.success");
+		} else {
+			const user = await ctx.database.getUser(session.platform, userId, ["id", "authority"]);
+			if (!user.authority) return session.text("internal.low-authority");
+			if (data[2]) {
+				const token = generate(session, -1);
+				return session.text("commands.bind.messages.generated-2", [token]);
+			} else {
+				await bind(user.id, data[0], data[1]);
+				return session.text("commands.bind.messages.success");
+			}
+		}
+	}, true);
+}
+//#endregion
+export { Config, apply, inject, name };

package/locales/de-DE.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/locales/en-US.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: Bind to account
+  options:
+    remove: Unbind
+  messages:
+    generated-1: |-
+      The Bind command can be used to bind user data across multiple platforms. During the bind process, the original platform's user data is fully preserved, while the target platform's user data is overwritten with the original platform's data.
+      Please make sure that the current platform is your target platform and send the following text to the bot within the original platform using your account within 5 minutes:
+      {0}
+      Once the binding is complete, you can always use "bind -r" to unbind the status.
+    generated-2: |-
+      Token verification successful! The second step will be performed next.
+      Please use your account to send the following text to the bot on the target platform within 5 minutes:
+      {0}
+      Note: The current platform is your original platform, the user data here will overwrite the data from the target platform.
+    success: Account binding has been successful!
+    remove-success: Your account has been successfully unbundled!
+    remove-original: 'Cannot disconnect: This is your original account.'

package/locales/fr-FR.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/locales/ja-JP.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/locales/ru-RU.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/locales/zh-CN.yml

@@ -0,0 +1,20 @@
+commands.bind:
+  description: 绑定到账号
+  options:
+    remove: 解除绑定
+  messages:
+    generated-1: |-
+      Bind 指令可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
+      请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
+      {0}
+      绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
+    generated-2: |-
+      令牌核验成功！下面将进行第二步操作。
+      请在 5 分钟内使用你的账号在目标平台内向机器人发送以下文本：
+      {0}
+      注意：当前平台是你的原始平台，这里的用户数据将覆盖目标平台的数据。
+    self-1: 请前往原始平台输入。
+    self-2: 请前往目标平台输入。
+    success: 账号绑定成功！
+    remove-success: 账号解绑成功！
+    remove-original: 无法解除绑定：这是你的原始账号。

package/locales/zh-TW.yml

@@ -0,0 +1,18 @@
+commands.bind:
+  description: 綁定到賬號
+  options:
+    remove: 解除綁定
+  messages:
+    generated-1: |-
+      Bind 指令可用於在多個平台間綁定用戶數據。綁定過程中，原始平台的使用者數據將完全保留，而目標平台的使用者數據將被原始平台的數據所覆蓋。
+      請確認當前平台是你的目標平台，並在 5 分鐘內使用你的賬號在原始平台內向機器人發送以下文本：
+      {0}
+      綁定完成後，你可以隨時使用「bind -r」來解除綁定狀態。
+    generated-2: |-
+      令牌核驗成功！下面將進行第二步操作。
+      請在 5 分鐘內使用你的賬號在目標平台內向機器人發送以下文本：
+      {0}
+      注意：當前平台是你的原始平台，這裡的使用者數據將覆蓋目標平台的數據。
+    success: 帳號綁定成功！
+    remove-success: 賬號解綁成功！
+    remove-original: 無法解除綁定：這是你的原始賬號。

package/package.json

@@ -0,0 +1,67 @@
+{
+    "name": "@koishi-ce/plugin-bind",
+    "description": "Bind User Accounts Across Platforms 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/bind"
+    },
+    "bugs": {
+        "url": "https://github.com/Koishi-CE/koishi/issues"
+    },
+    "homepage": "https://koishi.chat/plugins/common/bind.html",
+    "keywords": [
+        "bot",
+        "chatbot",
+        "koishi",
+        "plugin",
+        "bind"
+    ],
+    "koishi": {
+        "category": "tool",
+        "description": {
+            "en": "Bind user accounts across platforms",
+            "zh": "跨平台账户绑定 (绑定后在多个平台将共享同一套用户数据)"
+        },
+        "service": {
+            "required": [
+                "database"
+            ]
+        },
+        "locales": [
+            "zh",
+            "en"
+        ]
+    },
+    "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,60 @@
+/**
+ * bind 插件测试：用两个 mock 客户端模拟跨平台用户，
+ * 验证两步令牌绑定流程与解绑（含原初账号保护）。
+ */
+import { afterAll, beforeAll, describe, it } from "bun:test";
+import { Context } from "@koishi-ce/koishi";
+import * as bind from "@koishi-ce/plugin-bind";
+import mock from "@koishi-ce/plugin-mock";
+import memory from "@minatojs/driver-memory";
+
+const app = new Context();
+
+let counter = 0;
+
+app.plugin(bind, {
+	generateToken: () => `koishi/${(++counter).toString().padStart(6, "0")}`,
+});
+
+app.plugin(mock);
+app.plugin(memory);
+
+app
+	.command("name")
+	.userFields(["name"])
+	.action(({ session }) => session!.username);
+
+const client1 = app.mock.client("123", "321");
+const client2 = app.mock.client("456", "654");
+
+beforeAll(async () => {
+	await app.start();
+	await app.mock.initUser("123", 1, { name: "foo" });
+	await app.mock.initUser("456", 1, { name: "bar" });
+});
+
+afterAll(() => app.stop());
+
+describe("@koishi-ce/plugin-bind", () => {
+	// 两用户经两枚令牌完成绑定后，两侧昵称应统一为被绑定者的昵称
+	it("create binding", async () => {
+		await client1.shouldReply("name", "foo");
+		await client2.shouldReply("name", "bar");
+		await client1.shouldReply("bind", /^koishi\/000001$/m);
+		await client1.shouldReply("koishi/000001", "请前往原始平台输入。");
+		await client2.shouldReply("koishi/000001", /^koishi\/000002$/m);
+		await client2.shouldReply("koishi/000002", "请前往目标平台输入。");
+		await client1.shouldReply("koishi/000002", "账号绑定成功！");
+		await client1.shouldReply("name", "bar");
+		await client2.shouldReply("name", "bar");
+	});
+
+	// 解绑：原初账号受保护不可解绑；迁移绑定的账号解绑后各回各的昵称
+	it("remove binding", async () => {
+		await client2.shouldReply("bind -r", "无法解除绑定：这是你的原始账号。");
+		await client1.shouldReply("bind -r", "账号解绑成功！");
+		await client1.shouldReply("name", "foo");
+		await client2.shouldReply("name", "bar");
+		await client1.shouldReply("bind -r", "无法解除绑定：这是你的原始账号。");
+	});
+});

package/src/index.ts

@@ -0,0 +1,151 @@
+/**
+ * 账号绑定插件（bind）。
+ *
+ * 提供跨平台账号绑定：在源平台执行 `bind` 获取一次性令牌，
+ * 前往目标平台发送令牌完成绑定（群聊需要两步互发令牌，私聊一步到位）。
+ * 指令：`bind`（`-r` 解除当前平台账号的绑定）。
+ * 依赖数据库（binding / user 表），令牌默认 5 分钟过期。
+ */
+import type { Context, Dict, Session } from "@koishi-ce/koishi";
+import { Schema, Time } from "@koishi-ce/koishi";
+import enUS from "../locales/en-US.yml";
+import zhCN from "../locales/zh-CN.yml";
+
+/** 配置项 */
+export interface Config {
+	/** 令牌前缀，默认 `koishi/` */
+	tokenPrefix?: string;
+	/** 自定义令牌生成器（测试中可注入确定性实现） */
+	generateToken?: () => string;
+}
+
+export const name = "bind";
+export const inject = ["database"];
+export const Config: Schema<Config> = Schema.object({
+	generateToken: Schema.function().hidden(),
+});
+
+/** 基于密码学安全的随机字节生成指定长度的纯数字串（250 以上的字节拒绝采样，保证分布均匀） */
+function randomDigits(length: number) {
+	const result: string[] = [];
+	while (result.length < length) {
+		const bytes = new Uint8Array(length - result.length);
+		globalThis.crypto.getRandomValues(bytes);
+		for (const byte of bytes) {
+			if (byte < 250) result.push(String(byte % 10));
+		}
+	}
+	return result.join("");
+}
+
+export function apply(ctx: Context, config: Config = {}) {
+	ctx.i18n.define("zh-CN", zhCN);
+	ctx.i18n.define("en-US", enUS);
+
+	// 令牌 phase 含义：1 = 群聊第一步（源平台签发）；0 = 私聊（一步完成）；-1 = 群聊第二步（目标平台签发）
+	type TokenData = [platform: string, id: string, phase: number];
+	const tokens: Dict<TokenData> = Object.create(null);
+
+	const { tokenPrefix: prefix = "koishi/" } = config;
+	const { generateToken = () => `${prefix}${randomDigits(6)}` } = config;
+
+	/** 为当前会话用户签发一次性令牌并记录 phase，5 分钟后自动过期 */
+	function generate(session: Session, phase: number) {
+		const { userId } = session;
+		if (!userId) return;
+		const token = generateToken();
+		tokens[token] = [session.platform, userId, phase];
+		ctx.setTimeout(() => delete tokens[token], 5 * Time.minute);
+		return token;
+	}
+
+	/** 将平台账号（platform + pid）绑定到指定用户（aid）名下 */
+	async function bind(aid: number, platform: string, pid: string) {
+		await ctx.database.set("binding", { platform, pid }, { aid });
+	}
+
+	ctx
+		.command("bind", { authority: 0 })
+		.userFields(["id"])
+		.option("remove", "-r")
+		.action(async ({ session, options }) => {
+			if (!session || !options) return;
+			if (options.remove) {
+				const { platform, userId: pid, user } = session;
+				if (!pid || !user) return;
+				const bindings = await ctx.database.get("binding", {
+					aid: user.id,
+				});
+				const binding = bindings.find(
+					(item) => item.platform === platform && item.pid === pid,
+				);
+				if (!binding) return;
+				if (binding.aid !== binding.bid) {
+					// 该账号是从别的用户迁移绑定而来：恢复其原初绑定即可
+					await bind(binding.bid, platform, pid);
+					return session.text(".remove-success");
+				} else if (
+					bindings.filter((item) => item.aid === item.bid).length === 1
+				) {
+					// 原初绑定只剩最后一个时不允许解绑，否则用户将失去入口
+					return session.text(".remove-original");
+				} else {
+					// 另建一个新用户（按 autoAuthorize 赋初始权限），把当前平台账号归入其名下
+					const authority = await session.resolve(
+						ctx.root.config.autoAuthorize,
+					);
+					const user = await ctx.database.create("user", { authority });
+					await bind(user.id, platform, pid);
+					return session.text(".remove-success");
+				}
+			}
+
+			// 群聊进入两步流程（phase 1），私聊一步完成（phase 0）
+			const token = generate(session, +!session.isDirect);
+			return session.text(".generated-1", [token]);
+		});
+
+	// 前置中间件：拦截形如令牌的消息，驱动绑定流程
+	ctx.middleware(async (session, next) => {
+		const token = session.stripped.content;
+		const data = tokens[token];
+		if (!data) return next();
+		const { userId } = session;
+		if (!userId) return next();
+		// 令牌在同一账号上被重复使用：提示不要在同一平台输入
+		if (data[0] === session.platform && data[1] === session.userId) {
+			return session.text(
+				`commands.bind.messages.self-${data[2] < 0 ? "2" : "1"}`,
+			);
+		}
+		delete tokens[token];
+		if (data[2] < 0) {
+			// 第二步令牌：把当前用户并入令牌签发者所属的用户
+			const [binding] = await ctx.database.get(
+				"binding",
+				{ platform: data[0], pid: data[1] },
+				["aid"],
+			);
+			if (!binding) return;
+			await bind(binding.aid, session.platform, userId);
+			return session.text("commands.bind.messages.success");
+		} else {
+			// 第一步令牌 / 私聊令牌：以当前用户为主体，把令牌签发账号并入自己
+			const user = await ctx.database.getUser(session.platform, userId, [
+				"id",
+				"authority",
+			]);
+			// 未注册（无 authority）的账号无权拉人绑定
+			if (!user.authority) return session.text("internal.low-authority");
+			if (data[2]) {
+				// 群聊第一步：签发第二枚令牌，请对方回原平台输入
+				const token = generate(session, -1);
+				return session.text("commands.bind.messages.generated-2", [token]);
+			} else {
+				// 私聊一步：直接把令牌签发账号并入当前用户
+				await bind(user.id, data[0], data[1]);
+				return session.text("commands.bind.messages.success");
+			}
+		}
+	}, true);
+}