ylib-wecom-openclaw-plugin 2026.4.29

package/dist/src/onboarding.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 企业微信 setupWizard — 声明式 CLI setup wizard 配置。
+ *
+ * 框架通过 plugin.setupWizard 字段识别并驱动 channel 的引导配置流程。
+ */
+import type { ChannelSetupAdapter } from "ylib-openclaw/plugin-sdk";
+export declare const wecomSetupAdapter: ChannelSetupAdapter;
+export declare const wecomSetupWizard: any;

package/dist/src/onboarding.js

@@ -0,0 +1,248 @@
+"use strict";
+/**
+ * 企业微信 setupWizard — 声明式 CLI setup wizard 配置。
+ *
+ * 框架通过 plugin.setupWizard 字段识别并驱动 channel 的引导配置流程。
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.wecomSetupWizard = exports.wecomSetupAdapter = void 0;
+var openclaw_compat_js_1 = require("./openclaw-compat.js");
+var accounts_js_1 = require("./accounts.js");
+var const_js_1 = require("./const.js");
+// ============================================================================
+// ChannelSetupAdapter — 框架用于应用配置输入的适配器
+// ============================================================================
+exports.wecomSetupAdapter = {
+    applyAccountConfig: function (_a) {
+        var cfg = _a.cfg, input = _a.input;
+        var patch = {};
+        if (input.token !== undefined) {
+            patch.botId = String(input.token).trim();
+        }
+        if (input.privateKey !== undefined) {
+            patch.secret = String(input.privateKey).trim();
+        }
+        // 如果是首次配置，默认启用
+        var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+        if (!account.botId && !account.secret) {
+            patch.enabled = true;
+        }
+        return accounts_js_1.setWeComAccountMulti(cfg, patch);
+    }
+};
+// ============================================================================
+// DM Policy 配置
+// ============================================================================
+/**
+ * 设置企业微信 dmPolicy
+ */
+function setWeComDmPolicy(cfg, dmPolicy) {
+    var _a;
+    var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+    var existingAllowFrom = (_a = account.config.allowFrom) !== null && _a !== void 0 ? _a : [];
+    var allowFrom = dmPolicy === "open"
+        ? openclaw_compat_js_1.addWildcardAllowFrom(existingAllowFrom.map(function (x) { return String(x); }))
+        : existingAllowFrom.map(function (x) { return String(x); });
+    return accounts_js_1.setWeComAccountMulti(cfg, {
+        dmPolicy: dmPolicy,
+        allowFrom: allowFrom
+    });
+}
+var dmPolicy = {
+    label: "企业微信",
+    channel: const_js_1.CHANNEL_ID,
+    policyKey: "channels." + const_js_1.CHANNEL_ID + ".dmPolicy",
+    allowFromKey: "channels." + const_js_1.CHANNEL_ID + ".allowFrom",
+    getCurrent: function (cfg) {
+        var _a;
+        var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+        return (_a = account.config.dmPolicy) !== null && _a !== void 0 ? _a : "open";
+    },
+    setPolicy: function (cfg, policy) {
+        return setWeComDmPolicy(cfg, policy);
+    },
+    promptAllowFrom: function (_a) {
+        var cfg = _a.cfg, prompter = _a.prompter;
+        return __awaiter(void 0, void 0, void 0, function () {
+            var account, existingAllowFrom, entry, allowFrom;
+            var _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+                        existingAllowFrom = (_b = account.config.allowFrom) !== null && _b !== void 0 ? _b : [];
+                        return [4 /*yield*/, prompter.text({
+                                message: "企业微信允许来源（用户ID或群组ID，逗号分隔）",
+                                placeholder: "user123, group456",
+                                initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined
+                            })];
+                    case 1:
+                        entry = _c.sent();
+                        allowFrom = String(entry !== null && entry !== void 0 ? entry : "")
+                            .split(/[\n,;]+/g)
+                            .map(function (s) { return s.trim(); })
+                            .filter(Boolean);
+                        return [2 /*return*/, accounts_js_1.setWeComAccountMulti(cfg, { allowFrom: allowFrom })];
+                }
+            });
+        });
+    }
+};
+// ============================================================================
+// ChannelSetupWizard — 声明式 setup wizard 配置
+// ============================================================================
+exports.wecomSetupWizard = {
+    channel: const_js_1.CHANNEL_ID,
+    // ── 状态 ──────────────────────────────────────────────────────────────
+    status: {
+        configuredLabel: "已配置 ✓",
+        unconfiguredLabel: "需要 Bot ID 和 Secret",
+        configuredHint: "已配置",
+        unconfiguredHint: "需要设置",
+        resolveConfigured: function (_a) {
+            var _b, _c;
+            var cfg = _a.cfg;
+            var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+            return Boolean(((_b = account.botId) === null || _b === void 0 ? void 0 : _b.trim()) && ((_c = account.secret) === null || _c === void 0 ? void 0 : _c.trim()));
+        },
+        resolveStatusLines: function (_a) {
+            var cfg = _a.cfg, configured = _a.configured;
+            return ["\u4F01\u4E1A\u5FAE\u4FE1: " + (configured ? "已配置" : "需要 Bot ID 和 Secret")];
+        }
+    },
+    // ── 引导说明 ──────────────────────────────────────────────────────────
+    introNote: {
+        title: "企业微信设置",
+        lines: [
+            "企业微信机器人需要以下配置信息：",
+            "1. Bot ID: 企业微信机器人 ID",
+            "2. Secret: 企业微信机器人密钥",
+        ],
+        shouldShow: function (_a) {
+            var _b, _c;
+            var cfg = _a.cfg;
+            var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+            return !((_b = account.botId) === null || _b === void 0 ? void 0 : _b.trim()) || !((_c = account.secret) === null || _c === void 0 ? void 0 : _c.trim());
+        }
+    },
+    // ── 凭据输入 ──────────────────────────────────────────────────────────
+    credentials: [
+        {
+            inputKey: "token",
+            providerHint: "企业微信",
+            credentialLabel: "Bot ID",
+            envPrompt: "使用环境变量中的 Bot ID？",
+            keepPrompt: "Bot ID 已配置，保留当前值？",
+            inputPrompt: "企业微信机器人 Bot ID",
+            inspect: function (_a) {
+                var _b;
+                var cfg = _a.cfg;
+                var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+                var hasValue = Boolean((_b = account.botId) === null || _b === void 0 ? void 0 : _b.trim());
+                return {
+                    accountConfigured: hasValue,
+                    hasConfiguredValue: hasValue,
+                    resolvedValue: account.botId || undefined
+                };
+            },
+            applySet: function (_a) {
+                var cfg = _a.cfg, resolvedValue = _a.resolvedValue;
+                return accounts_js_1.setWeComAccountMulti(cfg, { botId: resolvedValue });
+            }
+        },
+        {
+            inputKey: "privateKey",
+            providerHint: "企业微信",
+            credentialLabel: "Secret",
+            envPrompt: "使用环境变量中的 Secret？",
+            keepPrompt: "Secret 已配置，保留当前值？",
+            inputPrompt: "企业微信机器人 Secret",
+            inspect: function (_a) {
+                var _b;
+                var cfg = _a.cfg;
+                var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+                var hasValue = Boolean((_b = account.secret) === null || _b === void 0 ? void 0 : _b.trim());
+                return {
+                    accountConfigured: hasValue,
+                    hasConfiguredValue: hasValue,
+                    resolvedValue: account.secret || undefined
+                };
+            },
+            applySet: function (_a) {
+                var cfg = _a.cfg, resolvedValue = _a.resolvedValue;
+                return accounts_js_1.setWeComAccountMulti(cfg, { secret: resolvedValue });
+            }
+        },
+    ],
+    // ── 完成后的最终处理 ──────────────────────────────────────────────────
+    finalize: function (_a) {
+        var cfg = _a.cfg;
+        return __awaiter(void 0, void 0, void 0, function () {
+            var account;
+            var _b, _c;
+            return __generator(this, function (_d) {
+                account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+                if (((_b = account.botId) === null || _b === void 0 ? void 0 : _b.trim()) && ((_c = account.secret) === null || _c === void 0 ? void 0 : _c.trim()) && !account.enabled) {
+                    return [2 /*return*/, { cfg: accounts_js_1.setWeComAccountMulti(cfg, { enabled: true }) }];
+                }
+                return [2 /*return*/, undefined];
+            });
+        });
+    },
+    // ── 完成提示 ──────────────────────────────────────────────────────────
+    completionNote: {
+        title: "企业微信配置完成",
+        lines: [
+            "企业微信机器人已配置完成。",
+            "运行 `openclaw start` 启动服务。",
+        ],
+        shouldShow: function (_a) {
+            var _b, _c;
+            var cfg = _a.cfg;
+            var account = accounts_js_1.resolveWeComAccountMulti({ cfg: cfg });
+            return Boolean(((_b = account.botId) === null || _b === void 0 ? void 0 : _b.trim()) && ((_c = account.secret) === null || _c === void 0 ? void 0 : _c.trim()));
+        }
+    },
+    // ── DM 策略 ──────────────────────────────────────────────────────────
+    dmPolicy: dmPolicy,
+    // ── 禁用 ─────────────────────────────────────────────────────────────
+    disable: function (cfg) {
+        return accounts_js_1.setWeComAccountMulti(cfg, { enabled: false });
+    }
+};

package/dist/src/openclaw-compat.d.ts

@@ -0,0 +1,148 @@
+/**
+ * openclaw plugin-sdk 高版本方法兼容层
+ *
+ * 部分方法（如 loadOutboundMediaFromUrl、detectMime、getDefaultMediaLocalRoots）
+ * 仅在较新版本的 openclaw plugin-sdk 中才导出。
+ *
+ * 本模块在加载时一次性探测 SDK 导出，存在则直接 re-export SDK 版本，
+ * 不存在则导出 fallback 实现。其他模块统一从本文件导入，无需关心底层兼容细节。
+ */
+/// <reference types="node" />
+import { resolveStateDir } from "./state-dir-resolve.js";
+export { resolveStateDir };
+export declare const DEFAULT_ACCOUNT_ID = "default";
+/** 与 openclaw plugin-sdk 中 WebMediaResult 兼容的类型 */
+export declare type WebMediaResult = {
+    buffer: Buffer;
+    contentType?: string;
+    kind?: string;
+    fileName?: string;
+};
+export declare type OutboundMediaLoadOptions = {
+    maxBytes?: number;
+    mediaLocalRoots?: readonly string[];
+    gatewayToken?: string;
+    trustedGatewayBaseUrl?: string;
+};
+export declare type DetectMimeOptions = {
+    buffer?: Buffer;
+    headerMime?: string | null;
+    filePath?: string;
+};
+/**
+ * 检测 MIME 类型（兼容入口）
+ *
+ * 支持两种调用签名以兼容不同使用场景：
+ * - detectMime(buffer)           → 旧式调用
+ * - detectMime({ buffer, headerMime, filePath }) → 完整参数
+ *
+ * 优先使用 SDK 版本，不可用时使用 fallback。
+ */
+export declare function detectMime(bufferOrOpts: Buffer | DetectMimeOptions): Promise<string | undefined>;
+/**
+ * 从 URL 或本地路径加载媒体文件（兼容入口）
+ *
+ * 优先使用 SDK 版本，不可用时使用 fallback。
+ * SDK 版本抛出的业务异常（如 LocalMediaAccessError）会直接透传。
+ */
+export declare function loadOutboundMediaFromUrl(mediaUrl: string, options?: OutboundMediaLoadOptions): Promise<WebMediaResult>;
+/**
+ * 向 allowFrom 列表添加通配符 "*"（兼容入口）
+ *
+ * 当 dmPolicy 为 "open" 时，需要确保 allowFrom 中包含 "*" 以允许所有来源。
+ * 优先使用 SDK 版本（plugin-sdk/setup 或 plugin-sdk/core），不可用时使用 fallback。
+ *
+ * 注意：此函数为同步函数，与 SDK 原始签名一致。
+ * SDK 引用在模块加载时异步探测并缓存，调用时同步读取缓存。
+ */
+export declare function addWildcardAllowFrom(allowFrom: string[]): string[];
+/**
+ * 获取默认媒体本地路径白名单（兼容入口）
+ *
+ * 优先使用 SDK 版本，不可用时手动构建白名单（与 weclaw/src/media/local-roots.ts 逻辑一致）。
+ */
+export declare function getDefaultMediaLocalRoots(): Promise<readonly string[]>;
+export declare function emptyPluginConfigSchema(): Record<string, unknown>;
+/**
+ * 解析可选的分隔条目
+ * @param value 输入字符串，支持逗号、分号、换行符分隔
+ * @returns 解析后的字符串数组，如果输入为空则返回 undefined
+ */
+export declare function parseOptionalDelimitedEntries(value?: string): string[] | undefined;
+/**
+ * 构建账户范围的 DM 安全策略
+ */
+export declare function buildAccountScopedDmSecurityPolicy(params: {
+    cfg: Record<string, unknown>;
+    channelKey: string;
+    accountId?: string | null;
+    fallbackAccountId?: string | null;
+    policy?: string | null;
+    allowFrom?: Array<string | number> | null;
+    defaultPolicy?: string;
+    allowFromPathSuffix?: string;
+    policyPathSuffix?: string;
+    approveChannelId?: string;
+    approveHint?: string;
+    normalizeEntry?: (raw: string) => string;
+}): {
+    policy: string;
+    allowFrom: Array<string | number>;
+    policyPath?: string;
+    allowFromPath: string;
+    approveHint: string;
+    normalizeEntry?: (raw: string) => string;
+};
+/**
+ * 格式化配对审批提示信息（参考 moltbot 实现）
+ * @param channelId 频道ID
+ * @returns 配对审批提示字符串
+ */
+export declare function formatPairingApproveHint(channelId: string): string;
+/**
+ * 与 openclaw plugin-sdk/channel-policy 中 ChannelSecurityDmPolicy 兼容的类型。
+ * 低版本 SDK 未导出该方法时，使用此 fallback。
+ */
+export declare type ChannelSecurityDmPolicyCompat = {
+    policy: string;
+    allowFrom?: Array<string | number> | null;
+    policyPath?: string;
+    allowFromPath: string;
+    approveHint: string;
+    normalizeEntry?: (raw: string) => string;
+};
+declare global {
+    namespace openclaw.plugin.sdk {
+        interface ChannelSecurityDmPolicy {
+            policy: string;
+            allowFrom?: Array<string | number> | null;
+            policyPath?: string;
+            allowFromPath: string;
+            approveHint: string;
+            normalizeEntry?: (raw: string) => string;
+        }
+    }
+}
+export declare type BuildAccountScopedDmSecurityPolicyParams = {
+    cfg: {
+        channels?: Record<string, unknown>;
+    };
+    channelKey: string;
+    accountId?: string | null;
+    fallbackAccountId?: string | null;
+    policy?: string | null;
+    allowFrom?: Array<string | number> | null;
+    defaultPolicy?: string;
+    allowFromPathSuffix?: string;
+    policyPathSuffix?: string;
+    approveChannelId?: string;
+    approveHint?: string;
+    normalizeEntry?: (raw: string) => string;
+};
+/**
+ * 构建多账号作用域的 DM 安全策略（兼容入口）
+ *
+ * 优先使用 SDK 版本（openclaw/plugin-sdk/channel-policy），
+ * 不可用时使用 fallback 实现。
+ */
+export declare function buildAccountScopedDmSecurityPolicyCompat(params: BuildAccountScopedDmSecurityPolicyParams): Promise<ChannelSecurityDmPolicyCompat>;