@soimy/dingtalk 3.2.0 → 3.3.0

package/src/types.ts

@@ -17,6 +17,7 @@ import type {
   ChannelGatewayContext as SDKChannelGatewayContext,
   ChannelPlugin as SDKChannelPlugin,
 } from "openclaw/plugin-sdk";
+import { mergeAccountWithDefaults } from "./config";
 
 export interface DingtalkPluginModule {
   id: string;
@@ -41,7 +42,8 @@ export interface DingTalkConfig extends OpenClawConfig {
   groupPolicy?: "open" | "allowlist";
   allowFrom?: string[];
   mediaUrlAllowlist?: string[];
-  showThinking?: boolean;
+  journalTTLDays?: number;
+  ackReaction?: string;
   debug?: boolean;
   messageType?: "markdown" | "card";
   cardTemplateId?: string;
@@ -55,14 +57,36 @@ export interface DingTalkConfig extends OpenClawConfig {
   reconnectJitter?: number;
   /** Maximum number of runtime reconnect cycles before giving up (default: 10) */
   maxReconnectCycles?: number;
+  /** Maximum time (ms) for a single reconnect cycle before giving up and starting a new cycle (default: 50000) */
+  reconnectDeadlineMs?: number;
   /** Whether to use ConnectionManager; when false, use DWClient native keepAlive+autoReconnect */
   useConnectionManager?: boolean;
   /** Maximum inbound media file size in MB (overrides runtime default when set) */
   mediaMaxMb?: number;
+  /** Whether to enable underlying stream keepAlive heartbeat; defaults to !useConnectionManager when omitted */
+  keepAlive?: boolean;
+  /** Bypass system/global HTTP(S) proxy for DingTalk outbound send/card/upload APIs */
+  bypassProxyForSend?: boolean;
   proactivePermissionHint?: {
     enabled?: boolean;
     cooldownHours?: number;
   };
+  /** Enable real-time card streaming (default false, true = 300ms throttled per-token updates) */
+  cardRealTimeStream?: boolean;
+  /** AICard degrade duration in milliseconds after trigger errors (default 30m) */
+  aicardDegradeMs?: number;
+  /** Enable local learning loop (events/reflections/session notes/global rules) */
+  learningEnabled?: boolean;
+  /** Auto-apply generated reflections into session notes/global rules (default false) */
+  learningAutoApply?: boolean;
+  /** Session learning note TTL in milliseconds (default 6h) */
+  learningNoteTtlMs?: number;
+  /** @deprecated Use learningEnabled */
+  feedbackLearningEnabled?: boolean;
+  /** @deprecated Use learningAutoApply */
+  feedbackLearningAutoApply?: boolean;
+  /** @deprecated Use learningNoteTtlMs */
+  feedbackLearningNoteTtlMs?: number;
 }
 
 /**
@@ -80,7 +104,8 @@ export interface DingTalkChannelConfig {
   groupPolicy?: "open" | "allowlist";
   allowFrom?: string[];
   mediaUrlAllowlist?: string[];
-  showThinking?: boolean;
+  journalTTLDays?: number;
+  ackReaction?: string;
   debug?: boolean;
   messageType?: "markdown" | "card";
   cardTemplateId?: string;
@@ -93,14 +118,36 @@ export interface DingTalkChannelConfig {
   reconnectJitter?: number;
   /** Maximum number of runtime reconnect cycles before giving up (default: 10) */
   maxReconnectCycles?: number;
+  /** Maximum time (ms) for a single reconnect cycle before giving up and starting a new cycle (default: 50000) */
+  reconnectDeadlineMs?: number;
   /** Whether to use ConnectionManager; when false, use DWClient native keepAlive+autoReconnect */
   useConnectionManager?: boolean;
   /** Maximum inbound media file size in MB (overrides runtime default when set) */
   mediaMaxMb?: number;
+  /** Whether to enable underlying stream keepAlive heartbeat; defaults to !useConnectionManager when omitted */
+  keepAlive?: boolean;
+  /** Bypass system/global HTTP(S) proxy for DingTalk outbound send/card/upload APIs */
+  bypassProxyForSend?: boolean;
   proactivePermissionHint?: {
     enabled?: boolean;
     cooldownHours?: number;
   };
+  /** Enable real-time card streaming (default false, true = 300ms throttled per-token updates) */
+  cardRealTimeStream?: boolean;
+  /** AICard degrade duration in milliseconds after trigger errors (default 30m) */
+  aicardDegradeMs?: number;
+  /** Enable local learning loop (events/reflections/session notes/global rules) */
+  learningEnabled?: boolean;
+  /** Auto-apply generated reflections into session notes/global rules (default false) */
+  learningAutoApply?: boolean;
+  /** Session learning note TTL in milliseconds (default 6h) */
+  learningNoteTtlMs?: number;
+  /** @deprecated Use learningEnabled */
+  feedbackLearningEnabled?: boolean;
+  /** @deprecated Use learningAutoApply */
+  feedbackLearningAutoApply?: boolean;
+  /** @deprecated Use learningNoteTtlMs */
+  feedbackLearningNoteTtlMs?: number;
 }
 
 /**
@@ -145,6 +192,14 @@ export interface MediaFile {
   mimeType: string;
 }
 
+export interface DocInfo {
+  docId: string;
+  title: string;
+  docType: string;
+  creatorId?: string;
+  updatedAt?: number | string;
+}
+
 /**
  * DingTalk incoming message (Stream mode)
  */
@@ -156,15 +211,22 @@ export interface DingTalkInboundMessage {
     content: string;
     isReplyMsg?: boolean; // 是否是回复消息
     repliedMsg?: {
-      // 被回复的消息
+      msgType?: string;
+      msgId?: string;
+      senderId?: string;
+      createdAt?: number;
       content?: {
         text?: string;
+        downloadCode?: string;
+        biz_custom_action_url?: string;
         richText?: Array<{
           msgType?: string;
           type?: string;
           content?: string;
+          text?: string;
           code?: string;
           atName?: string;
+          downloadCode?: string;
         }>;
       };
     };
@@ -173,13 +235,16 @@ export interface DingTalkInboundMessage {
     downloadCode?: string;
     fileName?: string;
     recognition?: string;
+    spaceId?: string;
+    fileId?: string;
+    biz_custom_action_url?: string;
     richText?: Array<{
       type: string;
       text?: string;
       atName?: string;
-      downloadCode?: string; // For picture type in richText
+      downloadCode?: string;
     }>;
-    quoteContent?: string; // 替代引用格式
+    quoteContent?: string;
   };
   // Legacy 引用格式
   quoteMessage?: {
@@ -191,6 +256,7 @@ export interface DingTalkInboundMessage {
   };
   // 富媒体引用，仅有消息ID的情况（包括手机端和PC端）
   originalMsgId?: string;
+  originalProcessQueryKey?: string;
   conversationType: string;
   conversationId: string;
   conversationTitle?: string;
@@ -201,14 +267,39 @@ export interface DingTalkInboundMessage {
   sessionWebhook: string;
 }
 
+/**
+ * Quoted/reply message metadata extracted from repliedMsg.
+ * Populated when isReplyMsg is true; downstream handlers use these fields
+ * to download quoted media or look up cached card content.
+ */
+export interface QuotedInfo {
+  prefix: string;
+  mediaDownloadCode?: string;
+  mediaType?: string;
+  isQuotedFile?: boolean;
+  isQuotedCard?: boolean;
+  isQuotedDocCard?: boolean;
+  docSpaceId?: string;
+  docFileId?: string;
+  cardCreatedAt?: number;
+  processQueryKey?: string;
+  fileCreatedAt?: number;
+  msgId?: string;
+}
+
 /**
  * Extracted message content for unified processing
  */
 export interface MessageContent {
   text: string;
   mediaPath?: string;
+  mediaPaths?: string[];
   mediaType?: string;
+  mediaTypes?: string[];
   messageType: string;
+  docSpaceId?: string;
+  docFileId?: string;
+  quoted?: QuotedInfo;
 }
 
 /**
@@ -218,14 +309,21 @@ export interface SendMessageOptions {
   title?: string;
   useMarkdown?: boolean;
   atUserId?: string | null;
-  log?: any;
+  log?: Logger;
+  conversationId?: string;
   mediaPath?: string;
   filePath?: string;
   mediaUrl?: string;
   mediaType?: "image" | "voice" | "video" | "file";
   accountId?: string;
-  cardUpdateMode?: "replace" | "append" | "finalize";
-  cardFinalize?: boolean;
+  storePath?: string;
+  cardUpdateMode?: "append";
+}
+
+export interface DingTalkTrackingMetadata {
+  processQueryKey?: string;
+  outTrackId?: string;
+  cardInstanceId?: string;
 }
 
 /**
@@ -254,7 +352,7 @@ export interface HandleDingTalkMessageParams {
   accountId: string;
   data: DingTalkInboundMessage;
   sessionWebhook: string;
-  log?: any;
+  log?: Logger;
   dingtalkConfig: DingTalkConfig;
 }
 
@@ -295,7 +393,7 @@ export interface ResolvedAccount {
 export interface AxiosRequestConfig {
   url?: string;
   method?: string;
-  data?: any;
+  data?: unknown;
   headers?: Record<string, string>;
   responseType?: "arraybuffer" | "json" | "text";
 }
@@ -303,7 +401,7 @@ export interface AxiosRequestConfig {
 /**
  * HTTP response from axios
  */
-export interface AxiosResponse<T = any> {
+export interface AxiosResponse<T = unknown> {
   data: T;
   status: number;
   statusText: string;
@@ -325,15 +423,15 @@ export interface StreamCallbackResponse {
  */
 export interface ReplyDispatchContext {
   responsePrefix?: string;
-  deliver: (payload: any) => Promise<{ ok: boolean; error?: string }>;
+  deliver: (payload: unknown) => Promise<{ ok: boolean; error?: string }>;
 }
 
 /**
  * Reply dispatcher result
  */
 export interface ReplyDispatcherResult {
-  dispatcher: any;
-  replyOptions: any;
+  dispatcher: unknown;
+  replyOptions: unknown;
   markDispatchIdle: () => void;
 }
 
@@ -343,7 +441,7 @@ export interface ReplyDispatcherResult {
 export interface RetryOptions {
   maxRetries?: number;
   baseDelayMs?: number;
-  log?: any;
+  log?: Logger;
 }
 
 /**
@@ -397,7 +495,7 @@ export interface TargetResolutionResult {
  */
 export interface ResolveTargetParams {
   to?: string | null;
-  [key: string]: any;
+  [key: string]: unknown;
 }
 
 /**
@@ -408,7 +506,7 @@ export interface SendTextParams {
   to: string;
   text: string;
   accountId?: string;
-  [key: string]: any;
+  [key: string]: unknown;
 }
 
 /**
@@ -419,7 +517,7 @@ export interface SendMediaParams {
   to: string;
   mediaPath: string;
   accountId?: string;
-  [key: string]: any;
+  [key: string]: unknown;
 }
 
 /**
@@ -428,8 +526,8 @@ export interface SendMediaParams {
 export interface DingTalkOutboundHandler {
   deliveryMode: "direct" | "queued" | "batch";
   resolveTarget: (params: ResolveTargetParams) => TargetResolutionResult;
-  sendText: (params: SendTextParams) => Promise<{ ok: boolean; data?: any; error?: any }>;
-  sendMedia?: (params: SendMediaParams) => Promise<{ ok: boolean; data?: any; error?: any }>;
+  sendText: (params: SendTextParams) => Promise<{ ok: boolean; data?: unknown; error?: unknown }>;
+  sendMedia?: (params: SendMediaParams) => Promise<{ ok: boolean; data?: unknown; error?: unknown }>;
 }
 
 /**
@@ -452,13 +550,17 @@ export type AICardState = (typeof AICardStatus)[keyof typeof AICardStatus];
  */
 export interface AICardInstance {
   cardInstanceId: string;
+  processQueryKey?: string;
   accessToken: string;
   conversationId: string;
+  accountId?: string;
+  storePath?: string;
   createdAt: number;
   lastUpdated: number;
   state: AICardState; // Current card state: PROCESSING, INPUTING, FINISHED, FAILED
   config?: DingTalkConfig; // Store config reference for token refresh
   lastStreamedContent?: string;
+  outTrackId?: string;
 }
 
 /**
@@ -485,6 +587,14 @@ export enum ConnectionState {
   FAILED = "FAILED",
 }
 
+/**
+ * Factory function that creates a fresh DWClient with callback listeners
+ * already registered. Used by ConnectionManager to create a new client
+ * on reconnection so the new WebSocket can start receiving messages
+ * while the old zombie socket is still being cleaned up.
+ */
+export type StreamClientFactory = () => import("dingtalk-stream").DWClient;
+
 /**
  * Connection manager configuration
  */
@@ -495,6 +605,8 @@ export interface ConnectionManagerConfig {
   jitter: number;
   /** Maximum number of runtime reconnect cycles before giving up (default: 10) */
   maxReconnectCycles?: number;
+  /** Maximum time (ms) for a single reconnect cycle before giving up and starting a new cycle (default: 50000) */
+  reconnectDeadlineMs?: number;
   /** Callback invoked when connection state changes */
   onStateChange?: (state: ConnectionState, error?: string) => void;
 }
@@ -568,7 +680,8 @@ export function resolveDingTalkAccount(
       dmPolicy: dingtalk?.dmPolicy,
       groupPolicy: dingtalk?.groupPolicy,
       allowFrom: dingtalk?.allowFrom,
-      showThinking: dingtalk?.showThinking,
+      journalTTLDays: dingtalk?.journalTTLDays,
+      ackReaction: dingtalk?.ackReaction,
       debug: dingtalk?.debug,
       messageType: dingtalk?.messageType,
       cardTemplateId: dingtalk?.cardTemplateId,
@@ -580,9 +693,20 @@ export function resolveDingTalkAccount(
       maxReconnectDelay: dingtalk?.maxReconnectDelay,
       reconnectJitter: dingtalk?.reconnectJitter,
       maxReconnectCycles: dingtalk?.maxReconnectCycles,
+      reconnectDeadlineMs: dingtalk?.reconnectDeadlineMs,
       useConnectionManager: dingtalk?.useConnectionManager,
       mediaMaxMb: dingtalk?.mediaMaxMb,
+      keepAlive: dingtalk?.keepAlive,
+      bypassProxyForSend: dingtalk?.bypassProxyForSend,
       proactivePermissionHint: dingtalk?.proactivePermissionHint,
+      cardRealTimeStream: dingtalk?.cardRealTimeStream,
+      aicardDegradeMs: dingtalk?.aicardDegradeMs,
+      learningEnabled: dingtalk?.learningEnabled ?? dingtalk?.feedbackLearningEnabled,
+      learningAutoApply: dingtalk?.learningAutoApply ?? dingtalk?.feedbackLearningAutoApply,
+      learningNoteTtlMs: dingtalk?.learningNoteTtlMs ?? dingtalk?.feedbackLearningNoteTtlMs,
+      feedbackLearningEnabled: dingtalk?.feedbackLearningEnabled,
+      feedbackLearningAutoApply: dingtalk?.feedbackLearningAutoApply,
+      feedbackLearningNoteTtlMs: dingtalk?.feedbackLearningNoteTtlMs,
     };
     return {
       ...config,
@@ -591,13 +715,17 @@ export function resolveDingTalkAccount(
     };
   }
 
-  // If named account, get from accounts object
+  // If named account, merge channel-level defaults with account-level overrides
   const accountConfig = dingtalk?.accounts?.[id];
   if (accountConfig) {
+    const merged = mergeAccountWithDefaults(
+      dingtalk as DingTalkConfig,
+      accountConfig,
+    );
     return {
-      ...accountConfig,
+      ...merged,
       accountId: id,
-      configured: Boolean(accountConfig.clientId && accountConfig.clientSecret),
+      configured: Boolean(merged.clientId && merged.clientSecret),
     };
   }