@tencentcloud/lite-chat 1.1.1-beta.1 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,161 @@
+## [1.2.0] (2025-06-19)
+## Core
+#### Feature
+- `createTextMessage`: 创建文本消息
+- `subscribeUserStatus`: 订阅用户状态
+- `unsubscribeUserStatus`: 取消订阅用户状态
+
+## Plugins
+### conversation
+#### Feature
+- `setMessageRead`: 已读上报
+- `pinConversation`: 会话置顶
+- `deleteConversation`: 删除会话
+- `setMessageRemindType`: 消息免打扰
+- `setConversationDraft`: 会话草稿
+- 群@消息展示
+
+### message-enhancer
+#### Feature
+- `createFaceMessage`: 创建表情消息
+- `createTextAtMessage`: 创建文本@消息
+- `createForwardMessage`: 创建转发消息
+- `createMergerMessage`: 创建合并消息
+- `downloadMergerMessage`: 下载合并消息
+- `translateText`: 翻译文本消息
+- `convertVoiceToText`: 语音转文字
+- `addMessageReaction`: 添加消息回应
+- `removeMessageReaction`: 删除消息回应
+- `getMessageReactions`: 批量获取多条消息回应信息
+- `getAllUserListOfMessageReaction`: 分页拉取指定消息回应的用户列表
+- `sendMessageReadReceipt`: 发送消息已读回执
+- `getMessageReadReceiptList`: 获取消息已读回执列表
+- `getGroupMessageReadMemberList`: 获取群消息已读（或未读）群成员列表
+- `findMessage`: 根据 messageID 查询会话的本地消息
+- `getMessageList`: 获取历史消息列表（支获取单聊）
+- `getMessageListHopping`: 根据指定的消息 sequence(群聊) 或 time(单聊) 获取历史消息（支获取单聊）
+- 从 message-enhancer 插件移除 `createTextMessage`
+
+### cloud-search
+#### Feature
+- `searchCloudMessages`: 搜索云端消息
+- `searchCloudUsers`: 搜索云端用户
+- `searchCloudGroupMembers`: 搜索云端群成员列表
+
+### group
+#### Feature
+- `getGroupList`: 获取已加入的群组列表
+- `getGroupProfile`: 获取群资料
+- `createGroup`: 创建群组
+- `dismissGroup`: 解散群组
+- `updateGroupProfile`: 更新群资料
+- `joinGroup`: 申请加群
+- `quitGroup`: 主动退群
+- `searchGroupByID`: 通过群ID搜索群组
+- `getGroupOnlineMemberCount`: 获取群在线人数
+- `getGroupApplicationList`: 获取加群申请列表
+- `handleGroupApplication`: 处理加群申请和邀请进群申请
+- `initGroupAttributes`: 初始化群属性
+- `setGroupAttributes`: 设置群属性
+- `deleteGroupAttributes`: 删除群属性
+- `getGroupAttributes`: 获取群属性
+- `getGroupMemberList`: 获取群成员列表
+- `getGroupMemberProfile`: 获取群成员资料
+- `addGroupMember`: 添加群成员
+- `deleteGroupMember`: 删除群成员
+- `setGroupMemberMuteTime`: 设置群成员禁言
+- `setGroupMemberRole`: 设置群成员角色
+- `setGroupMemberNameCard`: 设置群成员名片
+- `setGroupMemberCustomField`: 设置群成员自定义字段
+注意： 以上接口均不支持社群和直播群。
+
+### friend
+#### Feature
+- `getBlacklist`: 获取黑名单列表
+- `addToBlacklist`: 添加用户到黑名单列表
+- `removeFromBlacklist`: 从黑名单列表中移除用户
+- `getFriendList`: 获取好友列表
+- `addFriend`: 添加好友
+- `deleteFriend`: 删除好友
+- `checkFriend`: 检验好友关系
+- `getFriendProfile`: 获取好友全量资料
+- `updateFriend`: 更新好友关系链数据
+- `getFriendApplicationList`: 获取好友申请列表
+- `acceptFriendApplication`: 接受好友申请
+- `refuseFriendApplication`: 拒绝好友申请
+- `deleteFriendApplication`: 删除好友申请
+- `setFriendApplicationRead`: 设置好友申请已读
+- `getFriendGroupList`: 获取好友分组列表
+- `createFriendGroup`: 创建好友分组
+- `deleteFriendGroup`: 删除好友分组
+- `addToFriendGroup`: 添加好友到分组
+- `removeFromFriendGroup`: 从分组中移除好友
+- `renameFriendGroup`: 修改好友分组名称
+
+# 1.1.1 (2025-04-29)
+## Core
+#### Feature
+- 优化 SDK 导出方式，兼容 require 引用。
+- 增加插件 ts 类型声明。
+
+# 1.1.0 (2025-04-18)
+新增插件注册功能，新增会话管理、富媒体消息和消息增强插件。
+## Core
+#### Feature
+- `use`: 注册插件
+- `sendMessage`: 支持发送群消息   
+
+## Plugins
+### conversation
+参考教程：[集成会话插件](https://cloud.tencent.com/document/product/269/117335#4fab05e6-27ac-4f78-9bb8-d5bb31f2138a)。
+#### Feature
+- `getConversationList`: 获取会话列表
+- `getConversationProfile`: 获取会话资料
+- `getTotalUnreadMessageCount`: 获取消息未读总数
+
+### rich-media-message
+参考教程：[集成富媒体消息插件](https://cloud.tencent.com/document/product/269/117335#387fe2f-d973-4161-b9bb-5926396fbb0d)。
+#### Feature
+- `createImageMessage`: 创建图片消息
+- `createAudioMessage`: 创建语音消息
+- `createVideoMessage`: 创建视频消息
+- `createFileMessage`: 创建文件消息
+
+### message-enhancer
+参考教程：[集成消息增强插件](https://cloud.tencent.com/document/product/269/117335#672e1edd-b8b4-4143-baa6-16487e2c321f)
+#### Feature
+- `createTextMessage`: 创建文本消息
+- `deleteMessage`: 删除消息
+- `revokeMessage`: 撤回消息
+- `resendMessage`: 重发消息
+- `getMessageList`: 获取消息列表（仅支持群消息）
+- `getMessageListHopping`: 根据指定的消息 sequence 拉取会话的消息列表（仅支持群消息）
+- 支持断网恢复群会话历史消息。
+
+# 1.0.0 (2025-03-21)
+
+[Tencent Cloud Lite Chat SDK]() 是 [Tencent Cloud Chat SDK](https://www.npmjs.com/package/@tencentcloud/chat) 的轻量级替代方案，使用微内核架构，内核实现核心功能，并支持通过插件扩展。
+
+## Core
+#### Feature
+- `create`: 创建 SDK 实例
+- `destroy`: 销毁 SDK 实例
+- `on`: 监听事件
+- `off`: 取消监听事件
+- `login`: 登录
+- `logout`: 登出
+- `getLoginUser`: 已登录返回登录用户的 userID，未登录返回空字符串
+- `sendMessage`: 发送消息，只支持 C2C 消息
+- `createCustomMessage`: 创建自定义消息
+- `getMyProfile`: 获取个人资料
+- `getUserProfile`: 获取其他用户资料
+- `updateMyProfile`: 更新个人资料
+- `setSelfStatus`: 设置自己的自定义状态
+- `getUserStatus`: 查询用户状态
+- `addSignalingListener`: 监听信令事件
+- `removeSignalingListener`: 移除监听信令事件
+- `invite`: 邀请某个人
+- `cancel`: 邀请发起者取消邀请
+- `accept`: 被邀请人接收邀请
+- `reject`: 被邀请人拒绝邀请
+- `modifyInvitation`: 修改邀请信令

package/README.md

@@ -15,7 +15,12 @@ npm install @tencentcloud/lite-chat --save
 ### 1. create an SDK instance
 
 ```javascript
+// import Core
 import TencentCloudLiteChat from '@tencentcloud/lite-chat';
+// import Plugins
+import conversationPlugin from '@tencentcloud/lite-chat/plugins/conversation';
+import richMediaMessagePlugin from '@tencentcloud/lite-chat/plugins/rich-media-message';
+import messageEnhancerPlugin from '@tencentcloud/lite-chat/plugins/message-enhancer'; 
 
 // Create an SDK instance. 
 // The `TencentCloudLiteChat.create()` method returns the same instance for the same `SDKAppID`.
@@ -23,6 +28,11 @@ import TencentCloudLiteChat from '@tencentcloud/lite-chat';
 let chat = TencentCloudLiteChat.create({
   SDKAppID: 0 // Replace `0` with the `SDKAppID` of your Chat app during access.
 }); 
+
+// register plugins
+chat.use(conversationPlugin);
+chat.use(richMediaMessagePlugin);
+chat.use(messageEnhancerPlugin);
 ```
 
 ### 2. Generate UserSig