@wecom/wecom-openclaw-plugin 2026.3.20 → 2026.3.24-beta.1

package/README.md

@@ -37,7 +37,25 @@
 
 - OpenClaw `>= 2026.2.13`
 
-### Installation
+### Quick Install
+
+Use the CLI tool to automatically install the plugin and complete bot configuration in one step:
+
+```shell
+# Automatically install the channel plugin and quickly complete configuration; also works for updates
+npx -y @wecom/wecom-openclaw-cli install
+```
+
+More Options
+```shell
+# If installation fails, try force install
+npx -y @wecom/wecom-openclaw-cli install --force
+
+# Use --help to learn more about the tool
+npx -y @wecom/wecom-openclaw-cli --help
+```
+
+### Manual Install
 
 ```shell
 openclaw plugins install @wecom/wecom-openclaw-plugin

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var pluginSdk = require('openclaw/plugin-sdk');
+var core = require('openclaw/plugin-sdk/core');
 var os$1 = require('os');
 var path$1 = require('path');
 var aibotNodeSdk = require('@wecom/aibot-node-sdk');
@@ -12,6 +12,7 @@ var os = require('node:os');
 var node_url = require('node:url');
 var fileType = require('file-type');
 var node_fs = require('node:fs');
+var setup = require('openclaw/plugin-sdk/setup');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
@@ -57,7 +58,7 @@ function getWeComRuntime() {
  * 本模块在加载时一次性探测 SDK 导出，存在则直接 re-export SDK 版本，
  * 不存在则导出 fallback 实现。其他模块统一从本文件导入，无需关心底层兼容细节。
  */
-const _sdkReady = import('openclaw/plugin-sdk')
+const _sdkReady = import('openclaw/plugin-sdk/core')
     .then((sdk) => {
     const exports$1 = {};
     if (typeof sdk.loadOutboundMediaFromUrl === "function") {
@@ -1199,80 +1200,27 @@ async function checkDmPolicy(params) {
     return { allowed: false };
 }
 
+// ============================================================================
+// 类型定义
+// ============================================================================
 // ============================================================================
 // 常量
 // ============================================================================
 const DEFAULT_TTL_MS = 7 * 24 * 60 * 60 * 1000; // 7 天
 const DEFAULT_MEMORY_MAX_SIZE = 200;
-const DEFAULT_FILE_MAX_ENTRIES = 500;
-const DEFAULT_FLUSH_DEBOUNCE_MS = 1000;
-const DEFAULT_LOCK_OPTIONS = {
-    stale: 60000,
-    retries: {
-        retries: 6,
-        factor: 1.35,
-        minTimeout: 8,
-        maxTimeout: 180,
-        randomize: true,
-    },
-};
-// ============================================================================
-// 状态目录解析
-// ============================================================================
-function resolveStateDirFromEnv(env = process.env) {
-    const stateOverride = env.OPENCLAW_STATE_DIR?.trim() || env.CLAWDBOT_STATE_DIR?.trim();
-    if (stateOverride) {
-        return stateOverride;
-    }
-    if (env.VITEST || env.NODE_ENV === "test") {
-        return path.join(os.tmpdir(), ["openclaw-vitest", String(process.pid)].join("-"));
-    }
-    return path.join(os.homedir(), ".openclaw");
-}
-function resolveReqIdFilePath(accountId) {
-    const safe = accountId.replace(/[^a-zA-Z0-9_-]/g, "_");
-    return path.join(resolveStateDirFromEnv(), "wecom", `reqid-map-${safe}.json`);
-}
 // ============================================================================
 // 核心实现
 // ============================================================================
 function createPersistentReqIdStore(accountId, options) {
     const ttlMs = DEFAULT_TTL_MS;
     const memoryMaxSize = DEFAULT_MEMORY_MAX_SIZE;
-    const fileMaxEntries = DEFAULT_FILE_MAX_ENTRIES;
-    const flushDebounceMs = DEFAULT_FLUSH_DEBOUNCE_MS;
-    const filePath = resolveReqIdFilePath(accountId);
     // 内存层：chatId → ReqIdEntry
     const memory = new Map();
-    // 防抖写入相关
-    let dirty = false;
-    let flushTimer = null;
     // ========== 内部辅助函数 ==========
     /** 检查条目是否过期 */
     function isExpired(entry, now) {
         return now - entry.ts >= ttlMs;
     }
-    /** 验证磁盘条目的合法性 */
-    function isValidEntry(entry) {
-        return (typeof entry === "object" &&
-            entry !== null &&
-            typeof entry.reqId === "string" &&
-            typeof entry.ts === "number" &&
-            Number.isFinite(entry.ts));
-    }
-    /** 清理磁盘数据中的无效值，返回干净的 Record */
-    function sanitizeData(value) {
-        if (!value || typeof value !== "object") {
-            return {};
-        }
-        const out = {};
-        for (const [key, entry] of Object.entries(value)) {
-            if (isValidEntry(entry)) {
-                out[key] = entry;
-            }
-        }
-        return out;
-    }
     /**
      * 内存容量控制：淘汰最旧的条目。
      * 利用 Map 的插入顺序 + touch(先 delete 再 set) 实现类 LRU 效果。
@@ -1286,61 +1234,6 @@ function createPersistentReqIdStore(accountId, options) {
             memory.delete(key);
         }
     }
-    /** 磁盘数据容量控制：先清过期，再按时间淘汰超量 */
-    function pruneFileData(data, now) {
-        {
-            for (const [key, entry] of Object.entries(data)) {
-                if (now - entry.ts >= ttlMs) {
-                    delete data[key];
-                }
-            }
-        }
-        const keys = Object.keys(data);
-        if (keys.length <= fileMaxEntries)
-            return;
-        keys
-            .sort((a, b) => data[a].ts - data[b].ts)
-            .slice(0, keys.length - fileMaxEntries)
-            .forEach((key) => delete data[key]);
-    }
-    /** 防抖写入磁盘 */
-    function scheduleDiskFlush() {
-        dirty = true;
-        if (flushTimer)
-            return;
-        flushTimer = setTimeout(async () => {
-            flushTimer = null;
-            if (!dirty)
-                return;
-            await flushToDisk();
-        }, flushDebounceMs);
-    }
-    /** 立即写入磁盘（带文件锁，参考 createPersistentDedupe 的 checkAndRecordInner） */
-    async function flushToDisk() {
-        dirty = false;
-        const now = Date.now();
-        try {
-            await pluginSdk.withFileLock(filePath, DEFAULT_LOCK_OPTIONS, async () => {
-                // 读取现有磁盘数据并合并
-                const { value } = await pluginSdk.readJsonFileWithFallback(filePath, {});
-                const data = sanitizeData(value);
-                // 将内存中未过期的数据合并到磁盘数据（内存优先）
-                for (const [chatId, entry] of memory) {
-                    if (!isExpired(entry, now)) {
-                        data[chatId] = entry;
-                    }
-                }
-                // 清理过期和超量
-                pruneFileData(data, now);
-                // 原子写入
-                await pluginSdk.writeJsonFileAtomically(filePath, data);
-            });
-        }
-        catch (error) {
-            // 磁盘写入失败不影响内存使用，降级到纯内存模式
-            // console.error(`[WeCom] reqid-store: flush to disk failed: ${String(error)}`);
-        }
-    }
     // ========== 公开 API ==========
     function set(chatId, reqId) {
         const entry = { reqId, ts: Date.now() };
@@ -1348,11 +1241,10 @@ function createPersistentReqIdStore(accountId, options) {
         memory.delete(chatId);
         memory.set(chatId, entry);
         pruneMemory();
-        scheduleDiskFlush();
     }
     async function get(chatId) {
         const now = Date.now();
-        // 1. 先查内存
+        // 仅查内存
         const memEntry = memory.get(chatId);
         if (memEntry && !isExpired(memEntry, now)) {
             return memEntry.reqId;
@@ -1360,20 +1252,6 @@ function createPersistentReqIdStore(accountId, options) {
         if (memEntry) {
             memory.delete(chatId); // 过期则删除
         }
-        // 2. 内存 miss，回查磁盘并回填内存
-        try {
-            const { value } = await pluginSdk.readJsonFileWithFallback(filePath, {});
-            const data = sanitizeData(value);
-            const diskEntry = data[chatId];
-            if (diskEntry && !isExpired(diskEntry, now)) {
-                // 回填内存
-                memory.set(chatId, diskEntry);
-                return diskEntry.reqId;
-            }
-        }
-        catch {
-            // 磁盘读取失败，降级返回 undefined
-        }
         return undefined;
     }
     function getSync(chatId) {
@@ -1389,34 +1267,6 @@ function createPersistentReqIdStore(accountId, options) {
     }
     function del(chatId) {
         memory.delete(chatId);
-        scheduleDiskFlush();
-    }
-    async function warmup(onError) {
-        const now = Date.now();
-        try {
-            const { value } = await pluginSdk.readJsonFileWithFallback(filePath, {});
-            const data = sanitizeData(value);
-            let loaded = 0;
-            for (const [chatId, entry] of Object.entries(data)) {
-                if (!isExpired(entry, now)) {
-                    memory.set(chatId, entry);
-                    loaded++;
-                }
-            }
-            pruneMemory();
-            return loaded;
-        }
-        catch (error) {
-            onError?.(error);
-            return 0;
-        }
-    }
-    async function flush() {
-        if (flushTimer) {
-            clearTimeout(flushTimer);
-            flushTimer = null;
-        }
-        await flushToDisk();
     }
     function clearMemory() {
         memory.clear();
@@ -1429,8 +1279,6 @@ function createPersistentReqIdStore(accountId, options) {
         get,
         getSync,
         delete: del,
-        warmup,
-        flush,
         clearMemory,
         memorySize,
     };
@@ -1533,7 +1381,7 @@ const reqIdStores = new Map();
 function getOrCreateReqIdStore(accountId) {
     let store = reqIdStores.get(accountId);
     if (!store) {
-        store = createPersistentReqIdStore(accountId);
+        store = createPersistentReqIdStore();
         reqIdStores.set(accountId, store);
     }
     return store;
@@ -1549,12 +1397,13 @@ function setReqIdForChat(chatId, reqId, accountId = "default") {
 }
 /**
  * 启动时预热 reqId 缓存（从磁盘加载到内存）
+ *
+ * 注意：由于移除了磁盘存储，此函数现在只返回 0（无预热条目）
  */
 async function warmupReqIdStore(accountId = "default", log) {
-    const store = getOrCreateReqIdStore(accountId);
-    return store.warmup((error) => {
-        log?.(`[WeCom] reqid-store warmup error: ${String(error)}`);
-    });
+    // 由于移除了磁盘存储，不再需要预热过程
+    log?.("[WeCom] reqid-store warmup: no-op (disk storage removed)");
+    return 0;
 }
 // ============================================================================
 // 全局 cleanup（断开连接时释放所有资源）
@@ -1574,17 +1423,8 @@ async function cleanupAccount(accountId) {
         }
         wsClientInstances.delete(accountId);
     }
-    // 2. flush reqId 存储到磁盘
-    const store = reqIdStores.get(accountId);
-    if (store) {
-        try {
-            await store.flush();
-        }
-        catch {
-            // 忽略 flush 错误
-        }
-        // 注意：不删除 store，因为重连后可能还需要
-    }
+    // 2. 由于移除了磁盘存储，不再需要 flush reqId 存储
+    // 注意：不删除 store，因为重连后可能还需要
 }
 
 /** 从 package.json 中读取版本号，兼容打包产物和直接运行 .ts 两种场景 */
@@ -2277,7 +2117,7 @@ const DefaultWsUrl = "wss://openws.work.weixin.qq.com";
 function resolveWeComAccount(cfg) {
     const wecomConfig = (cfg.channels?.[CHANNEL_ID] ?? {});
     return {
-        accountId: pluginSdk.DEFAULT_ACCOUNT_ID,
+        accountId: core.DEFAULT_ACCOUNT_ID,
         name: wecomConfig.name ?? "企业微信",
         enabled: wecomConfig.enabled ?? false,
         websocketUrl: wecomConfig.websocketUrl || DefaultWsUrl,
@@ -2359,7 +2199,7 @@ function setWeComDmPolicy(cfg, dmPolicy) {
     const account = resolveWeComAccount(cfg);
     const existingAllowFrom = account.config.allowFrom ?? [];
     const allowFrom = dmPolicy === "open"
-        ? pluginSdk.addWildcardAllowFrom(existingAllowFrom.map((x) => String(x)))
+        ? setup.addWildcardAllowFrom(existingAllowFrom.map((x) => String(x)))
         : existingAllowFrom.map((x) => String(x));
     return setWeComAccount(cfg, {
         dmPolicy,
@@ -2435,7 +2275,7 @@ const wecomOnboardingAdapter = {
  * 无需依赖 reqId，直接向指定会话推送消息
  */
 async function sendWeComMessage({ to, content, accountId, }) {
-    const resolvedAccountId = accountId ?? pluginSdk.DEFAULT_ACCOUNT_ID;
+    const resolvedAccountId = accountId ?? core.DEFAULT_ACCOUNT_ID;
     // 从 to 中提取 chatId（格式是 "${CHANNEL_ID}:chatId" 或直接是 chatId）
     const channelPrefix = new RegExp(`^${CHANNEL_ID}:`, "i");
     const chatId = to.replace(channelPrefix, "");
@@ -2497,11 +2337,11 @@ const wecomPlugin = {
     reload: { configPrefixes: [`channels.${CHANNEL_ID}`] },
     config: {
         // 列出所有账户 ID（最小实现只支持默认账户）
-        listAccountIds: () => [pluginSdk.DEFAULT_ACCOUNT_ID],
+        listAccountIds: () => [core.DEFAULT_ACCOUNT_ID],
         // 解析账户配置
         resolveAccount: (cfg) => resolveWeComAccount(cfg),
         // 获取默认账户 ID
-        defaultAccountId: () => pluginSdk.DEFAULT_ACCOUNT_ID,
+        defaultAccountId: () => core.DEFAULT_ACCOUNT_ID,
         // 设置账户启用状态
         setAccountEnabled: ({ cfg, enabled }) => {
             const wecomConfig = (cfg.channels?.[CHANNEL_ID] ?? {});
@@ -2557,7 +2397,7 @@ const wecomPlugin = {
                 allowFrom: account.config.allowFrom ?? [],
                 policyPath: `${basePath}dmPolicy`,
                 allowFromPath: basePath,
-                approveHint: pluginSdk.formatPairingApproveHint(CHANNEL_ID),
+                approveHint: core.formatPairingApproveHint(CHANNEL_ID),
                 normalizeEntry: (raw) => raw.replace(new RegExp(`^${CHANNEL_ID}:`, "i"), "").trim(),
             };
         },
@@ -2613,7 +2453,7 @@ const wecomPlugin = {
             return sendWeComMessage({ to, content: text, accountId: accountId ?? undefined });
         },
         sendMedia: async ({ to, text, mediaUrl, mediaLocalRoots, accountId }) => {
-            const resolvedAccountId = accountId ?? pluginSdk.DEFAULT_ACCOUNT_ID;
+            const resolvedAccountId = accountId ?? core.DEFAULT_ACCOUNT_ID;
             const channelPrefix = new RegExp(`^${CHANNEL_ID}:`, "i");
             const chatId = to.replace(channelPrefix, "");
             // 获取 WSClient 实例
@@ -2658,14 +2498,14 @@ const wecomPlugin = {
     },
     status: {
         defaultRuntime: {
-            accountId: pluginSdk.DEFAULT_ACCOUNT_ID,
+            accountId: core.DEFAULT_ACCOUNT_ID,
             running: false,
             lastStartAt: null,
             lastStopAt: null,
             lastError: null,
         },
         collectStatusIssues: (accounts) => accounts.flatMap((entry) => {
-            const accountId = String(entry.accountId ?? pluginSdk.DEFAULT_ACCOUNT_ID);
+            const accountId = String(entry.accountId ?? core.DEFAULT_ACCOUNT_ID);
             const enabled = entry.enabled !== false;
             const configured = entry.configured === true;
             if (!enabled) {
@@ -2832,7 +2672,7 @@ const inflightInitRequests = new Map();
  * @returns 完整的 response.body 配置对象（至少包含 url 字段）
  */
 async function fetchMcpConfig(category) {
-    const wsClient = getWeComWebSocket(pluginSdk.DEFAULT_ACCOUNT_ID);
+    const wsClient = getWeComWebSocket(core.DEFAULT_ACCOUNT_ID);
     if (!wsClient) {
         throw new Error("WSClient 未连接，无法拉取 MCP 配置");
     }
@@ -3573,7 +3413,7 @@ const plugin = {
     id: "wecom-openclaw-plugin",
     name: "企业微信",
     description: "企业微信 OpenClaw 插件",
-    configSchema: pluginSdk.emptyPluginConfigSchema(),
+    configSchema: core.emptyPluginConfigSchema(),
     register(api) {
         setWeComRuntime(api.runtime);
         api.registerChannel({ plugin: wecomPlugin });