@openclaw-china/shared 2026.3.12 → 2026.3.16

package/src/cli/china-setup.ts

@@ -51,7 +51,7 @@ type ConfigRoot = {
   [key: string]: unknown;
 };
 
-export type ChannelId = "dingtalk" | "feishu-china" | "wecom" | "wecom-app" | "qqbot";
+export type ChannelId = "dingtalk" | "feishu-china" | "wecom" | "wecom-app" | "wecom-kf" | "qqbot";
 
 export type RegisterChinaSetupCliOptions = {
   channels?: readonly ChannelId[];
@@ -77,6 +77,7 @@ const CHANNEL_ORDER: readonly ChannelId[] = [
   "qqbot",
   "wecom",
   "wecom-app",
+  "wecom-kf",
   "feishu-china",
 ];
 const CHANNEL_DISPLAY_LABELS: Record<ChannelId, string> = {
@@ -84,6 +85,7 @@ const CHANNEL_DISPLAY_LABELS: Record<ChannelId, string> = {
   "feishu-china": "Feishu（飞书）",
   wecom: "WeCom（企业微信-智能机器人）",
   "wecom-app": "WeCom App（自建应用-可接入微信）",
+  "wecom-kf": "WeCom KF（微信客服）",
   qqbot: "QQBot（QQ 机器人）",
 };
 const CHANNEL_GUIDE_LINKS: Record<ChannelId, string> = {
@@ -91,6 +93,7 @@ const CHANNEL_GUIDE_LINKS: Record<ChannelId, string> = {
   "feishu-china": "https://github.com/BytePioneer-AI/openclaw-china/blob/main/README.md",
   wecom: `${GUIDES_BASE}/wecom/configuration.md`,
   "wecom-app": `${GUIDES_BASE}/wecom-app/configuration.md`,
+  "wecom-kf": "https://github.com/BytePioneer-AI/openclaw-china/blob/main/extensions/wecom-kf/README.md",
   qqbot: `${GUIDES_BASE}/qqbot/configuration.md`,
 };
 const CHINA_CLI_STATE_KEY = Symbol.for("@openclaw-china/china-cli-state");
@@ -266,19 +269,19 @@ function cloneConfig(cfg: ConfigRoot): ConfigRoot {
   }
 }
 
-function getChannelConfig(cfg: ConfigRoot, channelId: ChannelId): ConfigRecord {
-  const channels = isRecord(cfg.channels) ? cfg.channels : {};
-  const existing = channels[channelId];
-  return isRecord(existing) ? existing : {};
-}
-
-function getGatewayAuthToken(cfg: ConfigRoot): string | undefined {
-  if (!isRecord(cfg.gateway)) {
-    return undefined;
-  }
-  const auth = isRecord(cfg.gateway.auth) ? cfg.gateway.auth : undefined;
-  return toTrimmedString(auth?.token);
-}
+function getChannelConfig(cfg: ConfigRoot, channelId: ChannelId): ConfigRecord {
+  const channels = isRecord(cfg.channels) ? cfg.channels : {};
+  const existing = channels[channelId];
+  return isRecord(existing) ? existing : {};
+}
+
+function getGatewayAuthToken(cfg: ConfigRoot): string | undefined {
+  if (!isRecord(cfg.gateway)) {
+    return undefined;
+  }
+  const auth = isRecord(cfg.gateway.auth) ? cfg.gateway.auth : undefined;
+  return toTrimmedString(auth?.token);
+}
 
 function getPreferredAccountConfig(channelCfg: ConfigRecord): ConfigRecord | undefined {
   const accounts = channelCfg.accounts;
@@ -302,25 +305,25 @@ function getPreferredAccountConfig(channelCfg: ConfigRecord): ConfigRecord | und
   return undefined;
 }
 
-function hasCredentialPair(channelCfg: ConfigRecord, firstKey: string, secondKey: string): boolean {
-  if (hasNonEmptyString(channelCfg[firstKey]) && hasNonEmptyString(channelCfg[secondKey])) {
-    return true;
-  }
-  const accountCfg = getPreferredAccountConfig(channelCfg);
-  return Boolean(
-    accountCfg &&
-      hasNonEmptyString(accountCfg[firstKey]) &&
-      hasNonEmptyString(accountCfg[secondKey])
-  );
-}
-
-function hasTokenPair(channelCfg: ConfigRecord): boolean {
-  return hasCredentialPair(channelCfg, "token", "encodingAESKey");
-}
-
-function hasWecomWsCredentialPair(channelCfg: ConfigRecord): boolean {
-  return hasCredentialPair(channelCfg, "botId", "secret");
-}
+function hasCredentialPair(channelCfg: ConfigRecord, firstKey: string, secondKey: string): boolean {
+  if (hasNonEmptyString(channelCfg[firstKey]) && hasNonEmptyString(channelCfg[secondKey])) {
+    return true;
+  }
+  const accountCfg = getPreferredAccountConfig(channelCfg);
+  return Boolean(
+    accountCfg &&
+      hasNonEmptyString(accountCfg[firstKey]) &&
+      hasNonEmptyString(accountCfg[secondKey])
+  );
+}
+
+function hasTokenPair(channelCfg: ConfigRecord): boolean {
+  return hasCredentialPair(channelCfg, "token", "encodingAESKey");
+}
+
+function hasWecomWsCredentialPair(channelCfg: ConfigRecord): boolean {
+  return hasCredentialPair(channelCfg, "botId", "secret");
+}
 
 function isChannelConfigured(cfg: ConfigRoot, channelId: ChannelId): boolean {
   const channelCfg = getChannelConfig(cfg, channelId);
@@ -329,15 +332,22 @@ function isChannelConfigured(cfg: ConfigRoot, channelId: ChannelId): boolean {
       return hasNonEmptyString(channelCfg.clientId) && hasNonEmptyString(channelCfg.clientSecret);
     case "feishu-china":
       return hasNonEmptyString(channelCfg.appId) && hasNonEmptyString(channelCfg.appSecret);
-    case "qqbot":
-      return hasNonEmptyString(channelCfg.appId) && hasNonEmptyString(channelCfg.clientSecret);
-    case "wecom":
-      return hasWecomWsCredentialPair(channelCfg);
-    case "wecom-app":
-      return hasTokenPair(channelCfg);
-    default:
-      return false;
-  }
+    case "qqbot":
+      return hasNonEmptyString(channelCfg.appId) && hasNonEmptyString(channelCfg.clientSecret);
+    case "wecom":
+      return hasWecomWsCredentialPair(channelCfg);
+    case "wecom-app":
+      return hasTokenPair(channelCfg);
+    case "wecom-kf":
+      return (
+        hasNonEmptyString(channelCfg.corpId) &&
+        hasNonEmptyString(channelCfg.corpSecret) &&
+        hasNonEmptyString(channelCfg.token) &&
+        hasNonEmptyString(channelCfg.encodingAESKey)
+      );
+    default:
+      return false;
+  }
 }
 
 function withConfiguredSuffix(cfg: ConfigRoot, channelId: ChannelId): string {
@@ -464,10 +474,10 @@ class SetupPrompter {
   }
 }
 
-async function configureDingtalk(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
-  section("配置 DingTalk（钉钉）");
-  showGuideLink("dingtalk");
-  const existing = getChannelConfig(cfg, "dingtalk");
+async function configureDingtalk(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
+  section("配置 DingTalk（钉钉）");
+  showGuideLink("dingtalk");
+  const existing = getChannelConfig(cfg, "dingtalk");
 
   const clientId = await prompter.askText({
     label: "DingTalk clientId（AppKey）",
@@ -479,30 +489,30 @@ async function configureDingtalk(prompter: SetupPrompter, cfg: ConfigRoot): Prom
     existingValue: toTrimmedString(existing.clientSecret),
     required: true,
   });
-  const enableAICard = await prompter.askConfirm(
-    "启用 AI Card 流式回复（推荐关闭，使用非流式）",
-    toBoolean(existing.enableAICard, false)
-  );
-  const patch: ConfigRecord = {
-    clientId,
-    clientSecret,
-    enableAICard,
-  };
-
-  if (enableAICard) {
-    const gatewayToken = await prompter.askSecret({
-      label: "OpenClaw Gateway Token（流式输出必需；留空则使用全局 gateway.auth.token）",
-      existingValue: toTrimmedString(existing.gatewayToken) ?? getGatewayAuthToken(cfg),
-      required: false,
-    });
-
-    if (gatewayToken.trim()) {
-      patch.gatewayToken = gatewayToken;
-    }
-  }
-
-  return mergeChannelConfig(cfg, "dingtalk", patch);
-}
+  const enableAICard = await prompter.askConfirm(
+    "启用 AI Card 流式回复（推荐关闭，使用非流式）",
+    toBoolean(existing.enableAICard, false)
+  );
+  const patch: ConfigRecord = {
+    clientId,
+    clientSecret,
+    enableAICard,
+  };
+
+  if (enableAICard) {
+    const gatewayToken = await prompter.askSecret({
+      label: "OpenClaw Gateway Token（流式输出必需；留空则使用全局 gateway.auth.token）",
+      existingValue: toTrimmedString(existing.gatewayToken) ?? getGatewayAuthToken(cfg),
+      required: false,
+    });
+
+    if (gatewayToken.trim()) {
+      patch.gatewayToken = gatewayToken;
+    }
+  }
+
+  return mergeChannelConfig(cfg, "dingtalk", patch);
+}
 
 async function configureFeishu(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
   section("配置 Feishu（飞书）");
@@ -530,31 +540,31 @@ async function configureFeishu(prompter: SetupPrompter, cfg: ConfigRoot): Promis
   });
 }
 
-async function configureWecom(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
-  section("配置 WeCom（企业微信-智能机器人）");
-  showGuideLink("wecom");
-  const existing = getChannelConfig(cfg, "wecom");
-  clackNote("当前向导仅提供 WeCom ws 长连接配置。", "提示");
-
-  const botId = await prompter.askText({
-    label: "WeCom botId（ws 长连接）",
-    defaultValue: toTrimmedString(existing.botId),
-    required: true,
-  });
-  const secret = await prompter.askSecret({
-    label: "WeCom secret（ws 长连接）",
-    existingValue: toTrimmedString(existing.secret),
-    required: true,
-  });
-  return mergeChannelConfig(cfg, "wecom", {
-    mode: "ws",
-    botId,
-    secret,
-    webhookPath: undefined,
-    token: undefined,
-    encodingAESKey: undefined,
-  });
-}
+async function configureWecom(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
+  section("配置 WeCom（企业微信-智能机器人）");
+  showGuideLink("wecom");
+  const existing = getChannelConfig(cfg, "wecom");
+  clackNote("当前向导仅提供 WeCom ws 长连接配置。", "提示");
+
+  const botId = await prompter.askText({
+    label: "WeCom botId（ws 长连接）",
+    defaultValue: toTrimmedString(existing.botId),
+    required: true,
+  });
+  const secret = await prompter.askSecret({
+    label: "WeCom secret（ws 长连接）",
+    existingValue: toTrimmedString(existing.secret),
+    required: true,
+  });
+  return mergeChannelConfig(cfg, "wecom", {
+    mode: "ws",
+    botId,
+    secret,
+    webhookPath: undefined,
+    token: undefined,
+    encodingAESKey: undefined,
+  });
+}
 
 async function configureWecomApp(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
   section("配置 WeCom App（自建应用-可接入微信）");
@@ -638,6 +648,58 @@ async function configureWecomApp(prompter: SetupPrompter, cfg: ConfigRoot): Prom
   return mergeChannelConfig(cfg, "wecom-app", patch);
 }
 
+async function configureWecomKf(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
+  section("配置 WeCom KF（微信客服）");
+  showGuideLink("wecom-kf");
+  const existing = getChannelConfig(cfg, "wecom-kf");
+
+  const webhookPath = await prompter.askText({
+    label: "Webhook 路径（默认 /wecom-kf）",
+    defaultValue: toTrimmedString(existing.webhookPath) ?? "/wecom-kf",
+    required: true,
+  });
+  const token = await prompter.askSecret({
+    label: "微信客服回调 Token",
+    existingValue: toTrimmedString(existing.token),
+    required: true,
+  });
+  const encodingAESKey = await prompter.askSecret({
+    label: "微信客服回调 EncodingAESKey",
+    existingValue: toTrimmedString(existing.encodingAESKey),
+    required: true,
+  });
+  const corpId = await prompter.askText({
+    label: "corpId",
+    defaultValue: toTrimmedString(existing.corpId),
+    required: true,
+  });
+  const corpSecret = await prompter.askSecret({
+    label: "微信客服 Secret",
+    existingValue: toTrimmedString(existing.corpSecret),
+    required: true,
+  });
+  const openKfId = await prompter.askText({
+    label: "open_kfid",
+    defaultValue: toTrimmedString(existing.openKfId),
+    required: true,
+  });
+  const welcomeText = await prompter.askText({
+    label: "欢迎语（可选）",
+    defaultValue: toTrimmedString(existing.welcomeText),
+    required: false,
+  });
+
+  return mergeChannelConfig(cfg, "wecom-kf", {
+    webhookPath,
+    token,
+    encodingAESKey,
+    corpId,
+    corpSecret,
+    openKfId,
+    welcomeText: welcomeText || undefined,
+  });
+}
+
 async function configureQQBot(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
   section("配置 QQBot（QQ 机器人）");
   showGuideLink("qqbot");
@@ -702,6 +764,8 @@ async function configureSingleChannel(
       return configureWecom(prompter, cfg);
     case "wecom-app":
       return configureWecomApp(prompter, cfg);
+    case "wecom-kf":
+      return configureWecomKf(prompter, cfg);
     case "qqbot":
       return configureQQBot(prompter, cfg);
     default:

package/src/cli/index.ts

@@ -1,2 +1,2 @@
-export * from "./china-setup.js";
-export * from "./install-hint.js";
+export * from "./china-setup.js";
+export * from "./install-hint.js";

package/src/cli/install-hint.ts

@@ -23,6 +23,7 @@ const SUPPORTED_CHANNELS: readonly ChannelId[] = [
   "feishu-china",
   "wecom",
   "wecom-app",
+  "wecom-kf",
   "qqbot",
 ];
 const CHINA_INSTALL_HINT_SHOWN_KEY = Symbol.for("@openclaw-china/china-install-hint-shown");

package/src/cron/index.ts

@@ -1,19 +1,19 @@
-const CRON_HIDDEN_PROMPT = `
-When creating or updating a cron task, always store a fixed delivery target in the job itself.
-- Use the built-in cron tool (action=add/update). Do not run shell commands.
-- Must use sessionTarget="isolated" for reminder jobs.
-- payload.kind="agentTurn"
-- payload.message must be plain user-visible reminder text only.
-- You must encode runtime guardrails directly into payload.message so the cron run can follow them without extra context.
-- Runtime guardrails to encode in payload.message:
-  - return plain text only
-  - never call any tool
-  - never call the message tool
-  - never send manually; delivery is handled by cron delivery settings
-- Do not include tool directives, "NO_REPLY", or heartbeat markers in payload.message.
-- Job name is never a message target.
-- During cron run, must return plain text only and never call the message tool.
-- Use top-level delivery with announce mode:
+const CRON_HIDDEN_PROMPT = `
+When creating or updating a cron task, always store a fixed delivery target in the job itself.
+- Use the built-in cron tool (action=add/update). Do not run shell commands.
+- Must use sessionTarget="isolated" for reminder jobs.
+- payload.kind="agentTurn"
+- payload.message must be plain user-visible reminder text only.
+- You must encode runtime guardrails directly into payload.message so the cron run can follow them without extra context.
+- Runtime guardrails to encode in payload.message:
+  - return plain text only
+  - never call any tool
+  - never call the message tool
+  - never send manually; delivery is handled by cron delivery settings
+- Do not include tool directives, "NO_REPLY", or heartbeat markers in payload.message.
+- Job name is never a message target.
+- During cron run, must return plain text only and never call the message tool.
+- Use top-level delivery with announce mode:
   delivery.mode="announce"
   delivery.channel=<OriginatingChannel> (example: "qqbot")
   delivery.to=<OriginatingTo> (examples: "user:<openid>" / "group:<group_openid>")