easemob-websdk 4.21.1 → 4.22.0

package/Easemob-chat.d.ts

@@ -1,6 +1,7 @@
 export interface EasemobChatStatic {
 	connection: typeof EasemobChat.Connection;
 	message: typeof EasemobChat.Message;
+	image: EasemobChat.ImageModule;
 	utils: EasemobChat.Utils;
 	logger: EasemobChat.Logger;
 	statusCode: EasemobChat.Code;
@@ -66,6 +67,78 @@ 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
@@ -7704,6 +7777,45 @@ export declare namespace EasemobChat {
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
 		isDelivered?: boolean;
+		/** Whether the message sends the original image. */
+		isOriginalImage?: boolean;
+		/** The original image URL. */
+		originalImageUrl?: string;
+		/** The big image URL. */
+		bigImageUrl?: string;
+	}
+
+	interface ImageFileSource {
+		/** File object for web platforms. */
+		data?: File;
+		/** Local file path for mini program platforms. */
+		path?: string;
+		/** File name. */
+		filename: string;
+		/** MIME type. */
+		filetype?: string;
+		/** File size in bytes. */
+		size?: number;
+	}
+
+	interface CreateImageMessageParameters {
+		chatType: ChatType;
+		to: string;
+		from?: string;
+		file: ImageFileSource;
+		width?: number;
+		height?: number;
+		/** Whether to send the original image. Default is false. */
+		isOriginalImage?: boolean;
+		ext?: { [key: string]: any };
+		msgConfig?: { allowGroupAck: boolean };
+		isChatThread?: boolean;
+		priority?: MessagePriority;
+		deliverOnlineOnly?: boolean;
+		receiverList?: string[];
+		onFileUploadError?: (err: ErrorEvent) => void;
+		onFileUploadComplete?: (data: UploadFileResult) => void;
+		onFileUploadProgress?: (data: ProgressEvent) => void;
 	}
 
 	interface CreateImgMsgParameters {
@@ -7761,6 +7873,8 @@ export declare namespace EasemobChat {
 		thumbnailHeight?: number;
 		/** Whether the image is a gif. */
 		isGif?: boolean;
+		/** Whether to send the original image. Default is false. */
+		isOriginalImage?: boolean;
 	}
 
 	interface AudioParameters {
@@ -8196,6 +8310,8 @@ export declare namespace EasemobChat {
 		static createOldMsg(options: NewMessageParamters): MessageBody;
 		/** Create messages. */
 		static create(options: CreateMsgType): MessageBody;
+		/** Create an image message with SDK-internal upload support. */
+		static createImageMessage(options: CreateImageMessageParameters): ImgMsgBody;
 		/** When sending attachment messages, use this method to obtain the file path. */
 		static getFileUrl: (fileInputId: string | HTMLInputElement) => FileObj;