@wecom/wecom-openclaw-plugin 2026.3.30-beta.2 → 2026.3.31-beta.0

package/dist/src/onboarding.js

@@ -0,0 +1,175 @@
+/**
+ * 企业微信 setupWizard — 声明式 CLI setup wizard 配置。
+ *
+ * 框架通过 plugin.setupWizard 字段识别并驱动 channel 的引导配置流程。
+ */
+import { addWildcardAllowFrom } from "./openclaw-compat.js";
+import { resolveWeComAccountMulti, setWeComAccountMulti } from "./accounts.js";
+import { CHANNEL_ID } from "./const.js";
+// ============================================================================
+// ChannelSetupAdapter — 框架用于应用配置输入的适配器
+// ============================================================================
+export const wecomSetupAdapter = {
+    applyAccountConfig: ({ cfg, input }) => {
+        const patch = {};
+        if (input.token !== undefined) {
+            patch.botId = String(input.token).trim();
+        }
+        if (input.privateKey !== undefined) {
+            patch.secret = String(input.privateKey).trim();
+        }
+        // 如果是首次配置，默认启用
+        const account = resolveWeComAccountMulti({ cfg });
+        if (!account.botId && !account.secret) {
+            patch.enabled = true;
+        }
+        return setWeComAccountMulti(cfg, patch);
+    },
+};
+// ============================================================================
+// DM Policy 配置
+// ============================================================================
+/**
+ * 设置企业微信 dmPolicy
+ */
+function setWeComDmPolicy(cfg, dmPolicy) {
+    const account = resolveWeComAccountMulti({ cfg });
+    const existingAllowFrom = account.config.allowFrom ?? [];
+    const allowFrom = dmPolicy === "open"
+        ? addWildcardAllowFrom(existingAllowFrom.map((x) => String(x)))
+        : existingAllowFrom.map((x) => String(x));
+    return setWeComAccountMulti(cfg, {
+        dmPolicy,
+        allowFrom,
+    });
+}
+const dmPolicy = {
+    label: "企业微信",
+    channel: CHANNEL_ID,
+    policyKey: `channels.${CHANNEL_ID}.dmPolicy`,
+    allowFromKey: `channels.${CHANNEL_ID}.allowFrom`,
+    getCurrent: (cfg) => {
+        const account = resolveWeComAccountMulti({ cfg });
+        return account.config.dmPolicy ?? "open";
+    },
+    setPolicy: (cfg, policy) => {
+        return setWeComDmPolicy(cfg, policy);
+    },
+    promptAllowFrom: async ({ cfg, prompter }) => {
+        const account = resolveWeComAccountMulti({ cfg });
+        const existingAllowFrom = account.config.allowFrom ?? [];
+        const entry = await prompter.text({
+            message: "企业微信允许来源（用户ID或群组ID，逗号分隔）",
+            placeholder: "user123, group456",
+            initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined,
+        });
+        const allowFrom = String(entry ?? "")
+            .split(/[\n,;]+/g)
+            .map((s) => s.trim())
+            .filter(Boolean);
+        return setWeComAccountMulti(cfg, { allowFrom });
+    },
+};
+// ============================================================================
+// ChannelSetupWizard — 声明式 setup wizard 配置
+// ============================================================================
+export const wecomSetupWizard = {
+    channel: CHANNEL_ID,
+    // ── 状态 ──────────────────────────────────────────────────────────────
+    status: {
+        configuredLabel: "已配置 ✓",
+        unconfiguredLabel: "需要 Bot ID 和 Secret",
+        configuredHint: "已配置",
+        unconfiguredHint: "需要设置",
+        resolveConfigured: ({ cfg }) => {
+            const account = resolveWeComAccountMulti({ cfg });
+            return Boolean(account.botId?.trim() && account.secret?.trim());
+        },
+        resolveStatusLines: ({ cfg, configured }) => {
+            return [`企业微信: ${configured ? "已配置" : "需要 Bot ID 和 Secret"}`];
+        },
+    },
+    // ── 引导说明 ──────────────────────────────────────────────────────────
+    introNote: {
+        title: "企业微信设置",
+        lines: [
+            "企业微信机器人需要以下配置信息：",
+            "1. Bot ID: 企业微信机器人 ID",
+            "2. Secret: 企业微信机器人密钥",
+        ],
+        shouldShow: ({ cfg }) => {
+            const account = resolveWeComAccountMulti({ cfg });
+            return !account.botId?.trim() || !account.secret?.trim();
+        },
+    },
+    // ── 凭据输入 ──────────────────────────────────────────────────────────
+    credentials: [
+        {
+            inputKey: "token",
+            providerHint: "企业微信",
+            credentialLabel: "Bot ID",
+            envPrompt: "使用环境变量中的 Bot ID？",
+            keepPrompt: "Bot ID 已配置，保留当前值？",
+            inputPrompt: "企业微信机器人 Bot ID",
+            inspect: ({ cfg }) => {
+                const account = resolveWeComAccountMulti({ cfg });
+                const hasValue = Boolean(account.botId?.trim());
+                return {
+                    accountConfigured: hasValue,
+                    hasConfiguredValue: hasValue,
+                    resolvedValue: account.botId || undefined,
+                };
+            },
+            applySet: ({ cfg, resolvedValue }) => {
+                return setWeComAccountMulti(cfg, { botId: resolvedValue });
+            },
+        },
+        {
+            inputKey: "privateKey",
+            providerHint: "企业微信",
+            credentialLabel: "Secret",
+            envPrompt: "使用环境变量中的 Secret？",
+            keepPrompt: "Secret 已配置，保留当前值？",
+            inputPrompt: "企业微信机器人 Secret",
+            inspect: ({ cfg }) => {
+                const account = resolveWeComAccountMulti({ cfg });
+                const hasValue = Boolean(account.secret?.trim());
+                return {
+                    accountConfigured: hasValue,
+                    hasConfiguredValue: hasValue,
+                    resolvedValue: account.secret || undefined,
+                };
+            },
+            applySet: ({ cfg, resolvedValue }) => {
+                return setWeComAccountMulti(cfg, { secret: resolvedValue });
+            },
+        },
+    ],
+    // ── 完成后的最终处理 ──────────────────────────────────────────────────
+    finalize: async ({ cfg }) => {
+        // 确保配置完成后 channel 处于启用状态
+        const account = resolveWeComAccountMulti({ cfg });
+        if (account.botId?.trim() && account.secret?.trim() && !account.enabled) {
+            return { cfg: setWeComAccountMulti(cfg, { enabled: true }) };
+        }
+        return undefined;
+    },
+    // ── 完成提示 ──────────────────────────────────────────────────────────
+    completionNote: {
+        title: "企业微信配置完成",
+        lines: [
+            "企业微信机器人已配置完成。",
+            "运行 `openclaw start` 启动服务。",
+        ],
+        shouldShow: ({ cfg }) => {
+            const account = resolveWeComAccountMulti({ cfg });
+            return Boolean(account.botId?.trim() && account.secret?.trim());
+        },
+    },
+    // ── DM 策略 ──────────────────────────────────────────────────────────
+    dmPolicy,
+    // ── 禁用 ─────────────────────────────────────────────────────────────
+    disable: (cfg) => {
+        return setWeComAccountMulti(cfg, { enabled: false });
+    },
+};

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

@@ -51,6 +51,8 @@ export declare function loadOutboundMediaFromUrl(mediaUrl: string, options?: Out
  * SDK 引用在模块加载时异步探测并缓存，调用时同步读取缓存。
  */
 export declare function addWildcardAllowFrom(allowFrom: string[]): string[];
+/** 通过框架 PluginRuntime 获取 openclaw 状态目录（避免直接访问环境变量） */
+export declare function resolveStateDir(): string;
 /**
  * 获取默认媒体本地路径白名单（兼容入口）
  *
@@ -94,3 +96,50 @@ export declare function buildAccountScopedDmSecurityPolicy(params: {
  * @returns 配对审批提示字符串
  */
 export declare function formatPairingApproveHint(channelId: string): string;
+/**
+ * 与 openclaw plugin-sdk/channel-policy 中 ChannelSecurityDmPolicy 兼容的类型。
+ * 低版本 SDK 未导出该方法时，使用此 fallback。
+ */
+export 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 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>;