chore: bump version 10.7.0

Signed-off-by: Dylan <[email protected]>

Author: nmgwddj

CMakeLists.txt

@@ -39,14 +39,14 @@ elseif (CONAN_SETTINGS_ARCH STREQUAL "armv8")
     set(CMAKE_JS_ARCH "arm64")
 endif ()
 if (TARGET nim_cpp_wrapper)
-    execute_process(COMMAND ${NPM_EXUTABLE} install --ignoreDownloadSdk --force
+    execute_process(COMMAND ${NPM_EXUTABLE} install --ignoreDownloadSdk
         WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
         OUTPUT_QUIET)
 else ()
     list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/.cmake/")
     include(PlatformSettings)
     include(GetGitRevisionDescription)
-    execute_process(COMMAND ${NPM_EXUTABLE} install --nimSdkUrl=${NIM_SDK_URL} --force
+    execute_process(COMMAND ${NPM_EXUTABLE} install --nimSdkUrl=${NIM_SDK_URL}
         WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
         OUTPUT_QUIET)
 endif ()

package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-nim",
-    "version": "10.6.1",
+    "version": "10.7.0",
     "description": "NetEase IM nodejs wrapper based on NetEase IM C++ SDK",
     "main": "dist/node-nim.js",
     "bin": {
@@ -61,9 +61,6 @@
         "sinon": "^18.0.0",
         "typedoc": "^0.26.6",
         "typedoc-github-theme": "^0.1.2",
-        "typedoc-github-wiki-theme": "^2.0.0",
-        "typedoc-material-theme": "^1.1.0",
-        "typedoc-plugin-markdown": "^4.2.6",
         "typescript": "^4.9.5"
     },
     "keywords": [

src/callback_specialization.h

@@ -214,6 +214,8 @@ CallbackSpecialization(V2NIMSuccessCallback<const nstd::vector<V2NIMUserStatusSu
 CallbackSpecialization(V2NIMSuccessCallback<const V2NIMChatroomQueueElement&>);
 CallbackSpecialization(V2NIMSuccessCallback<const nstd::vector<V2NIMChatroomQueueElement>&>);
 CallbackSpecialization(V2NIMSuccessCallback<const V2NIMProxyResponse&>);
+CallbackSpecialization(V2NIMSuccessCallback<const V2NIMCollectionListResult&>);
+CallbackSpecialization(V2NIMSuccessCallback<const V2NIMMessageSearchResult&>);
 
 namespace xpack {
 // std::function

src/v2/v2_node_nim_message_service.cpp

@@ -5,31 +5,44 @@ namespace node_nim {
 
 Napi::Object node_nim::V2NodeNIMMessageService::Init(Napi::Env env, Napi::Object exports) {
     return InternalInit("V2NIMMessageService", env, exports,
-        {RegApi("sendMessage", &V2NIMMessageService::sendMessage), RegApi("replyMessage", &V2NIMMessageService::replyMessage),
-            RegApi("revokeMessage", &V2NIMMessageService::revokeMessage), RegApi("modifyMessage", &V2NIMMessageService::modifyMessage),
-            RegApi("getMessageList", &V2NIMMessageService::getMessageList), RegApi("getMessageListByIds", &V2NIMMessageService::getMessageListByIds),
+        {
+            RegApi("sendMessage", &V2NIMMessageService::sendMessage),
+            RegApi("replyMessage", &V2NIMMessageService::replyMessage),
+            RegApi("revokeMessage", &V2NIMMessageService::revokeMessage),
+            RegApi("modifyMessage", &V2NIMMessageService::modifyMessage),
+            RegApi("getMessageList", &V2NIMMessageService::getMessageList),
+            RegApi("getMessageListByIds", &V2NIMMessageService::getMessageListByIds),
             RegApi("getMessageListByRefers", &V2NIMMessageService::getMessageListByRefers),
             RegApi("getThreadMessageList", &V2NIMMessageService::getThreadMessageList),
             RegApi("getLocalThreadMessageList", &V2NIMMessageService::getLocalThreadMessageList),
-            RegApi("deleteMessage", &V2NIMMessageService::deleteMessage), RegApi("deleteMessages", &V2NIMMessageService::deleteMessages),
+            RegApi("deleteMessage", &V2NIMMessageService::deleteMessage),
+            RegApi("deleteMessages", &V2NIMMessageService::deleteMessages),
             RegApi("clearHistoryMessage", &V2NIMMessageService::clearHistoryMessage),
             RegApi("updateMessageLocalExtension", &V2NIMMessageService::updateMessageLocalExtension),
-            RegApi("insertMessageToLocal", &V2NIMMessageService::insertMessageToLocal), RegApi("pinMessage", &V2NIMMessageService::pinMessage),
-            RegApi("unpinMessage", &V2NIMMessageService::unpinMessage), RegApi("updatePinMessage", &V2NIMMessageService::updatePinMessage),
+            RegApi("insertMessageToLocal", &V2NIMMessageService::insertMessageToLocal),
+            RegApi("pinMessage", &V2NIMMessageService::pinMessage),
+            RegApi("unpinMessage", &V2NIMMessageService::unpinMessage),
+            RegApi("updatePinMessage", &V2NIMMessageService::updatePinMessage),
             RegApi("getPinnedMessageList", &V2NIMMessageService::getPinnedMessageList),
-            RegApi("addQuickComment", &V2NIMMessageService::addQuickComment), RegApi("removeQuickComment", &V2NIMMessageService::removeQuickComment),
-            RegApi("getQuickCommentList", &V2NIMMessageService::getQuickCommentList), RegApi("addCollection", &V2NIMMessageService::addCollection),
+            RegApi("addQuickComment", &V2NIMMessageService::addQuickComment),
+            RegApi("removeQuickComment", &V2NIMMessageService::removeQuickComment),
+            RegApi("getQuickCommentList", &V2NIMMessageService::getQuickCommentList),
+            RegApi("addCollection", &V2NIMMessageService::addCollection),
             RegApi("removeCollections", &V2NIMMessageService::removeCollections),
             RegApi("updateCollectionExtension", &V2NIMMessageService::updateCollectionExtension),
             RegApi("getCollectionListByOption", &V2NIMMessageService::getCollectionListByOption),
+            RegApi("getCollectionListExByOption", &V2NIMMessageService::getCollectionListExByOption),
             RegApi("sendP2PMessageReceipt", &V2NIMMessageService::sendP2PMessageReceipt),
-            RegApi("getP2PMessageReceipt", &V2NIMMessageService::getP2PMessageReceipt), RegApi("isPeerRead", &V2NIMMessageService::isPeerRead),
+            RegApi("getP2PMessageReceipt", &V2NIMMessageService::getP2PMessageReceipt),
+            RegApi("isPeerRead", &V2NIMMessageService::isPeerRead),
             RegApi("sendTeamMessageReceipts", &V2NIMMessageService::sendTeamMessageReceipts),
             RegApi("getTeamMessageReceipts", &V2NIMMessageService::getTeamMessageReceipts),
             RegApi("getTeamMessageReceiptDetail", &V2NIMMessageService::getTeamMessageReceiptDetail),
             RegApi("voiceToText", &V2NIMMessageService::voiceToText),
             RegApi("cancelMessageAttachmentUpload", &V2NIMMessageService::cancelMessageAttachmentUpload),
-            RegApi("searchCloudMessages", &V2NIMMessageService::searchCloudMessages)});
+            RegApi("searchCloudMessages", &V2NIMMessageService::searchCloudMessages),
+            RegApi("searchLocalMessages", &V2NIMMessageService::searchLocalMessages),
+        });
 }
 
 node_nim::V2NodeNIMMessageService::V2NodeNIMMessageService(const Napi::CallbackInfo& info)

ts/v2/v2_nim_message_service.ts

@@ -15,6 +15,7 @@ import {
   V2NIMAddCollectionParams,
   V2NIMCollection,
   V2NIMCollectionOption,
+  V2NIMCollectionListResult,
   V2NIMP2PMessageReadReceipt,
   V2NIMTeamMessageReadReceipt,
   V2NIMTeamMessageReadReceiptDetail,
@@ -26,7 +27,9 @@ import {
   V2NIMMessageQuickCommentNotification,
   V2NIMMessageRevokeNotification,
   V2NIMModifyMessageParams,
-  V2NIMModifyMessageResult
+  V2NIMModifyMessageResult,
+  V2NIMMessageSearchExParams,
+  V2NIMMessageSearchResult,
 } from 'ts/v2_def/v2_nim_struct_def'
 import sdk from '../loader'
 import { EventEmitter } from 'eventemitter3'
@@ -711,6 +714,29 @@ export class V2NIMMessageService extends EventEmitter<V2NIMMessageListener> {
     })
   }
 
+  /**
+   * @brief 分页获取收藏列表
+   * @param option 获取收藏列表查询参数
+   * @returns V2NIMCollectionListResult
+   * @example
+   * ```javascript
+   * const result = await v2.messageService.getCollectionListExByOption(option)
+   * ```
+   */
+  getCollectionListExByOption(option: V2NIMCollectionOption): Promise<V2NIMCollectionListResult> {
+    return new Promise((resolve, reject) => {
+      this.instance.getCollectionListExByOption(
+        option,
+        (result: V2NIMCollectionListResult) => {
+          resolve(result)
+        },
+        (error: V2NIMError) => {
+          reject(error)
+        }
+      )
+    })
+  }
+
   /**
    * @brief 发送 P2P 消息已读回执
    * @param message 要发送已读回执的消息
@@ -909,4 +935,29 @@ export class V2NIMMessageService extends EventEmitter<V2NIMMessageListener> {
       )
     })
   }
+
+  /**
+   * @brief 搜索本地消息
+   * @param params 消息检索参数
+   * @returns V2NIMMessageSearchResult
+   * @example
+   * ```javascript
+   * const result = await v2.messageService.searchLocalMessages({
+   *    keywordList: ['keyword1', 'keyword2'],
+   * })
+   * ```
+   */
+  searchLocalMessages (params: V2NIMMessageSearchExParams): Promise<V2NIMMessageSearchResult> {
+    return new Promise((resolve, reject) => {
+      this.instance.searchLocalMessages(
+        params,
+        (result: V2NIMMessageSearchResult) => {
+          resolve(result)
+        },
+        (error: V2NIMError) => {
+          reject(error)
+        }
+      )
+    })
+  }
 }

ts/v2_def/v2_nim_enum_def.ts

@@ -1248,3 +1248,11 @@ export enum V2NIMProxyRequestMethod {
   /** DELETE 请求 */
   V2NIM_PROXY_REQUEST_METHOD_DELETE
 }
+
+/** @brief 搜索关键字匹配条件 @since v10.7.0 */
+export enum V2NIMSearchKeywordMathType {
+  /** 或 */
+  V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR,
+ /** 与 */
+  V2NIM_SEARCH_KEYWORD_MATH_TYPE_AND
+}

ts/v2_def/v2_nim_struct_def.ts

@@ -42,7 +42,8 @@ import {
   V2NIMTeamMemberRoleQueryType,
   V2NIMTeamType,
   V2NIMTeamUpdateExtensionMode,
-  V2NIMTeamUpdateInfoMode
+  V2NIMTeamUpdateInfoMode,
+  V2NIMSearchKeywordMathType
 } from './v2_nim_enum_def'
 
 export interface V2NIMError {
@@ -443,6 +444,8 @@ export interface V2NIMNotificationConfig {
   offlineEnabled?: boolean
   /** 是否需要计未读 */
   unreadEnabled?: boolean
+  /** 外部输入标识字段，建议输入时每次串唯一，长度不超过 32 个字符 */
+  clientNotificationId?: string
 }
 
 export interface V2NIMMessageRefer {
@@ -844,6 +847,8 @@ export interface V2NIMMessageListOption {
   direction?: V2NIMQueryDirection
   /** 严格模式, 无法确定消息完整性则返回错误 */
   strictMode?: boolean
+  /** 是否只查询本地消息 */
+  onlyQueryLocal?: boolean
 }
 
 export interface V2NIMClearHistoryMessageOption {
@@ -951,6 +956,13 @@ export interface V2NIMCollectionOption {
   collectionType?: number
 }
 
+export interface V2NIMCollectionListResult {
+  /** 总收藏条数 */
+  totalCount: number
+  /** 本次分页查询返回的收藏列表 */
+  collectionList: Array<V2NIMCollection>
+}
+
 /** @brief 动态 token 获取回调 */
 /** @param accountId 账号 */
 /** @return token */
@@ -2348,3 +2360,52 @@ export interface V2NIMProxyNotify {
   /** 发送时间，毫秒 */
   time: number
 }
+
+/** @brief 消息检索参数 @since v10.7.0 */
+export interface V2NIMMessageSearchExParams {
+  /** 要查询的会话 ID，不指定则查询所有会话 */
+  conversationId?: string
+  /** 要查询的关键字列表，为空则按发送者或消息类型查询，最多支持 5 个。当消息发送者以及消息类型均未指定时，必须设置关键字列表 */
+  keywordList?: Array<string>
+  /** 指定关键字列表匹配类型，见 {@link V2NIMSearchKeywordMathType}，默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR */
+  keywordMatchType: V2NIMSearchKeywordMathType
+  /** 匹配消息发送者，最多支持 5 个，为空则匹配所有发送者 */
+  senderAccountIds?: Array<string>
+  /** 匹配消息类型，为空则匹配所有类型 */
+  messageTypes?: Array<V2NIMMessageType>
+  /** 搜索的起始时间点，默认为 0（从现在开始搜索）。UTC 时间戳，单位：毫秒 */
+  searchStartTime: number
+  /** 从起始时间点开始的过去时间范围，默认为 0（不限制时间范围）。24 x 60 x 60 x 1000 代表过去一天，单位：毫秒 */
+  searchTimePeriod: number
+  /** 搜索的数量限制，默认为 20，最大为 100 */
+  limit: number
+  /** 下一页的 token，用于分页查询 */
+  pageToken?: string
+}
+
+/** @brief 查询消息返回的结果项 @since v10.7.0 */
+export interface V2NIMMessageSearchItem {
+  /// 会话 ID
+  conversationId: string
+  /// 返回的消息列表
+  messages: Array<V2NIMMessage>
+  /// 单个会话命中的数量
+  count: number
+}
+
+/** @brief 查询消息返回的结果 @since v10.7.0 */
+export interface V2NIMMessageSearchResult {
+  /** 满足检索条件的所有消息数量 */
+  count: number
+  /**
+   * - 单个会话的返回结果
+   *   - 如果查询会话 ID 不会空，则返回 items 会对应会话按指定条数检索出来的消息
+   *   - 如果会话 ID 为空，则为每一个会话检索出来的内容
+   *   - 单个 items 查出的消息按从新到旧排序
+   * - 多个会话的返回结果
+   *   - 按每个会话的最新消息从新到旧排序
+   */
+  items: Array<V2NIMMessageSearchItem>
+  /** 下次请求的 token，两次查询参数必须一致 */
+  nextPageToken: string
+}