@tencent-connect/openclaw-qqbot 1.0.0-alpha.0

package/dist/src/channel.js

@@ -0,0 +1,337 @@
+import { applyAccountNameToChannelSection, deleteAccountFromConfigSection, setAccountEnabledInConfigSection, } from "openclaw/plugin-sdk";
+import { DEFAULT_ACCOUNT_ID, listQQBotAccountIds, resolveQQBotAccount, applyQQBotAccountConfig, resolveDefaultQQBotAccountId } from "./config.js";
+import { sendText, sendMedia } from "./outbound.js";
+import { startGateway } from "./gateway.js";
+import { qqbotOnboardingAdapter } from "./onboarding.js";
+import { getQQBotRuntime } from "./runtime.js";
+/**
+ * 简单的文本分块函数
+ * 用于预先分块长文本
+ */
+function chunkText(text, limit) {
+    if (text.length <= limit)
+        return [text];
+    const chunks = [];
+    let remaining = text;
+    while (remaining.length > 0) {
+        if (remaining.length <= limit) {
+            chunks.push(remaining);
+            break;
+        }
+        // 尝试在换行处分割
+        let splitAt = remaining.lastIndexOf("\n", limit);
+        if (splitAt <= 0 || splitAt < limit * 0.5) {
+            // 没找到合适的换行，尝试在空格处分割
+            splitAt = remaining.lastIndexOf(" ", limit);
+        }
+        if (splitAt <= 0 || splitAt < limit * 0.5) {
+            // 还是没找到，强制在 limit 处分割
+            splitAt = limit;
+        }
+        chunks.push(remaining.slice(0, splitAt));
+        remaining = remaining.slice(splitAt).trimStart();
+    }
+    return chunks;
+}
+export const qqbotPlugin = {
+    id: "qqbot",
+    meta: {
+        id: "qqbot",
+        label: "QQ Bot",
+        selectionLabel: "QQ Bot",
+        docsPath: "/docs/channels/qqbot",
+        blurb: "Connect to QQ via official QQ Bot API",
+        order: 50,
+    },
+    capabilities: {
+        chatTypes: ["direct", "group"],
+        media: true,
+        reactions: false,
+        threads: false,
+        /**
+         * blockStreaming: true 表示该 Channel 支持块流式
+         * 框架会收集流式响应，然后通过 deliver 回调发送
+         */
+        blockStreaming: false,
+    },
+    reload: { configPrefixes: ["channels.qqbot"] },
+    // CLI onboarding wizard
+    onboarding: qqbotOnboardingAdapter,
+    config: {
+        listAccountIds: (cfg) => listQQBotAccountIds(cfg),
+        resolveAccount: (cfg, accountId) => resolveQQBotAccount(cfg, accountId),
+        defaultAccountId: (cfg) => resolveDefaultQQBotAccountId(cfg),
+        // 新增：设置账户启用状态
+        setAccountEnabled: ({ cfg, accountId, enabled }) => setAccountEnabledInConfigSection({
+            cfg,
+            sectionKey: "qqbot",
+            accountId,
+            enabled,
+            allowTopLevel: true,
+        }),
+        // 新增：删除账户
+        deleteAccount: ({ cfg, accountId }) => deleteAccountFromConfigSection({
+            cfg,
+            sectionKey: "qqbot",
+            accountId,
+            clearBaseFields: ["appId", "clientSecret", "clientSecretFile", "name"],
+        }),
+        isConfigured: (account) => Boolean(account?.appId && account?.clientSecret),
+        describeAccount: (account) => ({
+            accountId: account?.accountId ?? DEFAULT_ACCOUNT_ID,
+            name: account?.name,
+            enabled: account?.enabled ?? false,
+            configured: Boolean(account?.appId && account?.clientSecret),
+            tokenSource: account?.secretSource,
+        }),
+        // 关键：解析 allowFrom 配置，用于命令授权
+        resolveAllowFrom: ({ cfg, accountId }) => {
+            const account = resolveQQBotAccount(cfg, accountId);
+            const allowFrom = account.config?.allowFrom ?? [];
+            console.log(`[qqbot] resolveAllowFrom: accountId=${accountId}, allowFrom=${JSON.stringify(allowFrom)}`);
+            return allowFrom.map((entry) => String(entry));
+        },
+        // 格式化 allowFrom 条目（移除 qqbot: 前缀，统一大写）
+        formatAllowFrom: ({ allowFrom }) => allowFrom
+            .map((entry) => String(entry).trim())
+            .filter(Boolean)
+            .map((entry) => entry.replace(/^qqbot:/i, ""))
+            .map((entry) => entry.toUpperCase()), // QQ openid 是大写的
+    },
+    setup: {
+        // 新增：规范化账户 ID
+        resolveAccountId: ({ accountId }) => accountId?.trim().toLowerCase() || DEFAULT_ACCOUNT_ID,
+        // 新增：应用账户名称
+        applyAccountName: ({ cfg, accountId, name }) => applyAccountNameToChannelSection({
+            cfg,
+            channelKey: "qqbot",
+            accountId,
+            name,
+        }),
+        validateInput: ({ input }) => {
+            if (!input.token && !input.tokenFile && !input.useEnv) {
+                return "QQBot requires --token (format: appId:clientSecret) or --use-env";
+            }
+            return null;
+        },
+        applyAccountConfig: ({ cfg, accountId, input }) => {
+            let appId = "";
+            let clientSecret = "";
+            if (input.token) {
+                const parts = input.token.split(":");
+                if (parts.length === 2) {
+                    appId = parts[0];
+                    clientSecret = parts[1];
+                }
+            }
+            return applyQQBotAccountConfig(cfg, accountId, {
+                appId,
+                clientSecret,
+                clientSecretFile: input.tokenFile,
+                name: input.name,
+                imageServerBaseUrl: input.imageServerBaseUrl,
+            });
+        },
+    },
+    // Messaging 配置：用于解析目标地址
+    messaging: {
+        /**
+         * 规范化目标地址
+         * 支持以下格式：
+         * - qqbot:c2c:openid -> 私聊
+         * - qqbot:group:groupid -> 群聊
+         * - qqbot:channel:channelid -> 频道
+         * - c2c:openid -> 私聊
+         * - group:groupid -> 群聊
+         * - channel:channelid -> 频道
+         * - 纯 openid（32位十六进制）-> 私聊
+         */
+        normalizeTarget: (target) => {
+            // 去掉 qqbot: 前缀（如果有）
+            const id = target.replace(/^qqbot:/i, "");
+            // 检查是否是已知格式
+            if (id.startsWith("c2c:") || id.startsWith("group:") || id.startsWith("channel:")) {
+                return { ok: true, to: `qqbot:${id}` };
+            }
+            // 检查是否是纯 openid（32位十六进制，不带连字符）
+            // QQ Bot OpenID 格式类似: 207A5B8339D01F6582911C014668B77B
+            const openIdHexPattern = /^[0-9a-fA-F]{32}$/;
+            if (openIdHexPattern.test(id)) {
+                return { ok: true, to: `qqbot:c2c:${id}` };
+            }
+            // 检查是否是 UUID 格式的 openid（带连字符）
+            const openIdUuidPattern = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
+            if (openIdUuidPattern.test(id)) {
+                return { ok: true, to: `qqbot:c2c:${id}` };
+            }
+            // 不认识的格式
+            return { ok: false, error: `unrecognized target format: ${target}` };
+        },
+        /**
+         * 目标解析器配置
+         * 用于判断一个目标 ID 是否看起来像 QQ Bot 的格式
+         */
+        targetResolver: {
+            /**
+             * 判断目标 ID 是否可能是 QQ Bot 格式
+             * 支持以下格式：
+             * - qqbot:c2c:xxx
+             * - qqbot:group:xxx
+             * - qqbot:channel:xxx
+             * - c2c:xxx
+             * - group:xxx
+             * - channel:xxx
+             * - UUID 格式的 openid
+             */
+            looksLikeId: (id) => {
+                // 带 qqbot: 前缀的格式
+                if (/^qqbot:(c2c|group|channel):/i.test(id)) {
+                    return true;
+                }
+                // 不带前缀但有类型标识
+                if (/^(c2c|group|channel):/i.test(id)) {
+                    return true;
+                }
+                // 32位十六进制 openid（不带连字符）
+                if (/^[0-9a-fA-F]{32}$/.test(id)) {
+                    return true;
+                }
+                // UUID 格式的 openid（带连字符）
+                const openIdPattern = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
+                return openIdPattern.test(id);
+            },
+            hint: "QQ Bot 目标格式: qqbot:c2c:openid (私聊) 或 qqbot:group:groupid (群聊)",
+        },
+    },
+    outbound: {
+        deliveryMode: "direct",
+        chunker: chunkText,
+        chunkerMode: "markdown",
+        textChunkLimit: 2000,
+        sendText: async ({ to, text, accountId, replyToId, cfg }) => {
+            console.log(`[qqbot:channel] sendText called — accountId=${accountId}, to=${to}, replyToId=${replyToId}, text.length=${text?.length ?? 0}`);
+            console.log(`[qqbot:channel] sendText text preview: ${text?.slice(0, 100)}${(text?.length ?? 0) > 100 ? "..." : ""}`);
+            const account = resolveQQBotAccount(cfg, accountId);
+            console.log(`[qqbot:channel] sendText resolved account: id=${account.accountId}, appId=${account.appId}, enabled=${account.enabled}`);
+            const result = await sendText({ to, text, accountId, replyToId, account });
+            console.log(`[qqbot:channel] sendText result: messageId=${result.messageId}, error=${result.error ?? "none"}`);
+            return {
+                channel: "qqbot",
+                messageId: result.messageId,
+                error: result.error ? new Error(result.error) : undefined,
+            };
+        },
+        sendMedia: async ({ to, text, mediaUrl, accountId, replyToId, cfg }) => {
+            console.log(`[qqbot:channel] sendMedia called — accountId=${accountId}, to=${to}, replyToId=${replyToId}, mediaUrl=${mediaUrl?.slice(0, 80)}, text.length=${text?.length ?? 0}`);
+            const account = resolveQQBotAccount(cfg, accountId);
+            console.log(`[qqbot:channel] sendMedia resolved account: id=${account.accountId}, appId=${account.appId}, enabled=${account.enabled}`);
+            const result = await sendMedia({ to, text: text ?? "", mediaUrl: mediaUrl ?? "", accountId, replyToId, account });
+            console.log(`[qqbot:channel] sendMedia result: messageId=${result.messageId}, error=${result.error ?? "none"}`);
+            return {
+                channel: "qqbot",
+                messageId: result.messageId,
+                error: result.error ? new Error(result.error) : undefined,
+            };
+        },
+    },
+    gateway: {
+        startAccount: async (ctx) => {
+            const { account, abortSignal, log, cfg } = ctx;
+            log?.info(`[qqbot:${account.accountId}] Starting gateway — appId=${account.appId}, enabled=${account.enabled}, name=${account.name ?? "unnamed"}`);
+            console.log(`[qqbot:channel] startAccount: accountId=${account.accountId}, appId=${account.appId}, secretSource=${account.secretSource}`);
+            await startGateway({
+                account,
+                abortSignal,
+                cfg,
+                log,
+                onReady: () => {
+                    log?.info(`[qqbot:${account.accountId}] Gateway ready`);
+                    ctx.setStatus({
+                        ...ctx.getStatus(),
+                        running: true,
+                        connected: true,
+                        lastConnectedAt: Date.now(),
+                    });
+                },
+                onError: (error) => {
+                    log?.error(`[qqbot:${account.accountId}] Gateway error: ${error.message}`);
+                    ctx.setStatus({
+                        ...ctx.getStatus(),
+                        lastError: error.message,
+                    });
+                },
+            });
+        },
+        // 新增：登出账户（清除配置中的凭证）
+        logoutAccount: async ({ accountId, cfg }) => {
+            const nextCfg = { ...cfg };
+            const nextQQBot = cfg.channels?.qqbot ? { ...cfg.channels.qqbot } : undefined;
+            let cleared = false;
+            let changed = false;
+            if (nextQQBot) {
+                const qqbot = nextQQBot;
+                if (accountId === DEFAULT_ACCOUNT_ID && qqbot.clientSecret) {
+                    delete qqbot.clientSecret;
+                    cleared = true;
+                    changed = true;
+                }
+                const accounts = qqbot.accounts;
+                if (accounts && accountId in accounts) {
+                    const entry = accounts[accountId];
+                    if (entry && "clientSecret" in entry) {
+                        delete entry.clientSecret;
+                        cleared = true;
+                        changed = true;
+                    }
+                    if (entry && Object.keys(entry).length === 0) {
+                        delete accounts[accountId];
+                        changed = true;
+                    }
+                }
+            }
+            if (changed && nextQQBot) {
+                nextCfg.channels = { ...nextCfg.channels, qqbot: nextQQBot };
+                const runtime = getQQBotRuntime();
+                const configApi = runtime.config;
+                await configApi.writeConfigFile(nextCfg);
+            }
+            const resolved = resolveQQBotAccount(changed ? nextCfg : cfg, accountId);
+            const loggedOut = resolved.secretSource === "none";
+            const envToken = Boolean(process.env.QQBOT_CLIENT_SECRET);
+            return { ok: true, cleared, envToken, loggedOut };
+        },
+    },
+    status: {
+        defaultRuntime: {
+            accountId: DEFAULT_ACCOUNT_ID,
+            running: false,
+            connected: false,
+            lastConnectedAt: null,
+            lastError: null,
+            lastInboundAt: null,
+            lastOutboundAt: null,
+        },
+        // 新增：构建通道摘要
+        buildChannelSummary: ({ snapshot }) => ({
+            configured: snapshot.configured ?? false,
+            tokenSource: snapshot.tokenSource ?? "none",
+            running: snapshot.running ?? false,
+            connected: snapshot.connected ?? false,
+            lastConnectedAt: snapshot.lastConnectedAt ?? null,
+            lastError: snapshot.lastError ?? null,
+        }),
+        buildAccountSnapshot: ({ account, runtime }) => ({
+            accountId: account?.accountId ?? DEFAULT_ACCOUNT_ID,
+            name: account?.name,
+            enabled: account?.enabled ?? false,
+            configured: Boolean(account?.appId && account?.clientSecret),
+            tokenSource: account?.secretSource,
+            running: runtime?.running ?? false,
+            connected: runtime?.connected ?? false,
+            lastConnectedAt: runtime?.lastConnectedAt ?? null,
+            lastError: runtime?.lastError ?? null,
+            lastInboundAt: runtime?.lastInboundAt ?? null,
+            lastOutboundAt: runtime?.lastOutboundAt ?? null,
+        }),
+    },
+};

package/dist/src/config.d.ts

@@ -0,0 +1,25 @@
+import type { ResolvedQQBotAccount } from "./types.js";
+import type { OpenClawConfig } from "openclaw/plugin-sdk";
+export declare const DEFAULT_ACCOUNT_ID = "default";
+/**
+ * 列出所有 QQBot 账户 ID
+ */
+export declare function listQQBotAccountIds(cfg: OpenClawConfig): string[];
+/**
+ * 获取默认账户 ID
+ */
+export declare function resolveDefaultQQBotAccountId(cfg: OpenClawConfig): string;
+/**
+ * 解析 QQBot 账户配置
+ */
+export declare function resolveQQBotAccount(cfg: OpenClawConfig, accountId?: string | null): ResolvedQQBotAccount;
+/**
+ * 应用账户配置
+ */
+export declare function applyQQBotAccountConfig(cfg: OpenClawConfig, accountId: string, input: {
+    appId?: string;
+    clientSecret?: string;
+    clientSecretFile?: string;
+    name?: string;
+    imageServerBaseUrl?: string;
+}): OpenClawConfig;

package/dist/src/config.js

@@ -0,0 +1,156 @@
+export const DEFAULT_ACCOUNT_ID = "default";
+/**
+ * 列出所有 QQBot 账户 ID
+ */
+export function listQQBotAccountIds(cfg) {
+    const ids = new Set();
+    const qqbot = cfg.channels?.qqbot;
+    if (qqbot?.appId) {
+        ids.add(DEFAULT_ACCOUNT_ID);
+    }
+    if (qqbot?.accounts) {
+        for (const accountId of Object.keys(qqbot.accounts)) {
+            if (qqbot.accounts[accountId]?.appId) {
+                ids.add(accountId);
+            }
+        }
+    }
+    return Array.from(ids);
+}
+/**
+ * 获取默认账户 ID
+ */
+export function resolveDefaultQQBotAccountId(cfg) {
+    const qqbot = cfg.channels?.qqbot;
+    // 如果有默认账户配置，返回 default
+    if (qqbot?.appId) {
+        return DEFAULT_ACCOUNT_ID;
+    }
+    // 否则返回第一个配置的账户
+    if (qqbot?.accounts) {
+        const ids = Object.keys(qqbot.accounts);
+        if (ids.length > 0) {
+            return ids[0];
+        }
+    }
+    return DEFAULT_ACCOUNT_ID;
+}
+/**
+ * 解析 QQBot 账户配置
+ */
+export function resolveQQBotAccount(cfg, accountId) {
+    const resolvedAccountId = accountId ?? DEFAULT_ACCOUNT_ID;
+    const qqbot = cfg.channels?.qqbot;
+    // 基础配置
+    let accountConfig = {};
+    let appId = "";
+    let clientSecret = "";
+    let secretSource = "none";
+    if (resolvedAccountId === DEFAULT_ACCOUNT_ID) {
+        // 默认账户从顶层读取
+        accountConfig = {
+            enabled: qqbot?.enabled,
+            name: qqbot?.name,
+            appId: qqbot?.appId,
+            clientSecret: qqbot?.clientSecret,
+            clientSecretFile: qqbot?.clientSecretFile,
+            dmPolicy: qqbot?.dmPolicy,
+            allowFrom: qqbot?.allowFrom,
+            systemPrompt: qqbot?.systemPrompt,
+            imageServerBaseUrl: qqbot?.imageServerBaseUrl,
+            markdownSupport: qqbot?.markdownSupport ?? true,
+        };
+        appId = qqbot?.appId ?? "";
+    }
+    else {
+        // 命名账户从 accounts 读取
+        const account = qqbot?.accounts?.[resolvedAccountId];
+        accountConfig = account ?? {};
+        appId = account?.appId ?? "";
+    }
+    // 解析 clientSecret
+    if (accountConfig.clientSecret) {
+        clientSecret = accountConfig.clientSecret;
+        secretSource = "config";
+    }
+    else if (accountConfig.clientSecretFile) {
+        // 从文件读取（运行时处理）
+        secretSource = "file";
+    }
+    else if (process.env.QQBOT_CLIENT_SECRET && resolvedAccountId === DEFAULT_ACCOUNT_ID) {
+        clientSecret = process.env.QQBOT_CLIENT_SECRET;
+        secretSource = "env";
+    }
+    // AppId 也可以从环境变量读取
+    if (!appId && process.env.QQBOT_APP_ID && resolvedAccountId === DEFAULT_ACCOUNT_ID) {
+        appId = process.env.QQBOT_APP_ID;
+    }
+    return {
+        accountId: resolvedAccountId,
+        name: accountConfig.name,
+        enabled: accountConfig.enabled !== false,
+        appId,
+        clientSecret,
+        secretSource,
+        systemPrompt: accountConfig.systemPrompt,
+        imageServerBaseUrl: accountConfig.imageServerBaseUrl || process.env.QQBOT_IMAGE_SERVER_BASE_URL,
+        markdownSupport: accountConfig.markdownSupport !== false,
+        config: accountConfig,
+    };
+}
+/**
+ * 应用账户配置
+ */
+export function applyQQBotAccountConfig(cfg, accountId, input) {
+    const next = { ...cfg };
+    if (accountId === DEFAULT_ACCOUNT_ID) {
+        // 如果没有设置过 allowFrom，默认设置为 ["*"]
+        const existingConfig = next.channels?.qqbot || {};
+        const allowFrom = existingConfig.allowFrom ?? ["*"];
+        next.channels = {
+            ...next.channels,
+            qqbot: {
+                ...(next.channels?.qqbot || {}),
+                enabled: true,
+                allowFrom,
+                ...(input.appId ? { appId: input.appId } : {}),
+                ...(input.clientSecret
+                    ? { clientSecret: input.clientSecret }
+                    : input.clientSecretFile
+                        ? { clientSecretFile: input.clientSecretFile }
+                        : {}),
+                ...(input.name ? { name: input.name } : {}),
+                ...(input.imageServerBaseUrl ? { imageServerBaseUrl: input.imageServerBaseUrl } : {}),
+            },
+        };
+    }
+    else {
+        // 如果没有设置过 allowFrom，默认设置为 ["*"]
+        const existingAccountConfig = next.channels?.qqbot?.accounts?.[accountId] || {};
+        const allowFrom = existingAccountConfig.allowFrom ?? ["*"];
+        next.channels = {
+            ...next.channels,
+            qqbot: {
+                ...(next.channels?.qqbot || {}),
+                enabled: true,
+                accounts: {
+                    ...(next.channels?.qqbot?.accounts || {}),
+                    [accountId]: {
+                        ...(next.channels?.qqbot?.accounts?.[accountId] || {}),
+                        enabled: true,
+                        allowFrom,
+                        ...(input.appId ? { appId: input.appId } : {}),
+                        ...(input.clientSecret
+                            ? { clientSecret: input.clientSecret }
+                            : input.clientSecretFile
+                                ? { clientSecretFile: input.clientSecretFile }
+                                : {}),
+                        ...(input.name ? { name: input.name } : {}),
+                        ...(input.imageServerBaseUrl ? { imageServerBaseUrl: input.imageServerBaseUrl } : {}),
+                    },
+                },
+            },
+        };
+    }
+    return next;
+}

package/dist/src/gateway.d.ts

@@ -0,0 +1,18 @@
+import type { ResolvedQQBotAccount } from "./types.js";
+export interface GatewayContext {
+    account: ResolvedQQBotAccount;
+    abortSignal: AbortSignal;
+    cfg: unknown;
+    onReady?: (data: unknown) => void;
+    onError?: (error: Error) => void;
+    log?: {
+        info: (msg: string) => void;
+        error: (msg: string) => void;
+        debug?: (msg: string) => void;
+    };
+}
+/**
+ * 启动 Gateway WebSocket 连接（带自动重连）
+ * 支持流式消息发送
+ */
+export declare function startGateway(ctx: GatewayContext): Promise<void>;