@searchfe/openclaw-baiduapp 0.1.0-beta.1

package/README.md

@@ -0,0 +1,212 @@
+# OpenClaw 接入百度App 配置指南
+
+本指南帮助你配置百度App渠道，并接入 OpenClaw。
+
+> **⚠️ 重要提示**：Baidu App 插件专注于**文本私聊场景**，不支持群聊和媒体消息（图片/语音/文件）。
+
+## 功能概览
+
+| 功能           | 状态 |
+| :------------- | :--: |
+| 文本消息       |  ✅  |
+| 主动发送消息   |  ✅  |
+| 私聊           |  ✅  |
+| 群聊           |  ❌  |
+| 图片/语音/文件 |  ❌  |
+| Webhook 回调   |  ✅  |
+| 多账户         |  ✅  |
+| 访问控制策略   |  ✅  |
+
+## 前置条件
+
+1. 百度App 开发者账号
+2. 公网可访问的 HTTPS 服务器（用于接收回调）
+3. OpenClaw 已安装并运行
+
+---
+
+## 步骤一：安装插件
+
+### 方式一：从 npm 安装
+
+```bash
+openclaw plugins install @searchfe/openclaw-baiduapp
+```
+
+---
+
+## 步骤二：获取百度平台凭证
+
+<!-- TODO: 补充百度平台注册具体步骤和截图 -->
+
+在百度App 开发者平台注册应用后，获取以下信息：
+
+- **App Key**：应用标识
+- **App Secret**：应用密钥
+- **Token**：消息校验 Token
+- **EncodingAESKey**：消息加密密钥（43 位字符）
+
+---
+
+## 步骤三：配置 OpenClaw
+
+### 使用命令行配置
+
+```bash
+openclaw config set channels.baidu-app.enabled true
+openclaw config set channels.baidu-app.webhookPath /baidu-app
+openclaw config set channels.baidu-app.token your-token
+openclaw config set channels.baidu-app.encodingAESKey your-43-char-encoding-aes-key
+openclaw config set channels.baidu-app.appKey your-app-key
+openclaw config set channels.baidu-app.appSecret your-app-secret
+```
+
+### 或直接编辑配置文件
+
+编辑 `~/.openclaw/openclaw.json`：
+
+```json
+{
+    "channels": {
+        "baidu-app": {
+            "enabled": true,
+            "webhookPath": "/baidu-app",
+            "token": "your-token",
+            "encodingAESKey": "your-43-char-encoding-aes-key",
+            "appKey": "your-app-key",
+            "appSecret": "your-app-secret"
+        }
+    }
+}
+```
+
+### 配置说明
+
+| 字段             | 必填 | 说明                            |
+| :--------------- | :--: | :------------------------------ |
+| `enabled`        |  ✅  | 是否启用该渠道                  |
+| `webhookPath`    |  ✅  | 回调路径，需与百度平台配置一致  |
+| `token`          |  ✅  | 消息校验 Token                  |
+| `encodingAESKey` |  ✅  | 消息加密密钥（43 位）           |
+| `appKey`         |  ✅  | 应用 App Key（主动发送必需）    |
+| `appSecret`      |  ✅  | 应用 App Secret（主动发送必需） |
+| `welcomeText`    |  ❌  | 用户首次进入时的欢迎语          |
+| `dmPolicy`       |  ❌  | 私聊策略（默认 `pairing`）      |
+| `allowFrom`      |  ❌  | 私聊白名单用户 ID 列表          |
+
+### 环境变量支持
+
+默认账户的凭证也可以通过环境变量设置：
+
+| 环境变量                     | 对应配置         |
+| :--------------------------- | :--------------- |
+| `BAIDU_APP_TOKEN`            | `token`          |
+| `BAIDU_APP_ENCODING_AES_KEY` | `encodingAESKey` |
+| `BAIDU_APP_KEY`              | `appKey`         |
+| `BAIDU_APP_SECRET`           | `appSecret`      |
+
+---
+
+## 步骤四：重启 Gateway
+
+```bash
+openclaw gateway restart
+```
+
+---
+
+## 步骤五：验证配置
+
+1. 在百度平台配置 Webhook 回调地址，指向你的 OpenClaw Gateway
+2. 平台验证通过后，发送一条测试消息
+3. 查看 OpenClaw 日志确认消息接收和回复
+
+---
+
+## 高级配置
+
+### 访问控制
+
+```json
+{
+    "channels": {
+        "baidu-app": {
+            "enabled": true,
+            "dmPolicy": "open",
+            "allowFrom": []
+        }
+    }
+}
+```
+
+| 字段        | 说明                                                                                     |
+| :---------- | :--------------------------------------------------------------------------------------- |
+| `dmPolicy`  | 私聊策略：`open`（任何人）/ `pairing`（配对）/ `allowlist`（白名单）/ `disabled`（禁用） |
+| `allowFrom` | 私聊白名单用户 ID 列表（当 `dmPolicy` 为 `allowlist` 时生效）                            |
+
+### 多账户配置
+
+```json
+{
+    "channels": {
+        "baidu-app": {
+            "enabled": true,
+            "accounts": {
+                "bot1": {
+                    "webhookPath": "/baidu-app-1",
+                    "token": "token-1",
+                    "encodingAESKey": "key-1",
+                    "appKey": "app-key-1",
+                    "appSecret": "secret-1"
+                },
+                "bot2": {
+                    "webhookPath": "/baidu-app-2",
+                    "token": "token-2",
+                    "encodingAESKey": "key-2",
+                    "appKey": "app-key-2",
+                    "appSecret": "secret-2"
+                }
+            }
+        }
+    }
+}
+```
+
+> 提示：多账号共用同一路径/Token 时，系统会使用第一个匹配的账号。建议每个账号使用独立的 `webhookPath`。
+
+---
+
+## 常见问题
+
+### Q: 保存配置时提示验证失败？
+
+1. 检查 OpenClaw 是否已启动并监听正确端口
+2. 确认 `webhookPath` 与平台 URL 路径一致
+3. 确认 `token` 和 `encodingAESKey` 与平台配置完全一致
+4. 确认服务器公网可访问
+
+### Q: 消息接收成功但发送失败？
+
+1. 检查 `appKey`、`appSecret` 是否正确
+2. 查看 OpenClaw 日志获取详细错误信息
+
+### Q: 如何使用 target 发送消息？
+
+```bash
+# 使用 user: 前缀
+send user:userId123 你好
+
+# 使用 baidu-app: 完整前缀
+send baidu-app:user:userId123 你好
+
+# 指定账户
+send user:userId123@bot1 你好
+```
+
+---
+
+## 开发验证
+
+```bash
+pnpm test
+```

package/dist/index.d.ts

@@ -0,0 +1,434 @@
+import { IncomingMessage, ServerResponse } from 'http';
+
+type BaiduAppDmPolicy = 'open' | 'pairing' | 'allowlist' | 'disabled';
+interface BaiduAppAccountConfig {
+    name?: string;
+    enabled?: boolean;
+    webhookPath?: string;
+    token?: string;
+    encodingAESKey?: string;
+    receiveId?: string;
+    appKey?: string;
+    appSecret?: string;
+    welcomeText?: string;
+    dmPolicy?: BaiduAppDmPolicy;
+    allowFrom?: string[];
+}
+type BaiduAppConfig = BaiduAppAccountConfig & {
+    accounts?: Record<string, BaiduAppAccountConfig>;
+    defaultAccount?: string;
+};
+interface ResolvedBaiduAppAccount {
+    accountId: string;
+    name?: string;
+    enabled: boolean;
+    configured: boolean;
+    token?: string;
+    encodingAESKey?: string;
+    receiveId: string;
+    appKey?: string;
+    appSecret?: string;
+    canSendActive: boolean;
+    config: BaiduAppAccountConfig;
+}
+interface BaiduAppSendTarget {
+    userId: string;
+}
+interface AccessTokenCacheEntry {
+    token: string;
+    expiresAt: number;
+}
+interface BaiduAppInboundBase {
+    MsgId?: string;
+    msgid?: string;
+    aibotid?: string;
+    response_url?: string;
+    from?: {
+        userid?: string;
+        appkey?: string;
+    };
+    FromUserName?: string;
+    ToUserName?: string;
+    CreateTime?: number;
+    MsgType?: string;
+    msgtype?: string;
+    BotID?: number;
+}
+type BaiduAppInboundText = BaiduAppInboundBase & {
+    msgtype: 'text';
+    MsgType?: 'text';
+    text?: {
+        content?: string;
+    };
+    Content?: string;
+    quote?: unknown;
+};
+type BaiduAppInboundEvent = BaiduAppInboundBase & {
+    msgtype: 'event';
+    MsgType?: 'event';
+    create_time?: number;
+    Event?: string;
+    EventKey?: string;
+    event?: {
+        eventtype?: string;
+        [key: string]: unknown;
+    };
+};
+type BaiduAppInboundMessage = BaiduAppInboundText | BaiduAppInboundEvent | (BaiduAppInboundBase & Record<string, unknown>);
+
+declare const DEFAULT_ACCOUNT_ID = "default";
+interface PluginConfig {
+    session?: {
+        store?: unknown;
+    };
+    channels?: {
+        'baidu-app'?: BaiduAppConfig;
+    };
+}
+
+declare const baiduAppPlugin: {
+    id: string;
+    meta: {
+        id: "baidu-app";
+        label: "Baidu App";
+        selectionLabel: "Baidu Search AI (百度搜索对话式AI)";
+        docsPath: "/channels/baidu-app";
+        docsLabel: "baidu-app";
+        blurb: "百度搜索对话式AI，支持主动发送消息";
+        aliases: readonly ["baidu-ai", "百度搜索AI"];
+        order: 85;
+    };
+    capabilities: {
+        chatTypes: readonly ["direct"];
+        media: boolean;
+        reactions: boolean;
+        threads: boolean;
+        edit: boolean;
+        reply: boolean;
+        polls: boolean;
+        activeSend: boolean;
+    };
+    configSchema: {
+        schema: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                name: {
+                    type: string;
+                };
+                enabled: {
+                    type: string;
+                };
+                webhookPath: {
+                    type: string;
+                };
+                token: {
+                    type: string;
+                };
+                encodingAESKey: {
+                    type: string;
+                };
+                receiveId: {
+                    type: string;
+                };
+                appKey: {
+                    type: string;
+                };
+                appSecret: {
+                    type: string;
+                };
+                welcomeText: {
+                    type: string;
+                };
+                dmPolicy: {
+                    type: string;
+                    enum: string[];
+                };
+                allowFrom: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                defaultAccount: {
+                    type: string;
+                };
+                accounts: {
+                    type: string;
+                    additionalProperties: {
+                        type: string;
+                        additionalProperties: boolean;
+                        properties: {
+                            name: {
+                                type: string;
+                            };
+                            enabled: {
+                                type: string;
+                            };
+                            webhookPath: {
+                                type: string;
+                            };
+                            token: {
+                                type: string;
+                            };
+                            encodingAESKey: {
+                                type: string;
+                            };
+                            receiveId: {
+                                type: string;
+                            };
+                            appKey: {
+                                type: string;
+                            };
+                            appSecret: {
+                                type: string;
+                            };
+                            welcomeText: {
+                                type: string;
+                            };
+                            dmPolicy: {
+                                type: string;
+                                enum: string[];
+                            };
+                            allowFrom: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    reload: {
+        configPrefixes: string[];
+    };
+    config: {
+        listAccountIds: (cfg: PluginConfig) => string[];
+        resolveAccount: (cfg: PluginConfig, accountId?: string) => ResolvedBaiduAppAccount;
+        defaultAccountId: (cfg: PluginConfig) => string;
+        setAccountEnabled: (params: {
+            cfg: PluginConfig;
+            accountId?: string;
+            enabled: boolean;
+        }) => PluginConfig;
+        deleteAccount: (params: {
+            cfg: PluginConfig;
+            accountId?: string;
+        }) => PluginConfig;
+        isConfigured: (account: ResolvedBaiduAppAccount) => boolean;
+        describeAccount: (account: ResolvedBaiduAppAccount) => {
+            accountId: string;
+            name: string | undefined;
+            enabled: boolean;
+            configured: boolean;
+            canSendActive: boolean;
+            webhookPath: string;
+        };
+        resolveAllowFrom: (params: {
+            cfg: PluginConfig;
+            accountId?: string;
+        }) => string[];
+        formatAllowFrom: (params: {
+            allowFrom: Array<string | number>;
+        }) => string[];
+    };
+    directory: {
+        canResolve: (params: {
+            target: string;
+        }) => boolean;
+        resolveTarget: (params: {
+            cfg: PluginConfig;
+            target: string;
+        }) => {
+            channel: string;
+            accountId?: string;
+            to: string;
+        } | null;
+        resolveTargets: (params: {
+            cfg: PluginConfig;
+            targets: string[];
+        }) => Array<{
+            channel: string;
+            accountId?: string;
+            to: string;
+        }>;
+        getTargetFormats: () => string[];
+    };
+    outbound: {
+        deliveryMode: string;
+        sendText: (params: {
+            cfg: PluginConfig;
+            accountId?: string;
+            to: string;
+            text: string;
+            options?: {
+                markdown?: boolean;
+            };
+        }) => Promise<{
+            channel: string;
+            ok: boolean;
+            messageId: string;
+            error?: Error;
+        }>;
+    };
+    gateway: {
+        startAccount: (ctx: {
+            cfg: PluginConfig;
+            runtime?: unknown;
+            abortSignal?: AbortSignal;
+            accountId: string;
+            setStatus?: (status: Record<string, unknown>) => void;
+            log?: {
+                info: (msg: string) => void;
+                error: (msg: string) => void;
+            };
+        }) => Promise<void>;
+        stopAccount: (ctx: {
+            accountId: string;
+            setStatus?: (status: Record<string, unknown>) => void;
+        }) => Promise<void>;
+    };
+};
+
+interface PluginRuntime {
+    log?: (msg: string) => void;
+    error?: (msg: string) => void;
+    channel?: {
+        routing?: {
+            resolveAgentRoute?: (params: {
+                cfg: unknown;
+                channel: string;
+                accountId?: string;
+                peer: {
+                    kind: string;
+                    id: string;
+                };
+            }) => {
+                sessionKey: string;
+                accountId: string;
+                agentId?: string;
+            };
+        };
+        reply?: {
+            dispatchReplyFromConfig?: (params: {
+                ctx: unknown;
+                cfg: unknown;
+                dispatcher?: unknown;
+                replyOptions?: unknown;
+            }) => Promise<{
+                queuedFinal: boolean;
+                counts: {
+                    final: number;
+                };
+            }>;
+            dispatchReplyWithBufferedBlockDispatcher?: (params: {
+                ctx: unknown;
+                cfg: unknown;
+                dispatcherOptions: {
+                    deliver: (payload: {
+                        text?: string;
+                    }) => Promise<void>;
+                    onError?: (err: unknown, info: {
+                        kind: string;
+                    }) => void;
+                };
+            }) => Promise<void>;
+            finalizeInboundContext?: (ctx: unknown) => unknown;
+            createReplyDispatcher?: (params: unknown) => unknown;
+            createReplyDispatcherWithTyping?: (params: unknown) => {
+                dispatcher: unknown;
+                replyOptions?: unknown;
+                markDispatchIdle?: () => void;
+            };
+            resolveHumanDelayConfig?: (cfg: unknown, agentId?: string) => unknown;
+            resolveEnvelopeFormatOptions?: (cfg: unknown) => unknown;
+            formatAgentEnvelope?: (params: {
+                channel: string;
+                from: string;
+                previousTimestamp?: number;
+                envelope?: unknown;
+                body: string;
+            }) => string;
+        };
+        session?: {
+            resolveStorePath?: (store: unknown, params: {
+                agentId?: string;
+            }) => string | undefined;
+            readSessionUpdatedAt?: (params: {
+                storePath?: string;
+                sessionKey: string;
+            }) => number | null;
+            recordInboundSession?: (params: {
+                storePath: string;
+                sessionKey: string;
+                ctx: unknown;
+                onRecordError?: (err: unknown) => void;
+            }) => Promise<void>;
+        };
+        text?: {
+            resolveMarkdownTableMode?: (params: {
+                cfg: unknown;
+                channel: string;
+                accountId?: string;
+            }) => unknown;
+            convertMarkdownTables?: (text: string, mode: unknown) => string;
+        };
+    };
+    system?: {
+        enqueueSystemEvent?: (message: string, options?: unknown) => void;
+    };
+    [key: string]: unknown;
+}
+declare function setBaiduAppRuntime(next: PluginRuntime): void;
+declare function getBaiduAppRuntime(): PluginRuntime;
+
+declare function getAccessToken(account: ResolvedBaiduAppAccount): Promise<string>;
+declare function clearAccessTokenCache(account: ResolvedBaiduAppAccount): void;
+declare function clearAllAccessTokenCache(): void;
+interface SendMessageResult {
+    ok: boolean;
+    errcode?: number;
+    errmsg?: string;
+    invaliduser?: string;
+    msgid?: string;
+}
+declare function sendBaiduAppMessage(account: ResolvedBaiduAppAccount, target: BaiduAppSendTarget, message: string): Promise<SendMessageResult>;
+
+interface SendMessageOptions {
+    text?: string;
+}
+interface SendResult {
+    ok: boolean;
+    msgid?: string;
+    error?: string;
+}
+declare function normalizeTarget(target: string, type: 'user'): string;
+declare function parseTarget(target: string): BaiduAppSendTarget;
+declare function sendBaiduDM(account: ResolvedBaiduAppAccount, userId: string, options: SendMessageOptions): Promise<SendResult>;
+declare function sendBaidu(account: ResolvedBaiduAppAccount, target: string, options: SendMessageOptions): Promise<SendResult>;
+
+interface MoltbotPluginApi {
+    registerChannel: (opts: {
+        plugin: unknown;
+    }) => void;
+    registerHttpHandler?: (handler: (req: IncomingMessage, res: ServerResponse) => Promise<boolean> | boolean) => void;
+    runtime?: unknown;
+    [key: string]: unknown;
+}
+
+declare const plugin: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: {
+        type: string;
+        additionalProperties: boolean;
+        properties: {};
+    };
+    register(api: MoltbotPluginApi): void;
+};
+
+export { type AccessTokenCacheEntry, type BaiduAppConfig, type BaiduAppDmPolicy, type BaiduAppInboundMessage, type BaiduAppSendTarget, DEFAULT_ACCOUNT_ID, type MoltbotPluginApi, type ResolvedBaiduAppAccount, type SendMessageOptions, type SendResult, baiduAppPlugin, clearAccessTokenCache, clearAllAccessTokenCache, plugin as default, getAccessToken, getBaiduAppRuntime, normalizeTarget, parseTarget, sendBaidu, sendBaiduAppMessage, sendBaiduDM, setBaiduAppRuntime };