nim-web-sdk-ng 10.9.81 → 10.10.0

package/dist/esm/adapters.d.ts

@@ -307,6 +307,10 @@ export interface AdapterSystemInfo {
      * - 小程序：等于 hostEnv
      */
     manufactor: string;
+    /**
+     * 端设备时区。仅在 adapter 能稳定获取端设备时区时填写，不支持时返回空字符串。
+     */
+    timeZone?: string;
     pushDeviceInfo?: {
         PRODUCT: string;
         DEVICE: string;
@@ -360,6 +364,18 @@ export interface AdapterUploadFileOptions {
     headers?: {
         [key: string]: string;
     };
+    timeout?: number;
+    uploadHostCandidates?: Array<{
+        url: string;
+        source?: 'lbs' | 'default';
+    }>;
+    maxRetry?: number;
+    onUploadAttemptFail?: (info: {
+        url: string;
+        source: 'lbs' | 'default';
+        error: any;
+        kind: 'network' | 'business' | 'communication' | 'server';
+    }) => void;
     onUploadStart?: (task: {
         abort: () => void;
         [key: string]: any;

package/dist/esm/nim/src/CloudStorageServiceInterface.d.ts

@@ -317,6 +317,28 @@ export interface GetFileTokenResult {
     ttl: number;
 }
 export interface NIMEModuleParamCloudStorageConfig {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * IM NOS LBS 地址，必须是包含 scheme 和 host 的完整 URL。SDK 默认 'https://lbs.netease.im/lbs/nosconf'
+     * @locale
+     *
+     * @locale en
+     * IM NOS LBS URL. It must be an absolute URL with scheme and host. SDK default: 'https://lbs.netease.im/lbs/nosconf'
+     * @locale
+     */
+    imNOSUploadLBS?: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 是否启用 IM NOS LBS。显式设置时使用该值；未设置时由 IM 登录 LBS 地址是否为默认值决定。
+     * @locale
+     *
+     * @locale en
+     * Whether IM NOS LBS is enabled. Explicit values take effect directly. If unset, the default is derived from whether IM login LBS URLs are default.
+     * @locale
+     */
+    enableIMNOSLBS?: boolean;
     /**
      * @Multi_Lang_Tag
      * @locale cn

package/dist/esm/nim/src/NIMInterface.d.ts

@@ -9,6 +9,7 @@ import { SyncOptions } from './SyncServiceInterface';
 import { SystemMessage, TSystemMessageStatus, TSystemMessageType } from './SystemMessageServiceInterface';
 import { Team, TeamMember, TeamMemberType } from './TeamServiceInterface';
 import { NIMServiceName, StrAnyObj } from './types';
+import { NIMEStrAnyObj } from '../../types';
 import { Relations, UserNameCard } from './UserServiceInterface';
 import { NIMEInstanceStatus, V1NIMLoginKickOptions, V1NIMLoginKickResult, V1NIMLoginListener, NIMEModuleParamV1Login } from './V1NIMLoginService';
 import { V2NIMFriendServiceConfig } from './V2NIMFriendService';
@@ -548,6 +549,12 @@ export declare type NIMOtherOptionsAbtestConfig = {
      * abTest 服务器下发地址
      */
     abtestUrl?: string;
+    /**
+     * 对线上拉取到的 abtInfo 做预处理，返回值会作为实例最终生效的 abtInfo。
+     *
+     * 可用于 ABTest 测试阶段覆盖或调整线上返回配置。
+     */
+    abtestInfoPreprocessor?: (abtInfo: NIMEStrAnyObj) => NIMEStrAnyObj;
 };
 export declare type NIMOtherOptionsPrivateConfig = {
     /**
@@ -568,6 +575,10 @@ export declare type NIMOtherOptionsPrivateConfig = {
      * 上传地址
      */
     nos_uploader?: string;
+    /**
+     * IM NOS LBS 地址
+     */
+    im_nos_lbs?: string;
     /**
      * 下载地址的格式
      */
@@ -638,6 +649,28 @@ export declare type NIMOtherOptionsReporterConfig = {
     isDataReportEnable?: boolean;
 };
 export interface ServerConfig {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * IM NOS LBS 地址，必须是包含 scheme 和 host 的完整 URL。SDK 默认 'https://lbs.netease.im/lbs/nosconf'
+     * @locale
+     *
+     * @locale en
+     * IM NOS LBS URL. It must be an absolute URL with scheme and host. SDK default: 'https://lbs.netease.im/lbs/nosconf'
+     * @locale
+     */
+    imNOSUploadLBS?: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 是否启用 IM NOS LBS。显式设置时使用该值；未设置时由 IM 登录 LBS 地址是否为默认值决定。
+     * @locale
+     *
+     * @locale en
+     * Whether IM NOS LBS is enabled. Explicit values take effect directly. If unset, the default is derived from whether IM login LBS URLs are default.
+     * @locale
+     */
+    enableIMNOSLBS?: boolean;
     /**
      * @Multi_Lang_Tag
      * @locale cn

package/dist/esm/nim/src/QChatMsgServiceInterface.d.ts

@@ -275,10 +275,11 @@ export interface IUploadFileOptions {
     /**
      * maxSize 限制文件大小。
      *
-     * 只对浏览器生效。
+     * 对浏览器生效(v10.0.0+)
      *
-     * uni-app，小程序等，由于sdk只能得到一个 filePath 临时路径，不能得到整个文件的信息。
-     * 所以请开发者自行在选择文件后进行判断，参考那些端的API如 wx.chooseImage，uni.chooseImage
+     * 而在 uni-app、小程序等 filePath 上传场景中，调用 stat 方法检测生效 (v10.9.90+)。
+     *
+     * 若宿主环境不支持文件大小探查，则仍建议开发者在选择文件后自行判断，参考 wx.chooseImage、uni.chooseImage 等端能力。
      */
     maxSize?: number;
     /**

package/dist/esm/nim/src/V2NIMLoginService.d.ts

@@ -667,4 +667,12 @@ export declare type NIMEModuleParamV2Login = {
      * 注: 传 false 将允许 LBS 和 Websocket 连接使用 http 和 ws 协议. 不推荐使用.
      */
     linkSSL?: boolean;
+    /**
+     * 是否启用网络可达性探测上报。默认 true。
+     *
+     * 注: 该能力仅用于在 login、chatroomLogin、LinkKeep 等 SDK 数据上报中追加 net_probe 字段，
+     * 不会改变连接、心跳、断线或重连行为。设置为 false 时，SDK 不读取网络探测 ABTest 配置、
+     * 不发起探测请求，也不追加 net_probe。
+     */
+    networkProbeEnable?: boolean;
 };

package/dist/esm/nim/src/V2NIMMessageService.d.ts

@@ -442,13 +442,21 @@ export declare class V2NIMMessageLogUtil {
     /**
      * 仅清空会话漫游消息
      *
+     * 注: 如果需要删除会话, 并且刷新页面重新初始化登录后不再看到该会话, 但后续新消息进入重新产生会话时仍能拉取历史消息,
+     * 可以先调用本接口清空漫游消息, 再调用会话删除接口并将 clearMessage 设置为 false.
+     * 这样只会删除会话和漫游消息, 不会删除云端历史消息.
+     *
      * 注: 使用 dist/esm 产物时，需要动态引入 {@link V2NIMMessageLogUtil | V2NIMMessageLogUtil} 后使用
      *
      * @param conversationIds 会话 id 列表
      *
      * @example
      * ```ts
+     * // 组合调用场景: 删除本地会话并清空漫游消息, 但保留云端历史消息.
+     * // 刷新页面重新初始化登录后, 该会话不会因漫游消息重新出现.
+     * // 接着因新消息弹出这个会话, 点击进入会话后, 能够拉得到历史消息记录.
      * await nim.V2NIMMessageService.clearRoamingMessage([conversationId])
+     * await nim.V2NIMLocalConversationService.deleteConversation(conversationId, false)
      * ```
      */
     clearRoamingMessage(conversationIds: string[]): Promise<void>;

package/dist/esm/nim/src/types.d.ts

@@ -431,19 +431,17 @@ export interface IBaseUploadFileOptions {
      * @locale cn
      * maxSize 限制文件大小。
      *
-     * 只对浏览器生效。
+     * 对浏览器生效；在 uni-app、小程序等 filePath 上传场景中，若 adapter 能探查到本地文件大小，也会生效。
      *
-     * uni-app，小程序等，由于sdk只能得到一个 filePath 临时路径，不能得到整个文件的信息。
-     * 所以请开发者自行在选择文件后进行判断，参考那些端的API如 wx.chooseImage，uni.chooseImage
+     * 若宿主环境不支持文件大小探查，则仍建议开发者在选择文件后自行判断，参考 wx.chooseImage、uni.chooseImage 等端能力。
      * @locale
      *
      * @locale en
      * maxSize : maximum file size.
      *
-     * Only valid for browsers.
+     * Valid for browsers. For filePath uploads in uni-app and mini-program runtimes, it is also valid when the adapter can inspect local file size.
      *
-     * For uni-app, applet, etc., because the SDK can only get a temporary filePath path, the information of the entire file cannot be obtained.
-     * So please make your determination after selecting the file. Refer to those frame/platform’s APIs such as wx.chooseImage, uni.chooseImage.
+     * If the host runtime does not support file size inspection, make your determination after selecting the file. Refer to those frame/platform’s APIs such as wx.chooseImage, uni.chooseImage.
      * @locale
      */
     maxSize?: number;