easemob-websdk 5.1.3 → 5.2.0

package/core/message/message-sender.d.ts

@@ -29,24 +29,39 @@ export declare class MessageSender {
     constructor(msyncCodec: MsyncCodec, websocket: SocketLike | null, eventHub: EventHub, attachmentUploader?: AttachmentUploader);
     updateAuthToken(token: string): void;
     /**
-     * 发送消息
+     * 发送一条消息。调用方看到的是这一个方法，实际分成准备和等待回执两段。
+     *
+     * 1. 流式消息，或 WebSocket 未连接：直接失败，不上传。
+     * 2. 合并消息先打成一个文件。其他类型跳过。
+     * 3. `prepareMessage` 上传本地附件，并把远端地址写回消息体。复合消息在这里按段串行上传。
+     * 4. 调用 `onSending`。这时消息还没写到网上。
+     * 5. `doSendMessage` 编码并写出，然后停在 Promise 上，直到下面三者之一：
+     *    - `handleAck`：服务端接受，补上 `msgServerId`，清本地文件，再 `onSuccess`。
+     *    - `handleSendError`：服务端拒绝或连接中断。
+     *    - 超时：一直没有回执。
+     * 6. 第 3 步之后的失败也进下面的 catch。`onFailed` 拿到的是上传后的消息，
+     *    已成功的附件带远端地址，再次发送时会跳过。
      */
     sendMessage(message: Message, options?: SendMessageOptions): Promise<Message>;
     sendAction(action: MessageActionRequest, createAckError?: (statusCode: number, reason?: string) => Error): Promise<ActionAckResult>;
     sendChatRoomOperation(request: ChatRoomOperationRequest, createAckError?: (statusCode: number, reason?: string) => Error): Promise<ActionAckResult>;
     /**
-     * 实际发送消息
+     * 把准备好的消息写到 WebSocket，并等待服务端回执。
+     * 这里先登记待确认消息，再发送。回执到达时用 protocolId 找回这条登记，
+     * 由 `handleAck` 或 `handleSendError` 结束这个 Promise。
      */
     private doSendMessage;
     private sendProtocolPayload;
     private prepareCombineMessage;
     /**
-     * 处理 ACK
+     * 服务端接受了这条消息。用 protocolId 找到 `doSendMessage` 登记的待确认消息，
+     * 写入服务端 id，清掉本地附件，再 resolve，发送 Promise 才返回。
      */
     handleAck(protocolId: string, msgServerId?: string, replacedMessage?: Message, chatRoomInfo?: JoinChatRoomInfo): void;
     private resolveReplacedMessage;
     /**
-     * 处理发送失败
+     * 消息已经写出，但服务端拒绝或连接中断。
+     * reject 之后回到 `sendMessage` 的 catch，由那里回调 `onFailed`。
      */
     handleSendError(protocolId: string, error: Error): void;
     handleAckFailure(protocolId: string, statusCode: number, reason: string | undefined, error: Error): void;

package/core/message/prepare-text-translation.d.ts

@@ -0,0 +1,7 @@
+import type { Message } from '../../types';
+import type { MessageTranslationResult } from '../../types/chat-manager';
+/** 仅为本次发送准备消息快照，不回填调用方持有的消息对象。 */
+export declare const prepareTextTranslation: (message: Message, translate: (params: {
+    readonly text: string;
+    readonly targetLanguages: ReadonlyArray<string>;
+}) => Promise<MessageTranslationResult>) => Promise<Message>;