@dingxiang-me/openclaw-wechat 0.4.9

package/openclaw.plugin.json

@@ -0,0 +1,412 @@
+{
+  "id": "openclaw-wechat",
+  "name": "OpenClaw-Wechat",
+  "version": "0.4.9",
+  "description": "WeCom (企业微信) channel plugin for OpenClaw (自建应用回调 + 发送 API).",
+  "channels": [
+    "wecom"
+  ],
+  "extensions": [
+    "./src/index.js"
+  ],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "enabled": {
+        "type": "boolean",
+        "default": true,
+        "description": "是否启用 WeCom 渠道"
+      },
+      "corpId": {
+        "type": "string",
+        "minLength": 1,
+        "description": "企业微信 Corp ID"
+      },
+      "corpSecret": {
+        "type": "string",
+        "minLength": 1,
+        "description": "企业微信 Corp Secret",
+        "x-sensitive": true
+      },
+      "agentId": {
+        "oneOf": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "string",
+            "pattern": "^[0-9]+$"
+          }
+        ],
+        "description": "企业微信 Agent ID"
+      },
+      "callbackToken": {
+        "type": "string",
+        "minLength": 1,
+        "description": "回调 Token",
+        "x-sensitive": true
+      },
+      "callbackAesKey": {
+        "type": "string",
+        "minLength": 1,
+        "description": "回调 AES Key",
+        "x-sensitive": true
+      },
+      "webhookPath": {
+        "type": "string",
+        "description": "Webhook 路径",
+        "default": "/wecom/callback"
+      },
+      "bot": {
+        "type": "object",
+        "description": "企业微信 AI 机器人（Bot API 模式）配置（JSON 回调 + 原生 stream）",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否启用 Bot 模式"
+          },
+          "token": {
+            "type": "string",
+            "description": "Bot 模式回调 Token"
+          },
+          "encodingAesKey": {
+            "type": "string",
+            "description": "Bot 模式回调 EncodingAESKey（43 位）",
+            "x-sensitive": true
+          },
+          "webhookPath": {
+            "type": "string",
+            "default": "/wecom/bot/callback",
+            "description": "Bot 模式 webhook 路径"
+          },
+          "placeholderText": {
+            "type": "string",
+            "default": "消息已收到，正在处理中，请稍等片刻。",
+            "description": "Bot 模式初始 stream 占位文本"
+          },
+          "streamExpireMs": {
+            "type": "integer",
+            "minimum": 30000,
+            "maximum": 3600000,
+            "default": 600000,
+            "description": "Bot 流式会话保留时长（毫秒）"
+          }
+        }
+      },
+      "outboundProxy": {
+        "type": "string",
+        "description": "可选：WeCom 出站 API 代理（如 http://127.0.0.1:7890）"
+      },
+      "allowFrom": {
+        "type": "array",
+        "description": "可选：允许发送消息的用户列表（空=不限制，支持 '*'）",
+        "items": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "allowFromRejectMessage": {
+        "type": "string",
+        "description": "发送者未授权时的拒绝提示文案"
+      },
+      "adminUsers": {
+        "type": "array",
+        "description": "管理员用户 ID（可绕过指令白名单）",
+        "items": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "commands": {
+        "type": "object",
+        "description": "指令白名单控制（启用后仅允许 allowlist 内的 / 指令）",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否启用指令白名单（默认关闭，保持兼容）"
+          },
+          "allowlist": {
+            "type": "array",
+            "description": "允许的指令列表（如 /status、/new）",
+            "items": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "rejectMessage": {
+            "type": "string",
+            "description": "命中未授权指令时返回给用户的提示文本"
+          }
+        }
+      },
+      "groupChat": {
+        "type": "object",
+        "description": "群聊触发策略",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "是否启用群聊消息处理"
+          },
+          "requireMention": {
+            "type": "boolean",
+            "default": false,
+            "description": "群聊是否必须包含 @ 提及才触发"
+          },
+          "mentionPatterns": {
+            "type": "array",
+            "description": "提及匹配关键字（默认 ['@']）",
+            "items": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      },
+      "debounce": {
+        "type": "object",
+        "description": "文本消息防抖合并",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否启用文本防抖（默认关闭，保持兼容）"
+          },
+          "windowMs": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 10000,
+            "default": 1200,
+            "description": "防抖窗口（毫秒）"
+          },
+          "maxBatch": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 50,
+            "default": 6,
+            "description": "单次最多合并消息条数"
+          }
+        }
+      },
+      "streaming": {
+        "type": "object",
+        "description": "Agent 模式增量回包策略（通过多条文本消息模拟，非 Bot 原生 stream）",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否启用流式回复（默认关闭，保持兼容）"
+          },
+          "minChars": {
+            "type": "integer",
+            "minimum": 20,
+            "maximum": 2000,
+            "default": 120,
+            "description": "最小增量字符数，达到后才发送下一段"
+          },
+          "minIntervalMs": {
+            "type": "integer",
+            "minimum": 200,
+            "maximum": 10000,
+            "default": 1200,
+            "description": "两次增量发送的最短间隔（毫秒）"
+          }
+        }
+      },
+      "voiceTranscription": {
+        "type": "object",
+        "description": "语音转写回退配置（当企业微信 Recognition 缺失时使用）",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "是否启用插件侧语音转写回退"
+          },
+          "provider": {
+            "type": "string",
+            "enum": [
+              "local-whisper-cli",
+              "local-whisper"
+            ],
+            "default": "local-whisper-cli",
+            "description": "本地转写提供方类型"
+          },
+          "command": {
+            "type": "string",
+            "description": "可选：本地转写命令（默认按 provider 自动探测）"
+          },
+          "apiBaseUrl": {
+            "type": "string",
+            "description": "已弃用：历史 OpenAI 转写配置，不再使用"
+          },
+          "apiKey": {
+            "type": "string",
+            "description": "已弃用：历史 OpenAI 转写配置，不再使用",
+            "x-sensitive": true
+          },
+          "apiKeyEnv": {
+            "type": "string",
+            "description": "已弃用：历史 OpenAI 转写配置，不再使用"
+          },
+          "modelPath": {
+            "type": "string",
+            "description": "local-whisper-cli 使用的本地模型文件路径（如 ggml/gguf）"
+          },
+          "model": {
+            "type": "string",
+            "default": "base",
+            "description": "local-whisper 使用的模型名（tiny/base/small/...）"
+          },
+          "language": {
+            "type": "string",
+            "description": "可选：转写语言（如 zh）"
+          },
+          "prompt": {
+            "type": "string",
+            "description": "可选：转写提示词"
+          },
+          "timeoutMs": {
+            "type": "integer",
+            "minimum": 1000,
+            "default": 20000,
+            "description": "转写请求超时时间（毫秒）"
+          },
+          "maxBytes": {
+            "type": "integer",
+            "minimum": 262144,
+            "default": 10485760,
+            "description": "允许转写的最大音频大小（字节）"
+          },
+          "ffmpegEnabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "当音频格式不兼容时，是否允许使用 ffmpeg 转码到 wav"
+          },
+          "transcodeToWav": {
+            "type": "boolean",
+            "default": true,
+            "description": "是否优先将语音统一转码为 wav 再交给本地模型"
+          },
+          "requireModelPath": {
+            "type": "boolean",
+            "default": true,
+            "description": "local-whisper-cli 模式下是否强制要求配置 modelPath"
+          }
+        }
+      },
+      "accounts": {
+        "type": "object",
+        "description": "多账户配置（键为账户 ID）",
+        "minProperties": 1,
+        "additionalProperties": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "corpId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "corpSecret": {
+              "type": "string",
+              "minLength": 1,
+              "x-sensitive": true
+            },
+            "agentId": {
+              "oneOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "string",
+                  "pattern": "^[0-9]+$"
+                }
+              ]
+            },
+            "callbackToken": {
+              "type": "string",
+              "minLength": 1,
+              "x-sensitive": true
+            },
+            "callbackAesKey": {
+              "type": "string",
+              "minLength": 1,
+              "x-sensitive": true
+            },
+            "webhookPath": {
+              "type": "string",
+              "default": "/wecom/callback"
+            },
+            "outboundProxy": {
+              "type": "string",
+              "description": "可选：该账户专用 WeCom 出站 API 代理（覆盖 channels.wecom.outboundProxy）"
+            },
+            "allowFrom": {
+              "type": "array",
+              "description": "可选：该账户专用发送者允许列表（覆盖 channels.wecom.allowFrom）",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "allowFromRejectMessage": {
+              "type": "string",
+              "description": "可选：该账户发送者未授权时的拒绝文案（覆盖 channels.wecom.allowFromRejectMessage）"
+            }
+          },
+          "required": [
+            "corpId",
+            "corpSecret",
+            "agentId"
+          ]
+        }
+      }
+    }
+  },
+  "uiHints": {
+    "corpSecret": {
+      "sensitive": true
+    },
+    "callbackToken": {
+      "sensitive": true
+    },
+    "callbackAesKey": {
+      "sensitive": true
+    },
+    "bot.token": {
+      "sensitive": true
+    },
+    "bot.encodingAesKey": {
+      "sensitive": true
+    },
+    "voiceTranscription.apiKey": {
+      "sensitive": true
+    }
+  },
+  "channel": {
+    "id": "wecom",
+    "label": "WeCom",
+    "selectionLabel": "WeCom (企业微信自建应用)",
+    "docsPath": "/channels/wecom",
+    "docsLabel": "wecom",
+    "blurb": "Enterprise WeChat internal app via callback + send API.",
+    "order": 80,
+    "aliases": [
+      "wework",
+      "qiwei",
+      "wxwork"
+    ]
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@dingxiang-me/openclaw-wechat",
+  "version": "0.4.9",
+  "type": "module",
+  "description": "WeCom (企业微信) channel plugin for OpenClaw (自建应用回调 + 发送 API).",
+  "license": "MIT",
+  "exports": "./src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "src/",
+    "openclaw.plugin.json",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "docs/channels/wecom.md"
+  ],
+  "openclaw": {
+    "extensions": [
+      "./src/index.js"
+    ],
+    "channel": {
+      "id": "wecom",
+      "label": "WeCom",
+      "selectionLabel": "WeCom (企业微信自建应用)",
+      "docsPath": "/channels/wecom",
+      "docsLabel": "wecom",
+      "blurb": "Enterprise WeChat internal app via callback + send API.",
+      "order": 80,
+      "aliases": [
+        "wework",
+        "qiwei",
+        "wxwork"
+      ]
+    }
+  },
+  "scripts": {
+    "lint": "npm run test:syntax",
+    "test:syntax": "node -c src/index.js",
+    "test": "npm run test:syntax && node --test tests/*.test.mjs",
+    "wecom:selfcheck": "node ./scripts/wecom-selfcheck.mjs",
+    "wecom:smoke": "bash ./scripts/wecom-smoke.sh"
+  },
+  "dependencies": {
+    "fast-xml-parser": "^5.3.5",
+    "undici": "^7.22.0"
+  }
+}