easemob-websdk 4.22.0 → 4.24.0

package/Easemob-chat.d.ts

@@ -1,7 +1,6 @@
 export interface EasemobChatStatic {
 	connection: typeof EasemobChat.Connection;
 	message: typeof EasemobChat.Message;
-	image: EasemobChat.ImageModule;
 	utils: EasemobChat.Utils;
 	logger: EasemobChat.Logger;
 	statusCode: EasemobChat.Code;
@@ -67,78 +66,6 @@ export declare namespace EasemobChat {
 
 	type VoiceSourceFile = File | MiniProgramVoiceFile;
 
-	interface ImageInfo {
-		width: number;
-		height: number;
-		type?: string;
-	}
-
-	interface BigImageOptions {
-		maxShortEdge: number;
-		quality: number;
-	}
-
-	interface BigImageResult {
-		file?: File;
-		path?: string;
-		width: number;
-		height: number;
-		size: number;
-		type: string;
-	}
-
-	interface ImageProcessor {
-		getImageInfo(source: File | string): Promise<ImageInfo>;
-		generateBigImage(
-			source: File | string,
-			options: BigImageOptions
-		): Promise<BigImageResult | null>;
-		computeMd5(source: File | string): Promise<string>;
-	}
-
-	interface MiniAppRuntime {
-		getImageInfo(options: {
-			src: string;
-			success: (res: { width: number; height: number; type?: string }) => void;
-			fail: (err: any) => void;
-		}): void;
-		compressImage?(options: {
-			src: string;
-			quality?: number;
-			compressedWidth?: number;
-			compressedHeight?: number;
-			success?: (res: { tempFilePath: string }) => void;
-			fail?: (err: any) => void;
-		}): void;
-		getFileSystemManager?(): {
-			getFileInfo(options: {
-				filePath: string;
-				success: (res: { size: number }) => void;
-				fail: (err: any) => void;
-			}): void;
-			readFile(options: {
-				filePath: string;
-				encoding?: string;
-				success: (res: { data: ArrayBuffer | string }) => void;
-				fail: (err: any) => void;
-			}): void;
-		};
-	}
-
-	interface ImageModule {
-		DEFAULT_BIG_IMAGE_SHORT_EDGE: number;
-		DEFAULT_BIG_IMAGE_QUALITY: number;
-		webImageProcessor: ImageProcessor;
-		resolveScaledSize: (
-			width: number,
-			height: number,
-			maxShortEdge: number
-		) => { width: number; height: number };
-		createMiniAppImageProcessor: (
-			runtime: MiniAppRuntime
-		) => ImageProcessor;
-	}
-
 	type ExcludeAckMessageBody = Exclude<
 		MessageBody,
 		ReadMsgBody | DeliveryMsgBody | ChannelMsgBody
@@ -992,7 +919,74 @@ export declare namespace EasemobChat {
 		isLast: boolean;
 	}
 
-	interface ServerConversations {
+		/**
+		 * The multiple-keyword match type for server message search.
+		 * `or` means any keyword can match, and `and` means all keywords must match.
+		 */
+		type MessageSearchKeywordListMatchType = 'or' | 'and';
+
+		/**
+		 * The search scope for server message search.
+		 * `none` searches only the message body, `with` searches both body and extensions,
+		 * and `only` searches only extension fields.
+		 */
+		type MessageSearchScope = 'none' | 'with' | 'only';
+
+		/**
+		 * A WebSDK message object mapped from one server-side search hit.
+		 */
+		type ServerSearchMessage = ExcludeAckMessageBody & {
+			/** The conversation ID of the matched message. */
+			conversationId?: string;
+			/** Highlight fragments returned by the server. */
+			highlight?: string[];
+			/** Summary text returned by the server for quick display. */
+			text?: string;
+		};
+
+		/**
+		 * The paged result returned by server-side message search.
+		 */
+		interface ServerSearchMessagesResult {
+			/** The server search result messages. */
+			messages: ServerSearchMessage[];
+			/** The current page number. */
+			pageNum: number;
+			/** The requested page size echoed by the SDK. */
+			pageSize: number;
+			/** The total number of pages. */
+			totalPages: number;
+			/** Whether the current page is the last page. */
+			isLast: boolean;
+			/** The request trace id returned by the server. */
+			requestId?: string;
+			/** The server response timestamp in milliseconds. */
+			timestamp: number;
+		}
+
+		/**
+		 * The options for server-side message search.
+		 */
+		interface MessageSearchOption {
+			/** The keyword list for search. */
+			keywordList: string[];
+			/** The keyword list match type. The valid values are `or` and `and`. The default value is `or`. */
+			keywordListMatchType?: MessageSearchKeywordListMatchType;
+			/** The conversation ID for in-conversation search. */
+			conversationId?: string;
+			/** The conversation type for filtering. Must be used with conversationId. */
+			conversationType?: ChatType;
+			/** Message body type filters. */
+			msgTypes?: MessageType[];
+			/** The start timestamp for query. The unit is millisecond. */
+			startTime?: number;
+			/** The end timestamp for query. The unit is millisecond. */
+			endTime?: number;
+			/** The search scope. */
+			searchScope?: MessageSearchScope;
+		}
+
+		interface ServerConversations {
 		/** The conversation list. */
 		conversations: ConversationItem[];
 		/** The position from which to start getting data for the next query. If the number of returned data entries is smaller than that specified in the request, the cursor is `'undefined'`, which indicates that the current page is the last page; otherwise, the SDK returns the specific cursor position which indicates where to start getting data for the next query.*/
@@ -4713,8 +4707,28 @@ export declare namespace EasemobChat {
 			}
 		): Promise<HistoryMessages>;
 
-		/**
-		 * Unidirectionally deletes historical messages from the server.
+				/**
+				 *  Searches messages from the server.
+				 *  This feature requires the "Message Search" service to be enabled in the Console.
+				 *
+				 *  @param option The search option. See {@link MessageSearchOption}.
+				 *  @param pageNum The page number for pagination, starting from 1.
+				 *  @param pageSize The number of results per page (1-100, default 20).
+				 */
+			searchMessages(
+				this: Connection,
+				params: {
+					/** The search option. */
+					option: MessageSearchOption;
+					/** The page number for pagination, starting from 1. */
+					pageNum?: number;
+					/** The number of results per page. The range is 1 to 100. */
+					pageSize?: number;
+				}
+			): Promise<ServerSearchMessagesResult>;
+
+			/**
+			 * Unidirectionally deletes historical messages from the server.
 		 *
 		 * ```typescript
 		 * connection.removeHistoryMessages({targetId: 'userId', chatType: 'singleChat', time: Date.now()})
@@ -6969,6 +6983,8 @@ export declare namespace EasemobChat {
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Has the message been read (only single chat messages have this field). */
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
@@ -7001,6 +7017,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface StreamChunk {
@@ -7073,6 +7091,8 @@ export declare namespace EasemobChat {
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** The file URL. */
 		url?: string;
 		/** The secret key required to download the file. */
@@ -7136,6 +7156,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Compatibility information for merging messages. */
 		compatibleText: string;
 		/** The title of the merged messages. */
@@ -7223,6 +7245,8 @@ export declare namespace EasemobChat {
 		 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 		 */
 		deliverOnlineOnly?: boolean;
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Message modified info. */
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
@@ -7261,6 +7285,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface CustomParameters {
@@ -7343,6 +7369,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Message modified info. */
 		modifiedInfo?: ModifiedMsgInfo;
 		/** Has the message been read (only single chat messages have this field). */
@@ -7379,6 +7407,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface LocationParameters {
@@ -7467,6 +7497,8 @@ export declare namespace EasemobChat {
 		 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 		 */
 		deliverOnlineOnly?: boolean;
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Message modified info. */
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
@@ -7507,6 +7539,8 @@ export declare namespace EasemobChat {
 		 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 		 */
 		deliverOnlineOnly?: boolean;
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** The list of message recipients. */
 		receiverList?: string[];
 	}
@@ -7619,6 +7653,8 @@ export declare namespace EasemobChat {
 		 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 		 */
 		deliverOnlineOnly?: boolean;
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Message modified info. */
 		modifiedInfo?: ModifiedMsgInfo;
 		/** Has the message been read (only single chat messages have this field). */
@@ -7674,6 +7710,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface ImgParameters {
@@ -7767,6 +7805,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** The thumbnail width. */
 		thumbnailWidth?: number;
 		/** The thumbnail height. */
@@ -7799,22 +7839,37 @@ export declare namespace EasemobChat {
 	}
 
 	interface CreateImageMessageParameters {
+		/** The conversation type. */
 		chatType: ChatType;
+		/** The recipient. */
 		to: string;
+		/** The sender, which can only be the current user and can not be changed. */
 		from?: string;
+		/** The image file source. */
 		file: ImageFileSource;
+		/** The image width. */
 		width?: number;
+		/** The image height. */
 		height?: number;
 		/** Whether to send the original image. Default is false. */
 		isOriginalImage?: boolean;
+		/** Message extension. */
 		ext?: { [key: string]: any };
+		/** Whether read receipts are required during a group session. */
 		msgConfig?: { allowGroupAck: boolean };
+		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
+		/** Message priority. */
 		priority?: MessagePriority;
+		/** Whether the message is delivered only when the recipient(s) is/are online. */
 		deliverOnlineOnly?: boolean;
+		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The callback of file upload error. */
 		onFileUploadError?: (err: ErrorEvent) => void;
+		/** The callback of file upload completion. */
 		onFileUploadComplete?: (data: UploadFileResult) => void;
+		/** The callback of file upload progress. */
 		onFileUploadProgress?: (data: ProgressEvent) => void;
 	}
 
@@ -7867,6 +7922,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** The thumbnail width. */
 		thumbnailWidth?: number;
 		/** The thumbnail height. */
@@ -7971,6 +8028,8 @@ export declare namespace EasemobChat {
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Has the message been read (only single chat messages have this field). */
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
@@ -8026,6 +8085,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface VideoParameters {
@@ -8126,6 +8187,8 @@ export declare namespace EasemobChat {
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 		/** Has the message been read (only single chat messages have this field). */
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
@@ -8183,6 +8246,8 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** The webhookEnv field in the sending message protocol. */
+		webhookEnv?: string;
 	}
 
 	interface ReceivedMsgBody {