@core-workspace/infoflow-openclaw-plugin 2026.3.9 → 2026.3.27-beta.0

package/src/types.ts

@@ -10,6 +10,18 @@ export type InfoflowDmPolicy = "open" | "pairing" | "allowlist";
 export type InfoflowGroupPolicy = "open" | "allowlist" | "disabled";
 export type InfoflowChatType = "direct" | "group";
 export type InfoflowConnectionMode = "webhook" | "websocket";
+export type InfoflowMessageFormat = "text" | "markdown" | "streaming-card";
+
+export type InfoflowCronRelayConfig = {
+  /** Whether to relay cron run results into Infoflow. Default: true */
+  enabled?: boolean;
+  /** Skip runs already delivered by cron delivery config. Default: false */
+  includeAlreadyDelivered?: boolean;
+  /** Message prefix for relayed cron notifications. Default: "【定时任务】" */
+  prefix?: string;
+  /** Poll interval for scanning cron run logs (ms). Default: 2000 */
+  pollIntervalMs?: number;
+};
 
 /** Reply mode controlling bot behavior per group */
 export type InfoflowReplyMode =
@@ -19,9 +31,14 @@ export type InfoflowReplyMode =
   | "mention-and-watch"
   | "proactive";
 
+/** Group session mode: whether to split sessions by group or by group+user */
+export type InfoflowGroupSessionMode = "group" | "user";
+
 /** Per-group configuration overrides */
 export type InfoflowGroupConfig = {
   replyMode?: InfoflowReplyMode;
+  /** Group session mode: "group" = one session per group, "user" = one session per user in group */
+  groupSessionMode?: InfoflowGroupSessionMode;
   systemPrompt?: string;
   /** Enable follow-up replies after bot responds (default: true) */
   followUp?: boolean;
@@ -29,8 +46,8 @@ export type InfoflowGroupConfig = {
   followUpWindow?: number;
   /** Names to watch for @mentions */
   watchMentions?: string[];
-  /** Regex pattern to watch for in message content */
-  watchRegex?: string;
+  /** Regex pattern(s) to watch for in message content (string or array; any match triggers) */
+  watchRegex?: string | string[];
 };
 
 // ---------------------------------------------------------------------------
@@ -50,6 +67,8 @@ export type InfoflowInboundBodyItem = {
   userid?: string;
   /** IMAGE 类型 body item 的图片下载地址 */
   downloadurl?: string;
+  /** Message ID in replyData items (always string; converted at inbound boundary) */
+  messageid?: string;
 };
 
 /** Mention IDs extracted from inbound group AT items (excluding the bot itself) */
@@ -60,6 +79,12 @@ export type InfoflowMentionIds = {
   agentIds: number[];
 };
 
+/** Single agent (robot) info from the group member list API */
+export type InfoflowGroupAgentInfo = {
+  agentId: number;
+  name: string;
+};
+
 // ---------------------------------------------------------------------------
 // AT mention types
 // ---------------------------------------------------------------------------
@@ -76,7 +101,7 @@ export type InfoflowAtOptions = {
 export type InfoflowGroupMessageBodyItem =
   | { type: "TEXT"; content: string }
   | { type: "MD"; content: string }
-  | { type: "AT"; atall?: boolean; atuserids: string[]; atagentids?: number[] }
+  | { type: "AT"; atall?: boolean; atuserids?: string[]; atagentids?: number[] }
   | { type: "LINK"; href: string }
   | { type: "IMAGE"; content: string };
 
@@ -86,7 +111,7 @@ export type InfoflowMessageContentItem = {
   content: string;
 };
 
-/** Outbound reply/quote context for group messages */
+/** Outbound reply/quote context for group and private messages */
 export type InfoflowOutboundReply = {
   /** Message ID of the message being replied to (string to preserve large integer precision) */
   messageid: string;
@@ -96,6 +121,8 @@ export type InfoflowOutboundReply = {
   replytype?: "1" | "2";
   /** User IMID (optional, if not provided, shows robot name) */
   imid?: string;
+  /** Secondary message ID for private message reply (maps to API field "msgid2") */
+  msgid2?: string;
 };
 
 // ---------------------------------------------------------------------------
@@ -112,8 +139,10 @@ export type InfoflowAccountConfig = {
   appSecret?: string;
   /** 连接方式：webhook（默认）或 websocket */
   connectionMode?: InfoflowConnectionMode;
-  /** WebSocket Gateway 域名（仅 websocket 模式使用） */
+  /** WebSocket Gateway 域名，用于 Phase 1 端点分配请求（仅 websocket 模式使用） */
   wsGateway?: string;
+  /** WebSocket 连接域名，用于 Phase 2 实际 WS 握手（不填则使用服务端返回的地址） */
+  wsConnectDomain?: string;
   dmPolicy?: InfoflowDmPolicy;
   allowFrom?: string[];
   groupPolicy?: InfoflowGroupPolicy;
@@ -121,19 +150,29 @@ export type InfoflowAccountConfig = {
   requireMention?: boolean;
   /** Robot name for matching @mentions in group messages */
   robotName?: string;
+  /** Actual robot id from Infoflow (auto-discovered when bot is @mentioned; used to ignore own messages). Not user-configured. */
+  robotId?: string;
   /** Names to watch for @mentions; when someone @mentions a person in this list,
    *  the bot analyzes the message and replies only if confident. */
   watchMentions?: string[];
-  /** Regex pattern to watch for in message content; triggers bot activation when matched */
-  watchRegex?: string;
+  /** Regex pattern(s) to watch for in message content; triggers bot activation when any pattern matches */
+  watchRegex?: string | string[];
   /** Reply mode controlling bot engagement level in groups */
   replyMode?: InfoflowReplyMode;
+  /** Group session mode: "group" = one session per group, "user" = one session per user in group (default: "group") */
+  groupSessionMode?: InfoflowGroupSessionMode;
   /** Enable follow-up replies after bot responds to a mention (default: true) */
   followUp?: boolean;
   /** Follow-up window in seconds after last bot reply (default: 300) */
   followUpWindow?: number;
   /** 如流企业后台的应用ID（私聊消息撤回依赖此字段） */
   appAgentId?: number;
+  /** Default Infoflow target used by cron relay when the run has no explicit target */
+  defaultTo?: string;
+  /** Private plugin data directory under OpenClaw stateDir */
+  privateDataDir?: string;
+  /** Cron relay options */
+  cronRelay?: InfoflowCronRelayConfig;
   /** Per-group configuration overrides, keyed by group ID */
   groups?: Record<string, InfoflowGroupConfig>;
   accounts?: Record<string, InfoflowAccountConfig>;
@@ -154,14 +193,20 @@ export type InfoflowAccountConfig = {
    * Message format for outbound private (DM) messages: "text" or "markdown".
    * Default: "text"
    */
-  dmMessageFormat?: "text" | "markdown";
+  dmMessageFormat?: InfoflowMessageFormat;
   /**
    * Message format for outbound group messages: "text" or "markdown".
    * Note: "markdown" does not support reply-to (quote) context — the bot
    * will still reply but without quoting the user's message.
    * Default: "text"
    */
-  groupMessageFormat?: "text" | "markdown";
+  groupMessageFormat?: InfoflowMessageFormat;
+  /**
+   * Maximum character limit per outbound message chunk.
+   * Long messages are automatically split into multiple messages each within this limit.
+   * Default: 1800
+   */
+  textChunkLimit?: number;
 };
 
 export type ResolvedInfoflowAccount = {
@@ -179,8 +224,10 @@ export type ResolvedInfoflowAccount = {
     appSecret: string;
     /** 连接方式：webhook（默认）或 websocket */
     connectionMode?: InfoflowConnectionMode;
-    /** WebSocket Gateway 域名（仅 websocket 模式使用） */
+    /** WebSocket Gateway 域名，用于 Phase 1 端点分配请求（仅 websocket 模式使用） */
     wsGateway?: string;
+    /** WebSocket 连接域名，用于 Phase 2 实际 WS 握手（不填则使用服务端返回的地址） */
+    wsConnectDomain?: string;
     dmPolicy?: InfoflowDmPolicy;
     allowFrom?: string[];
     groupPolicy?: InfoflowGroupPolicy;
@@ -188,36 +235,62 @@ export type ResolvedInfoflowAccount = {
     requireMention?: boolean;
     /** Robot name for matching @mentions in group messages */
     robotName?: string;
+    /** Actual robot id from Infoflow (auto-discovered when bot is @mentioned; used to ignore own messages). Not user-configured. */
+    robotId?: string;
     /** Names to watch for @mentions; when someone @mentions a person in this list,
      *  the bot analyzes the message and replies only if confident. */
     watchMentions?: string[];
-    /** Regex pattern to watch for in message content; triggers bot activation when matched */
-    watchRegex?: string;
+    /** Regex pattern(s) to watch for in message content; triggers bot activation when any pattern matches */
+    watchRegex?: string | string[];
     /** Reply mode controlling bot engagement level in groups */
     replyMode?: InfoflowReplyMode;
+    /** Group session mode: "group" = one session per group, "user" = one session per user in group (default: "group") */
+    groupSessionMode?: InfoflowGroupSessionMode;
     /** Enable follow-up replies after bot responds to a mention (default: true) */
     followUp?: boolean;
     /** Follow-up window in seconds after last bot reply (default: 300) */
     followUpWindow?: number;
     /** 如流企业后台的应用ID（私聊消息撤回依赖此字段） */
     appAgentId?: number;
+    /** Default Infoflow target used by cron relay when the run has no explicit target */
+    defaultTo?: string;
+    /** Private plugin data directory under OpenClaw stateDir */
+    privateDataDir: string;
+    /** Cron relay options */
+    cronRelay: {
+      enabled: boolean;
+      includeAlreadyDelivered: boolean;
+      prefix: string;
+      pollIntervalMs: number;
+    };
     /** Per-group configuration overrides, keyed by group ID */
     groups?: Record<string, InfoflowGroupConfig>;
+    /**
+     * Send a "processing" hint message before the real reply when processing is slow.
+     * Default: true
+     */
+    processingHint?: boolean;
+    /**
+     * Delay in seconds before sending the "processing" hint message.
+     * Default: 5
+     */
+    processingHintDelay?: number;
     /**
      * Message format for outbound private (DM) messages: "text" or "markdown".
      * Default: "text"
      */
-    dmMessageFormat?: "text" | "markdown";
+    dmMessageFormat?: InfoflowMessageFormat;
     /**
      * Message format for outbound group messages: "text" or "markdown".
      * Note: "markdown" does not support reply-to (quote) context.
      * Default: "text"
      */
-    groupMessageFormat?: "text" | "markdown";
-    dmPolicy?: string;
-    allowFrom?: string[];
-    groupPolicy?: string;
-    groupAllowFrom?: string[];
+    groupMessageFormat?: InfoflowMessageFormat;
+    /**
+     * Maximum character limit per outbound message chunk.
+     * Default: 1800
+     */
+    textChunkLimit?: number;
   };
 };
 
@@ -225,16 +298,50 @@ export type ResolvedInfoflowAccount = {
 // Message types
 // ---------------------------------------------------------------------------
 
+/** 如流消息发送者身份（判别联合） */
+export type InfoflowSender =
+  | {
+      /** 普通账户 */
+      kind: "regular";
+      /** UUAP 用户名（fromuserid） */
+      userid: string;
+      /** 显示名称 */
+      name?: string;
+      /** 数字 IMID（fromid） */
+      imid?: string;
+    }
+  | {
+      /** 机器人账户 */
+      kind: "robot";
+      /** 机器人 agent ID（数字，对应 robotid / fromid）；群聊 ALL_MESSAGE_FORWARD 场景暂无法获取，可能为空 */
+      agentid?: string;
+      /** 显示名称 */
+      name?: string;
+      /** 数字 IMID（fromid，机器人的 fromid = robotid） */
+      imid?: string;
+    };
+
+/** 输出 InfoflowSender 的描述字符串，用于日志和调试 */
+export function descSender(s: InfoflowSender): string {
+  if (s.kind === "regular") {
+    return `regular(${s.userid}/${s.name ?? "-"}/${s.imid ?? "-"})`;
+  }
+  return `robot(${s.agentid ?? "-"}/${s.name ?? "-"}/${s.imid ?? "-"})`;
+}
+
 export type InfoflowMessageEvent = {
-  fromuser: string;
+  /** 发送者身份信息（包含 kind/id/name/imid） */
+  sender: InfoflowSender;
   mes: string;
   chatType: InfoflowChatType;
   groupId?: number;
-  senderName?: string;
+
   /** Whether the bot was @mentioned in the message */
   wasMentioned?: boolean;
   /** Original message ID from Infoflow */
   messageId?: string;
+  /** Secondary message ID from Infoflow (used for private message reply as "msgid2") */
+  msgid2?: string;
   /** Unix millisecond timestamp of the message */
   timestamp?: number;
   /** Raw message text preserving @mentions (for RawBody) */
@@ -247,8 +354,20 @@ export type InfoflowMessageEvent = {
   replyContext?: string[];
   /** Image download URLs extracted from IMAGE body items (group) or PicUrl (private) */
   imageUrls?: string[];
-  /** Sender's IMID (numeric user ID) for reply context */
-  senderImid?: string;
+  /** Agent-visible body text with robotid annotations (e.g. @name (robotid:N)) for LLM */
+  bodyForAgent?: string;
+  /** Whether the message is a quoted reply to one of the bot's own previous messages */
+  isReplyToBot?: boolean;
+  /** 语音消息的音频下载地址 */
+  voiceUrl?: string;
+  /** 本地 hd→wav 转换后的 WAV 文件路径 */
+  localVoicePath?: string;
+  /** 消息来源平台标识 */
+  fromPlatform?: string;
+  /** 如流应用的 agentId */
+  agentId?: string;
+  /** 如流开放平台的 OpenCode（加密的用户/应用凭证） */
+  openCode?: string;
 };
 
 // ---------------------------------------------------------------------------
@@ -256,21 +375,21 @@ export type InfoflowMessageEvent = {
 // ---------------------------------------------------------------------------
 
 export type HandleInfoflowMessageParams = {
-  cfg: import("openclaw/plugin-sdk").OpenClawConfig;
+  cfg: import("openclaw/plugin-sdk/plugin-entry").OpenClawConfig;
   event: InfoflowMessageEvent;
   accountId: string;
   statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void;
 };
 
 export type HandlePrivateChatParams = {
-  cfg: import("openclaw/plugin-sdk").OpenClawConfig;
+  cfg: import("openclaw/plugin-sdk/plugin-entry").OpenClawConfig;
   msgData: Record<string, unknown>;
   accountId: string;
   statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void;
 };
 
 export type HandleGroupChatParams = {
-  cfg: import("openclaw/plugin-sdk").OpenClawConfig;
+  cfg: import("openclaw/plugin-sdk/plugin-entry").OpenClawConfig;
   msgData: Record<string, unknown>;
   accountId: string;
   statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void;