easemob-websdk 4.2.0-beta → 4.2.1-beta

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "easemob-websdk",
-    "version": "4.2.0-beta",
+    "version": "4.2.1-beta",
     "description": "Easemob chat websdk",
     "main": "Easemob-chat",
     "scripts": {

package/presence/presence.d.ts

@@ -65,3 +65,5 @@ export interface Presence {
 		usernames: UserId[];
 	}): Promise<AsyncResult<PresenceTypes.SubscribePresenceResult>>;
 }
+
+export {AsyncResult, UserId, PresenceTypes}

package/silent/silent.d.ts

@@ -108,3 +108,5 @@ export interface Silent {
 		AsyncResult<SilentModeType.TranslationLanguageType>
 	>;
 }
+
+export {AsyncResult, SilentModeType}

package/status.d.ts

@@ -0,0 +1,160 @@
+/**
+ * The error codes in the SDK.
+ * Defines error codes commonly used in the SDK.
+ * @module StatusCode
+ */
+declare enum Code {
+	/** No error. */
+	REQUEST_SUCCESS = 0,
+	/** The server response times out. */
+	REQUEST_TIMEOUT = -1,
+	/** A general error.  */
+	REQUEST_UNKNOWN = -2,
+	/** The parameter is invalid. */
+	REQUEST_PARAMETER_ERROR = -3,
+	/** The request is canceled. */
+	REQUEST_ABORT = -4,
+	/** @hidden */
+	WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR = 0,
+	/** Login failed.  */
+	WEBIM_CONNCTION_OPEN_ERROR = 1,
+	/** The user authentication fails. The reasons are as follows. The SDK is not initiated. The user is not login. */
+	WEBIM_CONNCTION_AUTH_ERROR = 2,
+	/** Fails to get the token. */
+	WEBIM_CONNCTION_GETROSTER_ERROR = 12,
+	/** Websocket is disconnected */
+	WEBIM_CONNCTION_DISCONNECTED = 16,
+	/** A general error.  */
+	WEBIM_CONNCTION_AJAX_ERROR = 17,
+	/** The App Key is invalid. */
+	WEBIM_CONNCTION_APPKEY_NOT_ASSIGN_ERROR = 27,
+	/** The token is invalid. */
+	WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR = 28,
+	/** The callback inner error code while the message is successfully sent. */
+	WEBIM_CONNCTION_CALLBACK_INNER_ERROR = 31,
+	/** The current user is offline. */
+	WEBIM_CONNCTION_CLIENT_OFFLINE = 32,
+	/** The user is not logged in.*/
+	WEBIM_CONNECTION_CLOSED = 39,
+	/** The user authentication fails. */
+	WEBIM_CONNECTION_ERROR = 40,
+	/** The upper limit is reached. */
+	MAX_LIMIT = 50,
+	/** The message is not found. */
+	MESSAGE_NOT_FOUND = 51,
+	/** Unauthorized operation. */
+	NO_PERMISSION = 52,
+	/** Unsupported Operation. */
+	OPERATION_UNSUPPORTED = 53,
+	/** An operation that is not allowed. */
+	OPERATION_NOT_ALLOWED = 54,
+	/** A local database operation failed. */
+	LOCAL_DB_OPERATION_FAILED = 55,
+	/** The uploading of the file failed. */
+	WEBIM_UPLOADFILE_ERROR = 101,
+	/** The current user is not logged in when uploading the file. */
+	WEBIM_UPLOADFILE_NO_LOGIN = 102,
+	/** File-downloading failed. */
+	WEBIM_DOWNLOADFILE_ERROR = 200,
+	/** Parse file failed. */
+	PARSE_FILE_ERROR = 203,
+	/** User does not found. */
+	USER_NOT_FOUND = 204,
+	/** The message parameter is invalid. */
+	MESSAGE_PARAMETER_ERROR = 205,
+	/** The user is logged in on another device. */
+	WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE = 206,
+	/** The user was removed. */
+	WEBIM_CONNCTION_USER_REMOVED = 207,
+	/** The password is renewed. */
+	WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD = 216,
+	/** The user was kicked off from another device. */
+	WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE = 217,
+	/** Global muted. */
+	USER_MUTED_BY_ADMIN = 219,
+	/**
+	 * The user is not on your contact list, and you cannot send messages to him or her.
+	 * Note: You can send messages to strangers by default. This error occurs only when you enable the function of allowing to send messages only to your contacts.
+	 */
+	USER_NOT_FRIEND = 221,
+	/** The server is busy. */
+	SERVER_BUSY = 500,
+	/** The message content contains illegal or sensitive words. */
+	MESSAGE_INCLUDE_ILLEGAL_CONTENT = 501,
+	/** The message was blocked. */
+	MESSAGE_EXTERNAL_LOGIC_BLOCKED = 502,
+	/** Unknown error. */
+	SERVER_UNKNOWN_ERROR = 503,
+	/** The message recall has exceeded the time limit.*/
+	MESSAGE_RECALL_TIME_LIMIT = 504,
+	/** The service is not enabled. */
+	SERVICE_NOT_ENABLED = 505,
+	/** The message fails to be delivered because the user is not on the allow list.*/
+	SERVICE_NOT_ALLOW_MESSAGING = 506,
+	/** The current user is muted. */
+	SERVICE_NOT_ALLOW_MESSAGING_MUTE = 507,
+	/** The message is blocked by the Moderation service. */
+	MESSAGE_MODERATION_BLOCKED = 508,
+	/** Group chat ID current limiting. */
+	MESSAGE_CURRENT_LIMITING = 509,
+	/** The network is disconnected, causing message sending failure. */
+	MESSAGE_WEBSOCKET_DISCONNECTED = 510,
+	/** You have exceeded the maximum allowed size of a message body.*/
+	MESSAGE_SIZE_LIMIT = 511,
+	/** The group is not found. */
+	GROUP_NOT_EXIST = 605,
+	/** The user being operated is not in the group. */
+	GROUP_NOT_JOINED = 602,
+	/** The number of members in the group reaches the limit. */
+	GROUP_MEMBERS_FULL = 606,
+	/** Permission denied. */
+	PERMISSION_DENIED = 603,
+	/** Internal error. */
+	WEBIM_LOAD_MSG_ERROR = 604,
+	/** The current user is already in the group. */
+	GROUP_ALREADY_JOINED = 601,
+	/** The maximum number of group members exceeds the limit during group creation. */
+	GROUP_MEMBERS_LIMIT = 607,
+	/** Group disabled */
+	/** @hidden */
+	GROUP_IS_DISABLED = 608,
+	/** Failed to set the custom attributes of a group member. */
+	GROUP_MEMBER_ATTRIBUTES_SET_FAILED = 609,
+	/** Invalid token or App Key. */
+	REST_PARAMS_STATUS = 700,
+	/** The user being operated is not in the chatroom. */
+	CHATROOM_NOT_JOINED = 702,
+	/** The number of chatroom members reaches the limit.*/
+	CHATROOM_MEMBERS_FULL = 704,
+	/** The chatroom is not found. */
+	CHATROOM_NOT_EXIST = 705,
+	/** Websocket error. */
+	SDK_RUNTIME_ERROR = 999,
+	/** The parameter length exceeds the limit when posting custom presence status. */
+	PRESENCE_PARAM_EXCEED = 1100,
+	/** The Reaction already exists. */
+	REACTION_ALREADY_ADDED = 1101,
+	/** A Reaction is being created by multiple users at the same time. */
+	REACTION_CREATING = 1102,
+	/** The user does not have the permission for the Reaction operation. For example, the user who does not add the reaction attempts to delete it, or the user that is neither the sender nor recipient of the one-to-one message attempts to add the Reaction. */
+	REACTION_OPERATION_IS_ILLEGAL = 1103,
+	/** Invalid language code. */
+	TRANSLATION_NOT_VALID = 1200,
+	/** The translated text is too long. */
+	TRANSLATION_TEXT_TOO_LONG = 1201,
+	/** Failed to obtain the translation service. */
+	TRANSLATION_FAILED = 1204,
+	/** The chatThread is not found. */
+	THREAD_NOT_EXIST = 1300,
+	/** Chat thread already exists. */
+	THREAD_ALREADY_EXIST = 1301,
+	/** The message to modify does not exist. */
+	MODIFY_MESSAGE_NOT_EXIST = 1302,
+	/** The format of the modified messaged is incorrect. */
+	MODIFY_MESSAGE_FORMAT_ERROR = 1303,
+	/** The message modification failed. */
+	MODIFY_MESSAGE_FAILED = 1304,
+	/** The current conversation not exist . */
+	CONVERSATION_NOT_EXIST = 1400,
+}
+export { Code };

package/thread/thread.d.ts

@@ -155,3 +155,5 @@ export interface Thread {
 		chatThreadId: string;
 	}): Promise<AsyncResult<ThreadTypes.ChatThreadDetail>>;
 }
+
+export { ThreadTypes, AsyncResult };

package/translation/translation.d.ts

@@ -26,3 +26,5 @@ export interface Translation {
 		languages: string[];
 	}): Promise<AsyncResult<TranslationTypes.TranslationResult>>;
 }
+
+export { AsyncResult, TranslationTypes };

package/types/common.d.ts

@@ -1,5 +1,6 @@
-import { Code } from './status';
+import { Code } from '../status';
 import ErrorEvent from './error';
+import { GroupModifyInfo } from './groupApi';
 interface AsyncResult<T = any> {
 	/** Status of the request. */
 	type: Code;
@@ -38,13 +39,34 @@ interface EventData {
 	id: string;
 	/** Message sender. */
 	from: string;
+	/** The modified group info. */
+	detail?: GroupModifyInfo;
 	/** The name of a group or chatroom.  */
 	name?: string;
+	/** The userId of a group event.  */
+	userId?: string;
 	/** ChatRoom Attributes.  */
 	attributes?: {
 		[key: string]: string;
 	};
 }
+
+interface AttributeRespData {
+	is_forced: boolean;
+	operator: string;
+	properties: {
+		[key: string]: string;
+	};
+	result: {
+		errorKeys: {
+			[key: string]: string;
+		};
+		successKeys: Array<string>;
+	};
+	keys?: Array<string>;
+	auto_delete?: boolean;
+}
+
 export type {
 	AsyncResult,
 	UserId,
@@ -53,4 +75,5 @@ export type {
 	ErrorEvent,
 	Jid,
 	EventData,
+	AttributeRespData,
 };

package/types/engineCore.d.ts

@@ -1,5 +1,5 @@
 import { GroupId, UserId } from './common';
-import { MemberAttributes } from './groupApi';
+import { GroupModifyInfo, MemberAttributes } from './groupApi';
 
 declare type OnPresenceMsgType =
 	| 'rmChatRoomMute'
@@ -58,6 +58,7 @@ interface PresenceMsg {
 	reason?: string;
 	kicked?: string;
 	groupName?: string;
+	detail?: GroupModifyInfo;
 }
 interface SendMsgResult {
 	/** The local ID of the message. */
@@ -121,7 +122,7 @@ interface ConversationChangedInfo {
 	timestamp: number;
 }
 
-type MultiDeviceEvent =
+declare type MultiDeviceEvent =
 	| ThreadMultiDeviceInfo
 	| ConversationChangedInfo
 	| RoamingDeleteMultiDeviceInfo
@@ -135,4 +136,6 @@ export type {
 	multiDeviceEventType,
 	MultiDeviceEvent,
 	ConversationChangedInfo,
+	RoamingDeleteMultiDeviceInfo,
+	GroupMemberAttributesUpdateMultiDeviceInfo,
 };

package/types/error.d.ts

@@ -1,4 +1,4 @@
-import { Code } from './status';
+import { Code } from '../status';
 interface ErrorParameters {
 	type: Code;
 	message: string;
@@ -9,4 +9,5 @@ declare class ErrorEvent {
 	message: string;
 	data?: any;
 }
+
 export type { ErrorParameters, ErrorEvent };

package/types/eventHandler.d.ts

@@ -1,5 +1,6 @@
 import {
 	TextMsgBody,
+	CombineMsgBody,
 	DeliveryMsgBody,
 	ChannelMsgBody,
 	CmdMsgBody,
@@ -81,6 +82,7 @@ declare type Event =
 	| 'onOpened'
 	| 'onPresence'
 	| 'onTextMessage'
+	| 'onCombineMessage'
 	| 'onImageMessage'
 	| 'onAudioMessage'
 	| 'onVideoMessage'
@@ -245,8 +247,16 @@ export interface GroupEvent {
 	detail?: GroupModifyInfo;
 }
 interface EventHandlerType {
+	/** @hidden */
+	onOpened?: (msg: any) => void;
+	/** @hidden */
+	onClosed?: (msg: any) => void;
+	/** @hidden */
+	onPresence?: (msg: OnPresenceMsg) => void;
 	/** The callback to receive a text message. */
 	onTextMessage?: (msg: TextMsgBody) => void;
+	/** The callback to receive a combine message. */
+	onCombineMessage?: (msg: CombineMsgBody) => void;
 	/** The callback to receive a image message. */
 	onImageMessage?: (msg: ImgMsgBody) => void;
 	/** The callback to receive a audio message. */
@@ -301,6 +311,12 @@ interface EventHandlerType {
 	onReconnecting?: () => void;
 	/** The callback for disconnected. */
 	onDisconnected?: () => void;
+	/** @hidden The callback to receive a group event. */
+	onGroupChange?: (msg: any) => void;
+	/** @hidden The callback to receive a chatroom event. */
+	onChatroomChange?: (msg: any) => void;
+	/** @hidden The callback to receive a contact event. */
+	onContactChange?: (msg: any) => void;
 	/** Occurs when the presence state of a subscribed user changes. */
 	onPresenceStatusChange?: (msg: PresenceType[]) => void;
 	/** The callback to receive a thread event. */

package/types/groupApi.d.ts

@@ -55,12 +55,13 @@ interface GroupDetailInfo {
 	allowinvites: boolean;
 	/** The Unix timestamp when the group is created. */
 	created: number;
+	/** The custom information. */
 	custom: string;
 	/** The group description. */
 	description: string;
 	/** The group ID. */
 	id: string;
-	/** The maximum number of group members */
+	/** The maximum number of group members. */
 	maxusers: number;
 	/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
 	membersonly: boolean;
@@ -247,10 +248,10 @@ interface GroupModifyInfo {
 	allowInvites?: boolean;
 	/** The maximum number of group members */
 	maxUsers?: number;
-	/** Whether the invitee needs to accept the invitation before joining the group. 
-				- `true`: The invitee's consent is required. The default value is `true`.
-				- `false`: The invitee will be directly added to the group without confirmation.  
-				*/
+	/** Whether the invitee needs to accept the invitation before joining the group.
+  - `true`: The invitee's consent is required. The default value is `true`.
+  - `false`: The invitee will be directly added to the group without confirmation.
+  */
 	inviteNeedConfirm?: boolean;
 	/** Group detail extensions. */
 	ext?: string;
@@ -258,9 +259,9 @@ interface GroupModifyInfo {
 	lastModified?: number;
 }
 
-type MemberAttributes = Record<string, string>;
+declare type MemberAttributes = Record<string, string>;
 
-type GetGroupMembersAttributesResult = Record<UserId, MemberAttributes>;
+declare type GetGroupMembersAttributesResult = Record<UserId, MemberAttributes>;
 
 export type {
 	GroupRequestResult,

package/types/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The type definition of the return value
+ * @module Types
+ */
+import * as GroupType from './groupApi';
+import * as ChatRoomType from './chatRoomApi';
+import * as Connection from './engineCore';
+import * as Error from './error';
+import * as EventHandlerType from './eventHandler';
+import * as ContactType from './indexApi';
+import * as Message from './message';
+import * as Common from './common';
+import * as PresenceType from './presenceApi';
+import * as ReactionType from './reactionApi';
+import * as ThreadType from './threadApi';
+import * as TranslationType from './translation';
+import * as SilentModeType from './silentModeApi';
+export type {
+	ContactType,
+	GroupType,
+	ChatRoomType,
+	Connection,
+	EventHandlerType,
+	PresenceType,
+	ReactionType,
+	TranslationType,
+	ThreadType,
+	SilentModeType,
+	Message,
+	Error,
+	Common,
+};

package/types/indexApi.d.ts

@@ -108,7 +108,7 @@ interface ModifyMsgResult extends SendMsgResult {
 	message: ModifiedMsg;
 }
 interface HistoryMessages {
-	/** 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. */
+	/** The starting message ID for the next query. If the number of messages returned by the SDK is smaller than the requested number, the cursor will be `undefined`. */
 	cursor?: string;
 	/** The historical messages. */
 	messages: MessagesType[];
@@ -132,7 +132,7 @@ interface ConversationItem {
 	conversationId: string;
 	/** The conversation type. */
 	conversationType: 'singleChat' | 'groupChat';
-	/** Whether the conversation is pinned. `true`: pinned; `false`: unpinned. */
+	/** Whether the conversation is pinned. `true`:pinned; `false`: unpinned. */
 	isPinned: boolean;
 	/** The UNIX timestamp when the conversation is pinned. The unit is millisecond. This value is `0` when conversation is not pinned. */
 	pinnedTime: number;

package/types/localCache.d.ts

@@ -0,0 +1,53 @@
+/**
+ * localCache types
+ * @module TYPES
+ */
+
+import {
+	MessageBody,
+	DeliveryMsgBody,
+	ChannelMsgBody,
+	ReadMsgBody,
+	ChatType,
+	CmdMsgBody,
+} from '../types/message';
+declare type LocalMessageBody = Exclude<
+	MessageBody,
+	DeliveryMsgBody | ReadMsgBody | ChannelMsgBody | CmdMsgBody
+>;
+declare type ConversationType = Exclude<ChatType, 'chatRoom'>;
+interface ConversationItem {
+	/** The conversation ID. */
+	conversationId: string;
+	/** The conversation type. */
+	conversationType: ConversationType;
+	/** The number of unread messages in the conversation. */
+	unReadCount?: number;
+	/** The last message in the conversation. */
+	lastMessage?: LocalMessageBody;
+	/** The conversation custom field. */
+	customField?: Record<string, any>;
+}
+declare type SessionParams = Pick<
+	ConversationItem,
+	'conversationId' | 'conversationType'
+>;
+declare type RemoveLocalConversationParams = SessionParams &
+	isRemoveLocalMessage;
+declare type isRemoveLocalMessage = {
+	/** Whether to delete the historical messages with the conversation. (Default) `true`: Yes; `false`: No. Historical messages of the conversation remain in the local database even if the conversation is deleted. */
+	isRemoveLocalMessage?: boolean;
+};
+declare type UpdateConversationParams = Pick<
+	ConversationItem,
+	'conversationId' | 'conversationType' | 'customField'
+>;
+export type {
+	ConversationItem,
+	SessionParams,
+	RemoveLocalConversationParams,
+	UpdateConversationParams,
+	isRemoveLocalMessage,
+	LocalMessageBody,
+	ConversationType,
+};

package/types/message.d.ts

@@ -818,7 +818,6 @@ declare type MessageBody =
  * The priority of chat room messages.
  *
  *  Currently, this attribute is available only to chat room messages. If this attribute is not set, messages are assigned a medium priority. */
-
 declare type MessagePriority =
 	/** High. */
 	| 'high'

package/types/presenceApi.d.ts

@@ -2,10 +2,6 @@
  * presence types
  * @module TYPES
  */
-interface PublishPresenceResult {
-	/** The result of publish. */
-	result: 'ok';
-}
 interface SubscribePresence {
 	/** The expiration time of the presence subscription. */
 	expiry: number;
@@ -55,7 +51,6 @@ interface PresenceType {
 	expire: number;
 }
 export type {
-	PublishPresenceResult,
 	SubscribePresence,
 	SubscribePresenceResult,
 	SubscribeUserListType,

package/types/threadApi.d.ts

@@ -121,7 +121,13 @@ interface ChatThreadLastMessage {
 	/** The last threaded reply. */
 	lastMessage: MessageBody;
 }
-/** The definition of the message thread event types. */
+/**
+ * The definition of the message thread event types: <br/>
+ * create: Occurs when creating a chat thread.<br/>
+ * update: Occurs when there is a new message in the chat thread.<br/>
+ * destroy: Occurs when a chat thread is deleted.<br/>
+ * userRemove: Occurs when you were kicked out of chat thread.<br/>
+ */
 declare type onChatThreadChangeType =
 	| 'create'
 	| 'update'

package/types/utils.d.ts

@@ -0,0 +1,90 @@
+import { Code } from '../status';
+interface AsyncResult<T = any> {
+	/** Status of the request. */
+	type: Code;
+	/** Data returned by successful request. */
+	data?: T;
+	/** message. */
+	message?: string;
+	[key: string]: any;
+}
+interface uri {
+	url: string;
+	filename: string;
+	filetype: string;
+	data: File | null;
+}
+interface KVString {
+	[key: string]: string;
+}
+interface AjaxOptions {
+	url: string;
+	dataType?: string;
+	type?: string;
+	data?: any;
+	headers?: KVString;
+	responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
+	mimeType?: string;
+	success?: (res: any) => void;
+	error?: (res: any) => void;
+}
+interface UploadFileOptions {
+	onFileUploadProgress?: (msg: any) => void;
+	onFileUploadComplete?: (msg: any) => void;
+	onFileUploadError?: (msg: any) => void;
+	onFileUploadCanceled?: (msg: any) => void;
+	accessToken: string;
+	appKey: string;
+	apiUrl: string;
+	uploadUrl?: string;
+	file: any;
+}
+declare type Fns = (...args: any) => any;
+declare enum PLATFORM {
+	WEB = 'web',
+	WX = 'wx',
+	ZFB = 'zfb',
+	DD = 'dd',
+	TT = 'tt',
+	BAIDU = 'baidu',
+	QUICK_APP = 'quick_app',
+	UNI = 'uni',
+	NODE = 'node',
+}
+interface EnvInfo {
+	platform: PLATFORM;
+	global: any;
+}
+interface DownloadParams {
+	onFileDownloadComplete: (data: any) => void;
+	onFileDownloadError: (error: any) => void;
+	id: string;
+	secret: string;
+	[key: string]: any;
+}
+interface Utils {
+	/** @hidden */
+	autoIncrement: number;
+	getUniqueId: () => string;
+	/** @hidden */
+	ajax: (options: AjaxOptions) => Promise<AsyncResult<any>>;
+	getFileUrl: (fileInputId: string | HTMLInputElement) => uri;
+	uploadFile: (options: UploadFileOptions) => void;
+	/** @hidden */
+	flow: (fns: Fns[]) => any;
+	listenNetwork: (online: () => void, offline: () => void) => void;
+	getEnvInfo: () => EnvInfo;
+	/** @hidden */
+	wxRequest: (options: AjaxOptions) => Promise<AsyncResult<any>>;
+	/** @hidden */
+	parseDownloadResponse: (res: any) => string;
+	download: (params: DownloadParams) => void;
+}
+export type {
+	Utils,
+	DownloadParams,
+	EnvInfo,
+	PLATFORM,
+	UploadFileOptions,
+	uri,
+};