agora-chat - npm Package Compare versions

Comparing version 1.0.8 to 1.1.0

CHANGELOG.md

 # Changes to Agora chat
 
+## 1.1.0 (Mar 8, 2023)
+
+-   Get session list api `getConversationlist` supports paging
+-   Add group and chat room notification event 'create'
+-   Optimize miniCore size
+-   Added removeHistoryMessages one-way delete roaming message api
+-   Add chat message priority
+-   Add chat room custom attribute function
+-   Fix some Typescript type errors
+
 ## 1.0.8 (Dec 19, 2022)
@@ -4,0 +14,0 @@

chatroom/chatroom.d.ts

@@ -590,2 +590,14 @@ import * as ChatRoomTypes from '../types/chatRoomApi';
 	}): Promise<AsyncResult<ChatRoomTypes.ChatroomAttributes>>;
+
+	/**
+	 * Check whether you are on the chat room mute list.
+	 *
+	 * ```typescript
+	 * connection.isInChatRoomMutelist({chatRoomId: 'chatRoomId'})
+	 * ```
+	 */
+	isInChatRoomMutelist(params: {
+		/** The chat room ID. */
+		chatRoomId: string;
+	}): Promise<boolean>;
 }

contact/contact.d.ts

@@ -46,3 +46,8 @@ import * as IndexTypes from '../types/indexApi';
 	 */
-	getConversationlist(): Promise<AsyncResult<IndexTypes.SessionInfo[]>>;
+	getConversationlist(parames?: {
+		/** The page number, starting from 1. */
+		pageNum?: number;
+		/** The number of conversation per page. The value cannot exceed 20. */
+		pageSize?: number;
+	}): Promise<AsyncResult<IndexTypes.SessionInfo[]>>;
 
@@ -82,3 +87,3 @@ /**
 		params: IndexTypes.UpdateOwnUserInfoParams | IndexTypes.ConfigurableKey,
-		value?: any
+		value?: string
 	): Promise<AsyncResult<IndexTypes.UpdateOwnUserInfoParams>>;
@@ -292,15 +297,12 @@
 	 */
-	getReactionDetail(
-		this: Connection,
-		params: {
-			/** The message ID. */
-			messageId: string;
-			/** The reactions to retrieve. */
-			reaction: string;
-			/** The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be retrieved.*/
-			cursor?: string;
-			/** The number of reactions per page. The default value is 20, and the maximum value is 100. */
-			pageSize?: number;
-		}
-	): Promise<AsyncResult<ReactonTypes.GetReactionDetailResult>>;
+	getReactionDetail(params: {
+		/** The message ID. */
+		messageId: string;
+		/** The reactions to retrieve. */
+		reaction: string;
+		/** The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be retrieved.*/
+		cursor?: string;
+		/** The number of reactions per page. The default value is 20, and the maximum value is 100. */
+		pageSize?: number;
+	}): Promise<AsyncResult<ReactonTypes.GetReactionDetailResult>>;
 
@@ -314,13 +316,10 @@ /**
 	 */
-	reportMessage(
-		this: Connection,
-		params: {
-			/** The type of report. */
-			reportType: string;
-			/** The reason for reporting. */
-			reportReason: string;
-			/** ID of the message to be reported. */
-			messageId: string;
-		}
-	): Promise<void>;
+	reportMessage(params: {
+		/** The type of report. */
+		reportType: string;
+		/** The reason for reporting. */
+		reportReason: string;
+		/** ID of the message to be reported. */
+		messageId: string;
+	}): Promise<void>;
 }

group/group.d.ts

@@ -645,2 +645,14 @@ import * as GroupTypes from '../types/groupApi';
 	}): void;
+
+	/**
+	 * Check whether you are on the group mute list.
+	 *
+	 * ```typescript
+	 * connection.isInGroupMutelist({groupId: 'groupId'})
+	 * ```
+	 */
+	isInGroupMutelist(params: {
+		/** The group ID. */
+		groupId: string;
+	}): Promise<boolean>;
 }

package.json

 {
     "name": "agora-chat",
-    "version": "1.0.8",
+    "version": "1.1.0",
     "description": "Agora chat web sdk",
@@ -5,0 +5,0 @@ "main": "Agora-chat",

types/common.d.ts

@@ -1,3 +0,3 @@
-import { Code } from '../status';
-import ErrorEvent from '../error/error';
+import { Code } from './status';
+import ErrorEvent from './error';
 interface AsyncResult<T = any> {
@@ -4,0 +4,0 @@ /** Status of the request. */

types/error.d.ts

@@ -1,2 +0,2 @@
-import { Code } from '../status';
+import { Code } from './status';
 interface ErrorParameters {
@@ -3,0 +3,0 @@ type: Code;

types/indexApi.d.ts

 import { Jid } from './common';
-import { MessagesType } from './message';
-import { LastMessage } from '../types/threadApi';
+import { MessagesType, MessageBody } from './message';
 interface UpdateOwnUserInfoParams {
@@ -13,4 +12,4 @@ /** The nickname. */
 	phone?: string;
-	/** Gender. You can define it with the following type: string, number, boolean. */
-	gender?: string | number | boolean;
+	/** Gender. */
+	gender?: string;
 	/** Signature. */
@@ -20,6 +19,4 @@ sign?: string;
 	birth?: string;
-	/** Extension. You can define it with the following type: string, number, boolean. */
-	ext?: {
-		[key: string]: string | number | boolean;
-	};
+	/** Extension.*/
+	ext?: string;
 }
@@ -88,10 +85,15 @@ /** Configurable fields. */
 }
-interface conversationList {
+interface ConversationList {
 	/** The conversation ID. */
 	channel_id: string;
 	/** Overview of the latest news. */
-	lastMessage: LastMessage;
+	lastMessage: MessageBody | Record<string, never>;
 	/** The number of unread messages. */
 	unread_num: number;
 }
+interface ConversationInfo {
+	/** The conversation list. */
+	/** 会话列表。 */
+	channel_infos: ConversationList[];
+}
 interface DeleteSessionResult {
@@ -126,3 +128,3 @@ /** The result of request. */
 	SessionInfo,
-	conversationList,
+	ConversationList,
 	BaseUserInfo,
@@ -132,2 +134,3 @@ DeleteSessionResult,
 	ContactRelationshipMsg,
+	ConversationInfo,
 };
@@ -134,0 +137,0 @@ export type {

types/threadApi.d.ts

@@ -147,3 +147,3 @@ /**
 	/** The last threaded reply. */
-	lastMessage?: MessageBody | {};
+	lastMessage?: MessageBody | Record<string, never>;
 	/** The operation object. */
@@ -150,0 +150,0 @@ userName?: string;

No alert changes

Improved metrics

Number of package files

48

increased by2.13%

Lines of code

12124

increased by3.37%

Worsened metrics

Total package byte prevSize

1341379

decreased by-38.69%

No dependency changes