@openclaw-china/shared 0.1.35 → 0.1.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openclaw-china/shared",
-  "version": "0.1.35",
+  "version": "0.1.37",
   "type": "module",
   "exports": {
     ".": "./src/index.ts"

package/src/cli/china-setup.ts

@@ -38,50 +38,50 @@ type RegisterCliLike = (
 
 type WriteConfigLike = (cfg: ConfigRoot) => Promise<void>;
 
-type ApiLike = {
-  registerCli?: RegisterCliLike;
-  runtime?: unknown;
-  logger?: LoggerLike;
-};
+type ApiLike = {
+  registerCli?: RegisterCliLike;
+  runtime?: unknown;
+  logger?: LoggerLike;
+};
 
 type ConfigRecord = Record<string, unknown>;
 
-type ConfigRoot = {
-  channels?: ConfigRecord;
-  [key: string]: unknown;
-};
-
-export type ChannelId = "dingtalk" | "feishu-china" | "wecom" | "wecom-app" | "qqbot";
-
-export type RegisterChinaSetupCliOptions = {
-  channels?: readonly ChannelId[];
-};
-
-type Option<T extends string> = {
-  key?: string;
-  value: T;
-  label: string;
-};
-
-const PROJECT_REPO = "https://github.com/BytePioneer-AI/moltbot-china";
-const GUIDES_BASE = "https://github.com/BytePioneer-AI/openclaw-china/tree/main/doc/guides";
-const OPENCLAW_HOME = join(homedir(), ".openclaw");
-const DEFAULT_PLUGIN_PATH = join(OPENCLAW_HOME, "extensions");
-const LEGACY_PLUGIN_PATH = join(OPENCLAW_HOME, "plugins");
-const CONFIG_FILE_PATH = join(OPENCLAW_HOME, "openclaw.json");
-const ANSI_RESET = "\u001b[0m";
-const ANSI_LINK = "\u001b[1;4;96m";
-const ANSI_BORDER = "\u001b[92m";
-const CHANNEL_ORDER: readonly ChannelId[] = [
-  "dingtalk",
-  "qqbot",
-  "wecom",
-  "wecom-app",
-  "feishu-china",
-];
-const CHANNEL_DISPLAY_LABELS: Record<ChannelId, string> = {
-  dingtalk: "DingTalk（钉钉）",
-  "feishu-china": "Feishu（飞书）",
+type ConfigRoot = {
+  channels?: ConfigRecord;
+  [key: string]: unknown;
+};
+
+export type ChannelId = "dingtalk" | "feishu-china" | "wecom" | "wecom-app" | "qqbot";
+
+export type RegisterChinaSetupCliOptions = {
+  channels?: readonly ChannelId[];
+};
+
+type Option<T extends string> = {
+  key?: string;
+  value: T;
+  label: string;
+};
+
+const PROJECT_REPO = "https://github.com/BytePioneer-AI/openclaw-china";
+const GUIDES_BASE = "https://github.com/BytePioneer-AI/openclaw-china/tree/main/doc/guides";
+const OPENCLAW_HOME = join(homedir(), ".openclaw");
+const DEFAULT_PLUGIN_PATH = join(OPENCLAW_HOME, "extensions");
+const LEGACY_PLUGIN_PATH = join(OPENCLAW_HOME, "plugins");
+const CONFIG_FILE_PATH = join(OPENCLAW_HOME, "openclaw.json");
+const ANSI_RESET = "\u001b[0m";
+const ANSI_LINK = "\u001b[1;4;96m";
+const ANSI_BORDER = "\u001b[92m";
+const CHANNEL_ORDER: readonly ChannelId[] = [
+  "dingtalk",
+  "qqbot",
+  "wecom",
+  "wecom-app",
+  "feishu-china",
+];
+const CHANNEL_DISPLAY_LABELS: Record<ChannelId, string> = {
+  dingtalk: "DingTalk（钉钉）",
+  "feishu-china": "Feishu（飞书）",
   wecom: "WeCom（企业微信-智能机器人）",
   "wecom-app": "WeCom App（自建应用-可接入微信）",
   qqbot: "QQBot（QQ 机器人）",
@@ -90,71 +90,71 @@ const CHANNEL_GUIDE_LINKS: Record<ChannelId, string> = {
   dingtalk: `${GUIDES_BASE}/dingtalk/configuration.md`,
   "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`,
-  qqbot: `${GUIDES_BASE}/qqbot/configuration.md`,
-};
-const CHINA_CLI_STATE_KEY = Symbol.for("@openclaw-china/china-cli-state");
-
-type ChinaCliState = {
-  channels: Set<ChannelId>;
-  cliRegistered: boolean;
-};
-
-class PromptCancelledError extends Error {
-  constructor() {
-    super("prompt-cancelled");
-  }
-}
-
-function isChannelId(value: unknown): value is ChannelId {
-  return typeof value === "string" && CHANNEL_ORDER.includes(value as ChannelId);
-}
-
-function getChinaCliState(): ChinaCliState {
-  const root = globalThis as Record<PropertyKey, unknown>;
-  const cached = root[CHINA_CLI_STATE_KEY];
-
-  if (isRecord(cached)) {
-    const channels = cached.channels;
-    const cliRegistered = cached.cliRegistered;
-    if (channels instanceof Set && typeof cliRegistered === "boolean") {
-      return {
-        channels: channels as Set<ChannelId>,
-        cliRegistered,
-      };
-    }
-  }
-
-  const created: ChinaCliState = {
-    channels: new Set<ChannelId>(),
-    cliRegistered: false,
-  };
-  root[CHINA_CLI_STATE_KEY] = created;
-  return created;
-}
-
-function normalizeChannels(channels?: readonly ChannelId[]): ChannelId[] {
-  const selected = channels && channels.length > 0 ? channels : CHANNEL_ORDER;
-  const unique = new Set<ChannelId>();
-  for (const channelId of selected) {
-    if (isChannelId(channelId)) {
-      unique.add(channelId);
-    }
-  }
-  return CHANNEL_ORDER.filter((channelId) => unique.has(channelId));
-}
-
-function getInstalledChannels(state: ChinaCliState): ChannelId[] {
-  return CHANNEL_ORDER.filter((channelId) => state.channels.has(channelId));
-}
-
-function guardCancel<T>(value: T | symbol): T {
-  if (isCancel(value)) {
-    clackCancel("已取消配置。");
-    throw new PromptCancelledError();
-  }
-  return value as T;
-}
+  "wecom-app": `${GUIDES_BASE}/wecom-app/configuration.md`,
+  qqbot: `${GUIDES_BASE}/qqbot/configuration.md`,
+};
+const CHINA_CLI_STATE_KEY = Symbol.for("@openclaw-china/china-cli-state");
+
+type ChinaCliState = {
+  channels: Set<ChannelId>;
+  cliRegistered: boolean;
+};
+
+class PromptCancelledError extends Error {
+  constructor() {
+    super("prompt-cancelled");
+  }
+}
+
+function isChannelId(value: unknown): value is ChannelId {
+  return typeof value === "string" && CHANNEL_ORDER.includes(value as ChannelId);
+}
+
+function getChinaCliState(): ChinaCliState {
+  const root = globalThis as Record<PropertyKey, unknown>;
+  const cached = root[CHINA_CLI_STATE_KEY];
+
+  if (isRecord(cached)) {
+    const channels = cached.channels;
+    const cliRegistered = cached.cliRegistered;
+    if (channels instanceof Set && typeof cliRegistered === "boolean") {
+      return {
+        channels: channels as Set<ChannelId>,
+        cliRegistered,
+      };
+    }
+  }
+
+  const created: ChinaCliState = {
+    channels: new Set<ChannelId>(),
+    cliRegistered: false,
+  };
+  root[CHINA_CLI_STATE_KEY] = created;
+  return created;
+}
+
+function normalizeChannels(channels?: readonly ChannelId[]): ChannelId[] {
+  const selected = channels && channels.length > 0 ? channels : CHANNEL_ORDER;
+  const unique = new Set<ChannelId>();
+  for (const channelId of selected) {
+    if (isChannelId(channelId)) {
+      unique.add(channelId);
+    }
+  }
+  return CHANNEL_ORDER.filter((channelId) => unique.has(channelId));
+}
+
+function getInstalledChannels(state: ChinaCliState): ChannelId[] {
+  return CHANNEL_ORDER.filter((channelId) => state.channels.has(channelId));
+}
+
+function guardCancel<T>(value: T | symbol): T {
+  if (isCancel(value)) {
+    clackCancel("已取消配置。");
+    throw new PromptCancelledError();
+  }
+  return value as T;
+}
 
 function warn(text: string): void {
   output.write(`\n[warn] ${text}\n`);
@@ -174,25 +174,25 @@ function resolvePluginPath(): string {
   return DEFAULT_PLUGIN_PATH;
 }
 
-function renderReadyMessage(): string {
-  return [
-    `${ANSI_BORDER}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${ANSI_RESET}`,
-    "  OpenClaw China Channels 已就绪!",
-    `${ANSI_BORDER}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${ANSI_RESET}`,
+function renderReadyMessage(): string {
+  return [
+    `${ANSI_BORDER}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${ANSI_RESET}`,
+    "  OpenClaw China Channels 已就绪!",
+    `${ANSI_BORDER}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${ANSI_RESET}`,
     "",
     "插件路径:",
     `  ${resolvePluginPath()}`,
     "",
-    "配置文件:",
-    `  ${CONFIG_FILE_PATH}`,
-    "",
-    "更新插件:",
-    "  openclaw plugins update <plugin-id>",
-    "",
-    "项目仓库:",
-    `  ${ANSI_LINK}${PROJECT_REPO}${ANSI_RESET}`,
+    "配置文件:",
+    `  ${CONFIG_FILE_PATH}`,
     "",
-    "⭐ 如果这个项目对你有帮助，请给我们一个 Star！⭐",
+    "更新插件:",
+    "  openclaw plugins update <plugin-id>",
+    "",
+    "项目仓库:",
+    `  ${ANSI_LINK}${PROJECT_REPO}${ANSI_RESET}`,
+    "",
+    "⭐ 如果这个项目对你有帮助，请给我们一个 Star！⭐",
     "",
     "下一步:",
     "  openclaw gateway --port 18789 --verbose",
@@ -209,23 +209,23 @@ function showGuideLink(channelId: ChannelId): void {
   clackNote(`配置文档：${url}`, "Docs");
 }
 
-function isRecord(value: unknown): value is ConfigRecord {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function resolveWriteConfig(runtime: unknown): WriteConfigLike | undefined {
-  if (!isRecord(runtime)) {
-    return undefined;
-  }
-  const config = runtime.config;
-  if (!isRecord(config)) {
-    return undefined;
-  }
-  if (typeof config.writeConfigFile !== "function") {
-    return undefined;
-  }
-  return config.writeConfigFile as WriteConfigLike;
-}
+function isRecord(value: unknown): value is ConfigRecord {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+function resolveWriteConfig(runtime: unknown): WriteConfigLike | undefined {
+  if (!isRecord(runtime)) {
+    return undefined;
+  }
+  const config = runtime.config;
+  if (!isRecord(config)) {
+    return undefined;
+  }
+  if (typeof config.writeConfigFile !== "function") {
+    return undefined;
+  }
+  return config.writeConfigFile as WriteConfigLike;
+}
 
 function isCommandLike(value: unknown): value is CommandLike {
   if (!isRecord(value)) {
@@ -424,28 +424,28 @@ class SetupPrompter {
     }
   }
 
-  async askSelect<T extends string>(
-    message: string,
-    options: Array<Option<T>>,
-    defaultValue: T
-  ): Promise<T> {
-    const initial = options.some((opt) => opt.value === defaultValue)
-      ? defaultValue
-      : options[0]?.value;
-    const selectOptions = options.map((option) => ({
-      value: option.value,
-      label: option.label,
-    })) as Parameters<typeof clackSelect<T>>[0]["options"];
-
-    return guardCancel(
-      await clackSelect<T>({
-        message,
-        options: selectOptions,
-        initialValue: initial,
-      })
-    );
-  }
-}
+  async askSelect<T extends string>(
+    message: string,
+    options: Array<Option<T>>,
+    defaultValue: T
+  ): Promise<T> {
+    const initial = options.some((opt) => opt.value === defaultValue)
+      ? defaultValue
+      : options[0]?.value;
+    const selectOptions = options.map((option) => ({
+      value: option.value,
+      label: option.label,
+    })) as Parameters<typeof clackSelect<T>>[0]["options"];
+
+    return guardCancel(
+      await clackSelect<T>({
+        message,
+        options: selectOptions,
+        initialValue: initial,
+      })
+    );
+  }
+}
 
 async function configureDingtalk(prompter: SetupPrompter, cfg: ConfigRoot): Promise<ConfigRoot> {
   section("配置 DingTalk（钉钉）");
@@ -531,6 +531,7 @@ async function configureWecomApp(prompter: SetupPrompter, cfg: ConfigRoot): Prom
   section("配置 WeCom App（自建应用-可接入微信）");
   showGuideLink("wecom-app");
   const existing = getChannelConfig(cfg, "wecom-app");
+  const existingAsr = isRecord(existing.asr) ? existing.asr : {};
 
   const webhookPath = await prompter.askText({
     label: "Webhook 路径（需与企业微信后台配置一致，默认 /wecom-app）",
@@ -572,6 +573,38 @@ async function configureWecomApp(prompter: SetupPrompter, cfg: ConfigRoot): Prom
   patch.corpId = corpId;
   patch.corpSecret = corpSecret;
   patch.agentId = agentId;
+  const asrEnabled = await prompter.askConfirm(
+    "启用 ASR（支持入站语音自动转文字）",
+    toBoolean(existingAsr.enabled, false)
+  );
+  const asr: ConfigRecord = {
+    enabled: asrEnabled,
+  };
+  if (asrEnabled) {
+    clackNote(
+      [
+        "ASR 开通方式请查看配置文档：步骤七（可选）：开启语音转文本（ASR）",
+        "https://github.com/BytePioneer-AI/openclaw-china/blob/main/doc/guides/wecom-app/configuration.md",
+      ].join("\n"),
+      "提示"
+    );
+    asr.appId = await prompter.askText({
+      label: "ASR appId（腾讯云）",
+      defaultValue: toTrimmedString(existingAsr.appId),
+      required: true,
+    });
+    asr.secretId = await prompter.askSecret({
+      label: "ASR secretId（腾讯云）",
+      existingValue: toTrimmedString(existingAsr.secretId),
+      required: true,
+    });
+    asr.secretKey = await prompter.askSecret({
+      label: "ASR secretKey（腾讯云）",
+      existingValue: toTrimmedString(existingAsr.secretKey),
+      required: true,
+    });
+  }
+  patch.asr = asr;
 
   return mergeChannelConfig(cfg, "wecom-app", patch);
 }
@@ -580,6 +613,7 @@ async function configureQQBot(prompter: SetupPrompter, cfg: ConfigRoot): Promise
   section("配置 QQBot（QQ 机器人）");
   showGuideLink("qqbot");
   const existing = getChannelConfig(cfg, "qqbot");
+  const existingAsr = isRecord(existing.asr) ? existing.asr : {};
 
   const appId = await prompter.askText({
     label: "QQBot appId",
@@ -591,20 +625,46 @@ async function configureQQBot(prompter: SetupPrompter, cfg: ConfigRoot): Promise
     existingValue: toTrimmedString(existing.clientSecret),
     required: true,
   });
+  clackNote(
+    "QQ 的 Markdown 体验很好，但需要先申请开通，详情请查看配置文档。",
+    "提示"
+  );
   const markdownSupport = await prompter.askConfirm(
     "启用 Markdown 支持",
     toBoolean(existing.markdownSupport, false)
   );
-  const replyFinalOnly = await prompter.askConfirm(
-    "仅发送最终回复（关闭流式分片）",
-    toBoolean(existing.replyFinalOnly, false)
+  const asrEnabled = await prompter.askConfirm(
+    "启用 ASR（支持入站语音自动转文字）",
+    toBoolean(existingAsr.enabled, false)
   );
 
+  const asr: ConfigRecord = {
+    enabled: asrEnabled,
+  };
+  if (asrEnabled) {
+    clackNote("ASR 开通方式详情请查看配置文档。", "提示");
+    asr.appId = await prompter.askText({
+      label: "ASR appId（腾讯云）",
+      defaultValue: toTrimmedString(existingAsr.appId),
+      required: true,
+    });
+    asr.secretId = await prompter.askSecret({
+      label: "ASR secretId（腾讯云）",
+      existingValue: toTrimmedString(existingAsr.secretId),
+      required: true,
+    });
+    asr.secretKey = await prompter.askSecret({
+      label: "ASR secretKey（腾讯云）",
+      existingValue: toTrimmedString(existingAsr.secretKey),
+      required: true,
+    });
+  }
+
   return mergeChannelConfig(cfg, "qqbot", {
     appId,
     clientSecret,
     markdownSupport,
-    replyFinalOnly,
+    asr,
   });
 }
 
@@ -629,16 +689,16 @@ async function configureSingleChannel(
   }
 }
 
-async function runChinaSetup(params: {
-  initialConfig: ConfigRoot;
-  writeConfig?: WriteConfigLike;
-  logger: LoggerLike;
-  availableChannels: readonly ChannelId[];
-}): Promise<void> {
-  if (!input.isTTY || !output.isTTY) {
-    params.logger.error?.("交互式配置需要在 TTY 终端中运行。");
-    return;
-  }
+async function runChinaSetup(params: {
+  initialConfig: ConfigRoot;
+  writeConfig?: WriteConfigLike;
+  logger: LoggerLike;
+  availableChannels: readonly ChannelId[];
+}): Promise<void> {
+  if (!input.isTTY || !output.isTTY) {
+    params.logger.error?.("交互式配置需要在 TTY 终端中运行。");
+    return;
+  }
 
   const prompter = new SetupPrompter();
   const touched = new Set<ChannelId>();
@@ -646,37 +706,37 @@ async function runChinaSetup(params: {
 
   try {
     clackIntro("OpenClaw China 配置向导");
-    clackNote(
-      [
-        "使用方向键选择，按 Enter 确认。",
-        `项目仓库：${ANSI_LINK}${PROJECT_REPO}${ANSI_RESET}`,
-      ].join("\n"),
-      "欢迎"
-    );
-
-    if (params.availableChannels.length === 0) {
-      params.logger.error?.("未检测到可配置的 China 渠道插件。");
-      return;
-    }
-
-    const channelOptions = params.availableChannels.map((channelId, index) => ({
-      key: index === 0 ? "recommended" : "",
-      value: channelId,
-      label: withConfiguredSuffix(next, channelId),
-    }));
-    const defaultChannel = channelOptions[0]?.value ?? "save";
-
-    let continueLoop = true;
-    while (continueLoop) {
-      const selected = await prompter.askSelect<ChannelId | "save" | "cancel">(
-        "请选择要配置的渠道",
-        [
-          ...channelOptions,
-          { key: "", value: "save", label: "保存并退出" },
-          { key: "", value: "cancel", label: "不保存并退出" },
-        ],
-        defaultChannel
-      );
+    clackNote(
+      [
+        "使用方向键选择，按 Enter 确认。",
+        `项目仓库：${ANSI_LINK}${PROJECT_REPO}${ANSI_RESET}`,
+      ].join("\n"),
+      "欢迎"
+    );
+
+    if (params.availableChannels.length === 0) {
+      params.logger.error?.("未检测到可配置的 China 渠道插件。");
+      return;
+    }
+
+    const channelOptions = params.availableChannels.map((channelId, index) => ({
+      key: index === 0 ? "recommended" : "",
+      value: channelId,
+      label: withConfiguredSuffix(next, channelId),
+    }));
+    const defaultChannel = channelOptions[0]?.value ?? "save";
+
+    let continueLoop = true;
+    while (continueLoop) {
+      const selected = await prompter.askSelect<ChannelId | "save" | "cancel">(
+        "请选择要配置的渠道",
+        [
+          ...channelOptions,
+          { key: "", value: "save", label: "保存并退出" },
+          { key: "", value: "cancel", label: "不保存并退出" },
+        ],
+        defaultChannel
+      );
 
       if (selected === "cancel") {
         clackCancel("已取消，未写入任何配置。");
@@ -722,21 +782,21 @@ async function runChinaSetup(params: {
   }
 }
 
-export function registerChinaSetupCli(api: ApiLike, opts?: RegisterChinaSetupCliOptions): void {
-  const state = getChinaCliState();
-  for (const channelId of normalizeChannels(opts?.channels)) {
-    state.channels.add(channelId);
-  }
-
-  if (state.cliRegistered || typeof api.registerCli !== "function") {
-    return;
-  }
-  state.cliRegistered = true;
-
-  const writeConfig = resolveWriteConfig(api.runtime);
-  const fallbackLogger: LoggerLike = {
-    info: (message) => output.write(`${message}\n`),
-    warn: (message) => warn(message),
+export function registerChinaSetupCli(api: ApiLike, opts?: RegisterChinaSetupCliOptions): void {
+  const state = getChinaCliState();
+  for (const channelId of normalizeChannels(opts?.channels)) {
+    state.channels.add(channelId);
+  }
+
+  if (state.cliRegistered || typeof api.registerCli !== "function") {
+    return;
+  }
+  state.cliRegistered = true;
+
+  const writeConfig = resolveWriteConfig(api.runtime);
+  const fallbackLogger: LoggerLike = {
+    info: (message) => output.write(`${message}\n`),
+    warn: (message) => warn(message),
     error: (message) => warn(message),
   };
 
@@ -752,30 +812,30 @@ export function registerChinaSetupCli(api: ApiLike, opts?: RegisterChinaSetupCli
 
       root
         .command("setup")
-        .description("中国渠道交互式配置向导")
-        .action(async () => {
-          const logger = ctx.logger ?? api.logger ?? fallbackLogger;
-          const availableChannels = getInstalledChannels(state);
-          await runChinaSetup({
-            initialConfig: isRecord(ctx.config) ? (ctx.config as ConfigRoot) : {},
-            writeConfig,
-            logger,
-            availableChannels,
-          });
-        });
-
-      root.command("about").description("显示项目信息").action(() => {
-        const installed = getInstalledChannels(state);
-        clackIntro("OpenClaw China 渠道插件");
-        clackNote(
-          installed.length > 0
-            ? `当前已安装渠道：${installed.map((channelId) => CHANNEL_DISPLAY_LABELS[channelId]).join("、")}`
-            : "OpenClaw China 渠道插件",
-          "关于"
-        );
-        clackOutro(PROJECT_REPO);
-        showReadyMessage();
-      });
+        .description("中国渠道交互式配置向导")
+        .action(async () => {
+          const logger = ctx.logger ?? api.logger ?? fallbackLogger;
+          const availableChannels = getInstalledChannels(state);
+          await runChinaSetup({
+            initialConfig: isRecord(ctx.config) ? (ctx.config as ConfigRoot) : {},
+            writeConfig,
+            logger,
+            availableChannels,
+          });
+        });
+
+      root.command("about").description("显示项目信息").action(() => {
+        const installed = getInstalledChannels(state);
+        clackIntro("OpenClaw China 渠道插件");
+        clackNote(
+          installed.length > 0
+            ? `当前已安装渠道：${installed.map((channelId) => CHANNEL_DISPLAY_LABELS[channelId]).join("、")}`
+            : "OpenClaw China 渠道插件",
+          "关于"
+        );
+        clackOutro(PROJECT_REPO);
+        showReadyMessage();
+      });
     },
     { commands: ["china"] }
   );

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";