@yanhaidao/wecom 2.4.160 → 2.5.110

package/src/types/config.ts

@@ -1,114 +0,0 @@
-export type WecomDmPolicy = "open" | "pairing" | "allowlist" | "disabled";
-export type WecomBotPrimaryTransport = "ws" | "webhook";
-
-export type WecomDmConfig = {
-  policy?: WecomDmPolicy;
-  allowFrom?: Array<string | number>;
-};
-
-export type WecomMediaConfig = {
-  tempDir?: string;
-  retentionHours?: number;
-  cleanupOnStart?: boolean;
-  maxBytes?: number;
-  downloadTimeoutMs?: number;
-  localRoots?: string[];
-};
-
-export type WecomNetworkConfig = {
-  egressProxyUrl?: string;
-  timeoutMs?: number;
-  mediaDownloadTimeoutMs?: number;
-};
-
-export type WecomRoutingConfig = {
-  failClosedOnDefaultRoute?: boolean;
-};
-
-export type WecomBotWsConfig = {
-  botId: string;
-  secret: string;
-};
-
-export type WecomBotWebhookConfig = {
-  token: string;
-  encodingAESKey: string;
-  receiveId?: string;
-};
-
-export type WecomBotConfig = {
-  primaryTransport?: WecomBotPrimaryTransport;
-  streamPlaceholderContent?: string;
-  welcomeText?: string;
-  dm?: WecomDmConfig;
-  /**
-   * Deprecated compatibility fields kept only while old webhook helpers are
-   * being extracted into transport adapters.
-   */
-  aibotid?: string;
-  botIds?: string[];
-  ws?: WecomBotWsConfig;
-  webhook?: WecomBotWebhookConfig;
-};
-
-/**
- * 上下游企业配置
- * 根据企业微信文档，只需要配置下游企业的 CorpID 和 AgentID
- * 不需要下游企业的 agentSecret，使用主企业的 corpSecret 获取下游企业的 access_token
- */
-export type WecomUpstreamCorpConfig = {
-  corpId: string;
-  agentId: number;
-};
-
-export type WecomAgentConfig = {
-  corpId: string;
-  agentSecret?: string;
-  /**
-   * Deprecated compatibility alias for old configs.
-   * New configs should use `agentSecret`.
-   */
-  corpSecret?: string;
-  agentId?: number | string;
-  token: string;
-  encodingAESKey: string;
-  welcomeText?: string;
-  dm?: WecomDmConfig;
-  /**
-   * 上下游企业配置映射
-   * key: 配置名称（可自定义）
-   * value: 下游企业的 CorpID 和 AgentID
-   * 
-   * 注意：不需要配置 agentSecret，使用主企业的 corpSecret 获取下游企业的 access_token
-   */
-  upstreamCorps?: Record<string, WecomUpstreamCorpConfig>;
-};
-
-export type WecomDynamicAgentsConfig = {
-  enabled?: boolean;
-  dmCreateAgent?: boolean;
-  groupEnabled?: boolean;
-  adminUsers?: string[];
-};
-
-export type WecomAccountConfig = {
-  enabled?: boolean;
-  name?: string;
-  mediaMaxMb?: number;
-  bot?: WecomBotConfig;
-  agent?: WecomAgentConfig;
-};
-
-export type WecomConfig = {
-  enabled?: boolean;
-  mediaMaxMb?: number;
-  mediaDownloadTimeoutMs?: number;
-  bot?: WecomBotConfig;
-  agent?: WecomAgentConfig;
-  accounts?: Record<string, WecomAccountConfig>;
-  defaultAccount?: string;
-  media?: WecomMediaConfig;
-  network?: WecomNetworkConfig;
-  routing?: WecomRoutingConfig;
-  dynamicAgents?: WecomDynamicAgentsConfig;
-};

package/src/types/constants.ts

@@ -1,31 +0,0 @@
-export const WEBHOOK_PATHS = {
-  BOT: "/wecom/bot",
-  BOT_ALT: "/wecom",
-  AGENT: "/wecom/agent",
-  BOT_PLUGIN: "/plugins/wecom/bot",
-  AGENT_PLUGIN: "/plugins/wecom/agent",
-} as const;
-
-export const API_ENDPOINTS = {
-  GET_TOKEN: "https://qyapi.weixin.qq.com/cgi-bin/gettoken",
-  SEND_MESSAGE: "https://qyapi.weixin.qq.com/cgi-bin/message/send",
-  SEND_APPCHAT: "https://qyapi.weixin.qq.com/cgi-bin/appchat/send",
-  UPLOAD_MEDIA: "https://qyapi.weixin.qq.com/cgi-bin/media/upload",
-  DOWNLOAD_MEDIA: "https://qyapi.weixin.qq.com/cgi-bin/media/get",
-} as const;
-
-export const LIMITS = {
-  TEXT_MAX_BYTES: 20_480,
-  TOKEN_REFRESH_BUFFER_MS: 60_000,
-  REQUEST_TIMEOUT_MS: 15_000,
-  MAX_REQUEST_BODY_SIZE: 1024 * 1024,
-  BOT_WEBHOOK_PASSIVE_WINDOW_MS: 5_000,
-  BOT_WEBHOOK_RESPONSE_URL_TTL_MS: 60 * 60 * 1000,
-  BOT_STREAM_WINDOW_MS: 6 * 60 * 1000,
-  BOT_WS_HEARTBEAT_MS: 30_000,
-} as const;
-
-export const CRYPTO = {
-  PKCS7_BLOCK_SIZE: 32,
-  AES_KEY_LENGTH: 32,
-} as const;

package/src/types/events.ts

@@ -1,21 +0,0 @@
-import type { UnifiedInboundEvent } from "./runtime.js";
-
-export type BotWsFrameHeaders = {
-  req_id: string;
-  [key: string]: unknown;
-};
-
-export type BotWsFrame<T = unknown> = {
-  cmd?: string;
-  headers: BotWsFrameHeaders;
-  body?: T;
-  errcode?: number;
-  errmsg?: string;
-};
-
-export type AgentCallbackEnvelope = {
-  xml: string;
-  decrypted: Record<string, unknown>;
-};
-
-export type InboundEventMapper<T = unknown> = (payload: T) => UnifiedInboundEvent;

package/src/types/global.d.ts

@@ -1,9 +0,0 @@
-
-declare global {
-    var Buffer: any;
-    namespace NodeJS {
-        interface Timeout { }
-    }
-}
-
-export { };

package/src/types/index.ts

@@ -1,17 +0,0 @@
-export * from "./constants.js";
-export type * from "./config.js";
-export type * from "./account.js";
-export type * from "./events.js";
-export type * from "./runtime.js";
-export type {
-  WecomBotInboundBase,
-  WecomBotInboundText,
-  WecomBotInboundVoice,
-  WecomBotInboundStreamRefresh,
-  WecomBotInboundEvent,
-  WecomBotInboundMessage,
-  WecomAgentInboundMessage,
-  WecomInboundQuote,
-  WecomTemplateCard,
-  WecomOutboundMessage,
-} from "./message.js";

package/src/types/legacy-stream.ts

@@ -1,50 +0,0 @@
-import type { WecomBotInboundMessage as WecomInboundMessage } from "./message.js";
-import type { WecomWebhookTarget } from "./runtime-context.js";
-
-export type StreamState = {
-  streamId: string;
-  msgid?: string;
-  conversationKey?: string;
-  batchKey?: string;
-  userId?: string;
-  chatType?: "group" | "direct";
-  chatId?: string;
-  aibotid?: string;
-  taskKey?: string;
-  createdAt: number;
-  updatedAt: number;
-  started: boolean;
-  finished: boolean;
-  error?: string;
-  content: string;
-  images?: { base64: string; md5: string }[];
-  fallbackMode?: "media" | "timeout" | "error";
-  fallbackPromptSentAt?: number;
-  finalDeliveredAt?: number;
-  dmContent?: string;
-  agentMediaKeys?: string[];
-};
-
-export type PendingInbound = {
-  streamId: string;
-  conversationKey: string;
-  batchKey: string;
-  target: WecomWebhookTarget;
-  msg: WecomInboundMessage;
-  contents: string[];
-  media?: { buffer: Buffer; contentType: string; filename: string };
-  msgids: string[];
-  nonce: string;
-  timestamp: string;
-  timeout: ReturnType<typeof setTimeout> | null;
-  readyToFlush?: boolean;
-  createdAt: number;
-};
-
-export type ActiveReplyState = {
-  response_url: string;
-  proxyUrl?: string;
-  createdAt: number;
-  usedAt?: number;
-  lastError?: string;
-};

package/src/types/message.ts

@@ -1,189 +0,0 @@
-/**
- * WeCom 消息类型定义
- * Bot 和 Agent 模式共用
- */
-
-/**
- * Bot 模式入站消息基础结构 (JSON)
- */
-/**
- * **WecomBotInboundBase (Bot 入站消息基类)**
- * 
- * Bot 模式下 JSON 格式回调的基础字段。
- * @property msgid 消息 ID
- * @property aibotid 机器人 ID
- * @property chattype 会话类型: "single" | "group"
- * @property chatid 群聊 ID (仅群组时存在)
- * @property response_url 下行回复 URL (用于被动响应转主动推送)
- * @property from 发送者信息
- */
-export type WecomBotInboundBase = {
-    msgid?: string;
-    aibotid?: string;
-    chattype?: "single" | "group";
-    chatid?: string;
-    response_url?: string;
-    from?: { userid?: string; corpid?: string };
-    msgtype?: string;
-    /** 附件数量 (部分消息存在) */
-    attachment_count?: number;
-};
-
-export type WecomBotInboundText = WecomBotInboundBase & {
-    msgtype: "text";
-    text?: { content?: string };
-    quote?: WecomInboundQuote;
-};
-
-export type WecomBotInboundVoice = WecomBotInboundBase & {
-    msgtype: "voice";
-    voice?: { content?: string };
-    quote?: WecomInboundQuote;
-};
-
-export type WecomBotInboundStreamRefresh = WecomBotInboundBase & {
-    msgtype: "stream";
-    stream?: { id?: string };
-};
-
-export type WecomBotInboundEvent = WecomBotInboundBase & {
-    msgtype: "event";
-    create_time?: number;
-    event?: {
-        eventtype?: string;
-        [key: string]: unknown;
-    };
-};
-
-/**
- * **WecomInboundQuote (引用消息)**
- * 
- * 消息中引用的原始内容（如回复某条消息）。
- * 支持引用文本、图片、混合类型、语音、文件、视频等多种媒体类型。
- * 
- * 注意：引用中的媒体 URL 时效约 5 分钟，必须尽快下载和解密。
- */
-export type WecomInboundQuote = {
-    msgtype?: "text" | "image" | "mixed" | "voice" | "file" | "video";
-    /** 引用文本内容 */
-    text?: { content?: string };
-    /** 引用图片 URL，可包含出现时的加密密钥 aeskey */
-    image?: { url?: string; aeskey?: string };
-    /** 引用混合消息 (图文) */
-    mixed?: {
-        msg_item?: Array<{
-            msgtype: "text" | "image";
-            text?: { content?: string };
-            image?: { url?: string };
-        }>;
-    };
-    /** 引用语音 - 仅含转写文本，无 URL 需下载（按纯文本处理） */
-    voice?: { content?: string };
-    /** 引用文件 URL 及其加密密钥 */
-    file?: { url?: string; aeskey?: string };
-    /** 引用视频 URL 及其加密密钥（新增支持） */
-    video?: { url?: string; aeskey?: string };
-};
-
-export type WecomBotInboundMessage =
-    | WecomBotInboundText
-    | WecomBotInboundVoice
-    | WecomBotInboundStreamRefresh
-    | WecomBotInboundEvent
-    | (WecomBotInboundBase & { quote?: WecomInboundQuote } & Record<string, unknown>);
-
-/**
- * Agent 模式入站消息结构 (解析自 XML)
- */
-/**
- * **WecomAgentInboundMessage (Agent 入站消息)**
- * 
- * Agent 模式下解析自 XML 的扁平化消息结构。
- * 键名保持 PascalCase (如 `ToUserName`)。
- */
-export type WecomAgentInboundMessage = {
-    ToUserName?: string;
-    FromUserName?: string;
-    CreateTime?: number;
-    MsgType?: string;
-    MsgId?: string;
-    AgentID?: number;
-    // 文本消息
-    Content?: string;
-    // 图片消息
-    PicUrl?: string;
-    MediaId?: string;
-    // 文件消息
-    FileName?: string;
-    // 语音消息
-    Format?: string;
-    Recognition?: string;
-    // 视频消息
-    ThumbMediaId?: string;
-    // 位置消息
-    Location_X?: number;
-    Location_Y?: number;
-    Scale?: number;
-    Label?: string;
-    // 链接消息
-    Title?: string;
-    Description?: string;
-    Url?: string;
-    // 事件消息
-    Event?: string;
-    EventKey?: string;
-    // 群聊
-    ChatId?: string;
-};
-
-/**
- * 模板卡片类型
- */
-/**
- * **WecomTemplateCard (模板卡片)**
- * 
- * 复杂的交互式卡片结构。
- * @property card_type 卡片类型: "text_notice" | "news_notice" | "button_interaction" ...
- * @property source 来源信息
- * @property main_title 主标题
- * @property sub_title_text 副标题
- * @property horizontal_content_list 水平排列的键值列表
- * @property button_list 按钮列表
- */
-export type WecomTemplateCard = {
-    card_type: "text_notice" | "news_notice" | "button_interaction" | "vote_interaction" | "multiple_interaction";
-    source?: { icon_url?: string; desc?: string; desc_color?: number };
-    main_title?: { title?: string; desc?: string };
-    task_id?: string;
-    button_list?: Array<{ text: string; style?: number; key: string }>;
-    sub_title_text?: string;
-    horizontal_content_list?: Array<{
-        keyname: string;
-        value?: string;
-        type?: number;
-        url?: string;
-        userid?: string;
-    }>;
-    card_action?: { type: number; url?: string; appid?: string; pagepath?: string };
-    action_menu?: { desc: string; action_list: Array<{ text: string; key: string }> };
-    select_list?: Array<{
-        question_key: string;
-        title?: string;
-        selected_id?: string;
-        option_list: Array<{ id: string; text: string }>;
-    }>;
-    submit_button?: { text: string; key: string };
-    checkbox?: {
-        question_key: string;
-        option_list: Array<{ id: string; text: string; is_checked?: boolean }>;
-        mode?: number;
-    };
-};
-
-/**
- * 出站消息类型
- */
-export type WecomOutboundMessage =
-    | { msgtype: "text"; text: { content: string } }
-    | { msgtype: "markdown"; markdown: { content: string } }
-    | { msgtype: "template_card"; template_card: WecomTemplateCard };

package/src/types/runtime-context.ts

@@ -1,28 +0,0 @@
-import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk";
-
-import type { ResolvedBotAccount } from "./account.js";
-import type { RawFrameReference, TransportSessionPatch, WecomAuditCategory, WecomTransportKind } from "./runtime.js";
-
-export type WecomRuntimeEnv = {
-  log?: (message: string) => void;
-  error?: (message: string) => void;
-};
-
-export type WecomRuntimeAuditEvent = {
-  transport: WecomTransportKind;
-  category: WecomAuditCategory;
-  summary: string;
-  messageId?: string;
-  raw?: RawFrameReference;
-  error?: string;
-};
-
-export type WecomWebhookTarget = {
-  account: ResolvedBotAccount;
-  config: OpenClawConfig;
-  runtime: WecomRuntimeEnv;
-  core: PluginRuntime;
-  path: string;
-  touchTransportSession?: (patch: TransportSessionPatch) => void;
-  auditSink?: (event: WecomRuntimeAuditEvent) => void;
-};

package/src/types/runtime.ts

@@ -1,165 +0,0 @@
-import type { PluginRuntime } from "openclaw/plugin-sdk";
-
-import type { ResolvedAgentAccount, ResolvedBotAccount, ResolvedWecomAccount } from "./account.js";
-
-export type WecomCapabilityKind = "bot" | "agent";
-export type WecomTransportKind = "bot-ws" | "bot-webhook" | "agent-callback" | "agent-api";
-export type WecomAuditCategory =
-  | "inbound"
-  | "duplicate-inbound"
-  | "duplicate-reply"
-  | "owner-drift"
-  | "ws-kicked"
-  | "media-decrypt-failed"
-  | "fallback-delivery-failed"
-  | "runtime-error";
-export type WecomRuntimeHealth = "idle" | "healthy" | "degraded" | "down";
-export type WecomInboundKind =
-  | "text"
-  | "image"
-  | "file"
-  | "voice"
-  | "video"
-  | "mixed"
-  | "location"
-  | "link"
-  | "event"
-  | "welcome"
-  | "template-card-event";
-
-export type ConversationRef = {
-  accountId: string;
-  peerKind: "direct" | "group";
-  peerId: string;
-  senderId: string;
-};
-
-export type RawFrameReference = {
-  transport: WecomTransportKind;
-  command?: string;
-  headers?: Record<string, unknown>;
-  body?: unknown;
-  envelopeType: "json" | "xml" | "ws";
-};
-
-export type ReplyContext = {
-  transport: WecomTransportKind;
-  accountId: string;
-  responseUrl?: string;
-  reqId?: string;
-  streamId?: string;
-  webhookNonce?: string;
-  webhookTimestamp?: string;
-  passiveWindowMs?: number;
-  raw: RawFrameReference;
-};
-
-export type UnifiedInboundEvent = {
-  accountId: string;
-  capability: WecomCapabilityKind;
-  transport: WecomTransportKind;
-  inboundKind: WecomInboundKind;
-  messageId: string;
-  conversation: ConversationRef;
-  text: string;
-  senderName?: string;
-  timestamp: number;
-  raw: RawFrameReference;
-  replyContext: ReplyContext;
-  attachments?: Array<{
-    name?: string;
-    contentType?: string;
-    remoteUrl?: string;
-    aesKey?: string;
-  }>;
-};
-
-export type ReplyDeliveryInfo = {
-  kind: "block" | "final" | "error";
-};
-
-export type ReplyPayload = {
-  text?: string;
-  mediaUrl?: string;
-  mediaUrls?: string[];
-  replyToId?: string;
-  replyToTag?: boolean;
-  replyToCurrent?: boolean;
-  audioAsVoice?: boolean;
-  isError?: boolean;
-  isReasoning?: boolean;
-  channelData?: Record<string, unknown>;
-};
-
-export type ReplyHandle = {
-  context: ReplyContext;
-  deliver: (payload: ReplyPayload, info: ReplyDeliveryInfo) => Promise<void>;
-  fail?: (error: unknown) => Promise<void>;
-  markExternalActivity?: () => void;
-};
-
-export type TransportSessionSnapshot = {
-  accountId: string;
-  transport: WecomTransportKind;
-  running: boolean;
-  ownerId?: string;
-  connected?: boolean;
-  authenticated?: boolean;
-  lastConnectedAt?: number;
-  lastDisconnectedAt?: number;
-  lastInboundAt?: number;
-  lastOutboundAt?: number;
-  lastError?: string;
-};
-
-export type TransportSessionPatch = Partial<Omit<TransportSessionSnapshot, "accountId" | "transport">> & {
-  lastError?: string | null;
-};
-
-export type AccountRuntimeStatusSnapshot = {
-  accountId: string;
-  health: WecomRuntimeHealth;
-  transport?: WecomTransportKind;
-  ownerId?: string | null;
-  connected?: boolean;
-  authenticated?: boolean;
-  ownerDriftAt?: number | null;
-  lastError?: string | null;
-  lastErrorAt?: number | null;
-  lastInboundAt?: number | null;
-  lastOutboundAt?: number | null;
-  recentInboundSummary?: string | null;
-  recentOutboundSummary?: string | null;
-  recentIssueCategory?: WecomAuditCategory | null;
-  recentIssueSummary?: string | null;
-  transportSessions?: string[];
-};
-
-export type DeliveryTask = {
-  accountId: string;
-  transport: WecomTransportKind;
-  conversation: ConversationRef;
-  messageId: string;
-  status: "pending" | "delivered" | "failed";
-  createdAt: number;
-  updatedAt: number;
-  error?: string;
-};
-
-export type RuntimeLogSink = {
-  info?: (message: string) => void;
-  warn?: (message: string) => void;
-  error?: (message: string) => void;
-};
-
-export type RuntimeServices = {
-  core: PluginRuntime;
-  log: RuntimeLogSink;
-};
-
-export type AccountRuntimeContext = {
-  account: ResolvedWecomAccount;
-  bot?: ResolvedBotAccount;
-  agent?: ResolvedAgentAccount;
-  services: RuntimeServices;
-};

package/src/types.ts

@@ -1,41 +0,0 @@
-/**
- * Backward-compatible type bridge.
- * Canonical definitions live in `src/types/*`.
- */
-export type {
-  WecomDmConfig,
-  WecomAccountConfig,
-  WecomConfig,
-  ResolvedWecomAccount,
-  WecomInboundQuote,
-  WecomTemplateCard,
-  WecomOutboundMessage,
-} from "./types/index.js";
-
-import type {
-  WecomBotInboundBase,
-  WecomBotInboundText,
-  WecomBotInboundVoice,
-  WecomBotInboundStreamRefresh,
-  WecomBotInboundEvent,
-  WecomBotInboundMessage,
-} from "./types/index.js";
-
-export type WecomInboundBase = WecomBotInboundBase;
-export type WecomInboundText = WecomBotInboundText;
-export type WecomInboundVoice = WecomBotInboundVoice;
-export type WecomInboundStreamRefresh = WecomBotInboundStreamRefresh;
-export type WecomInboundEvent = WecomBotInboundEvent;
-export type WecomInboundMessage = WecomBotInboundMessage;
-
-export type WecomInboundTemplateCardEvent = WecomBotInboundEvent;
-export type WecomTemplateCardEventPayload = {
-  card_type: string;
-  event_key: string;
-  task_id: string;
-  response_code?: string;
-  selected_items?: {
-    question_key?: string;
-    option_ids?: string[];
-  };
-};