nim-web-sdk-ng 10.2.7 → 10.3.0

package/dist/esm/adapters.d.ts

@@ -0,0 +1,252 @@
+import { NetTypeKey } from '../../adapters/util';
+import { UploadFileOptions } from './qchat/src/CloudStorageServiceInterface';
+/**
+ * 嵌套版本的 Partial。支持嵌套类行为父类型嵌套类型的一部分。比如 RecursivePartial<AdaptersInterface>，允许 net 为 Partial
+ */
+export declare type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>;
+};
+/**
+ * SDKType(HostEnv): https://docs.popo.netease.com/team/pc/MMC/pageDetail/4e0ea6fc8d37470eb5dc857c5c55d1c7
+ */
+export declare enum HostEnvTypes {
+    Unset = 0,
+    RN = 2,
+    UNIAPP = 3,
+    Electron = 5,
+    WeiXin = 6,
+    BROWSER = 100,
+    H5 = 101,
+    Ali = 102,
+    Baidu = 103,
+    Tiktok = 104
+}
+export declare type GetAdapterType = () => RecursivePartial<AdaptersInterface>;
+export interface AdaptersInterface {
+    getFileUploadInformation(options: UploadFileOptions): null | {
+        uploadInfo: AdapterUploadFileResult;
+        complete: boolean;
+    };
+    setLogger(logger: any): void;
+    platform: string;
+    WebSocket: typeof AdapterWebSocketWrapper;
+    localStorage: AdapterStorage;
+    request(url: string, params?: AdapterRequestParams, otherOptions?: {
+        exception_service?: number;
+    }): Promise<AdapterRequestResult>;
+    uploadFile(options: AdapterUploadFileOptions): Promise<AdapterUploadFileResult>;
+    getSystemInfo(): AdapterSystemInfo;
+    /**
+     * 第一次引入是为了监听 uni-app 的 newtork 网络变化。
+     * 本来想叫 addNetworkEventChangeListener, 但是为了后续可以方便的扩展，所以直接叫做 addEventListener
+     */
+    net: {
+        /**
+         * 运行环境注入的全局变量
+         * uni-app: uni,
+         * 微信: wx
+         * 阿里: my
+         * 百度: swan
+         * 字节: tt
+         */
+        __getEnv: () => any;
+        /**
+         * onNetworkStatusChangeFn 绑定的回调函数
+         */
+        __onNetworkStatusChangeFn: ((res: {
+            networkType: NetTypeKey;
+            isConnected: boolean;
+        }) => void) | null;
+        /**
+         * 获取数据上报用的 网络字段
+         */
+        getNetworkStatus: () => Promise<{
+            net_type: NIMENetworkType;
+            net_connect: boolean;
+        }>;
+        /**
+         * 网络监听事件
+         */
+        onNetworkStatusChange: (fn: (res: NIMENetworkStatusEvent) => void) => void;
+        /**
+         * 取消网络监听
+         */
+        offNetworkStatusChange: () => void;
+    };
+}
+/**
+ * 网络监听事件的回调的回参
+ */
+export declare type NIMENetworkStatusEvent = {
+    /**
+     * 当前是否有网络连接
+     */
+    isConnected: boolean;
+    /**
+     * 网络类型
+     */
+    networkType: NIMENetworkType;
+};
+export declare enum NIMENetworkType {
+    /**
+     * 未知
+     */
+    kStatNetTypeUnkonw = 0,
+    /**
+     * 有线网络
+     */
+    kStatNetTypeEthernet = 1,
+    kStatNetTypeWifi = 2,
+    kStatNetType2G = 3,
+    kStatNetType3G = 4,
+    kStatNetType4G = 5,
+    kStatNetType5G = 6
+}
+declare let AdapterWebSocketWrapper: {
+    prototype: AdapterWebSocket;
+    new (url: string, protocols?: string): AdapterWebSocket;
+};
+export interface AdapterWebSocket {
+    close(code?: number, reason?: string): void;
+    /** Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView. */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+    onclose: ((this: AdapterWebSocket, ev: CloseEvent) => any) | null;
+    onerror: ((this: AdapterWebSocket, ev: Event) => any) | null;
+    onmessage: ((this: AdapterWebSocket, ev: MessageEvent) => any) | null;
+    onopen: ((this: AdapterWebSocket, ev: Event) => any) | null;
+    binaryType: string;
+    readonly CLOSED: number;
+    readonly CLOSING: number;
+    readonly CONNECTING: number;
+    readonly OPEN: number;
+}
+export interface AdapterStorage {
+    clear(): void;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    setItem(key: string, value: string): void;
+}
+export declare type AdapterRequestMethodNames = 'GET' | 'POST' | 'PUT' | 'OPTIONS' | 'DELETE' | 'OPTIONS' | 'CONNECT';
+export interface AdapterRequestResult {
+    data: any;
+    headers: any;
+    status: number;
+    [key: string]: any;
+}
+export interface AdapterSystemInfo {
+    /**
+     * https://docs.popo.netease.com/lingxi/d722dd9717d940a6bff97b207bc06cb4
+     *
+     * 登录 44 号字段。客户使用的 SDK 产物为，取值有: BROWSER, UNIAPP, MINIAPP
+     */
+    libEnv: 'BROWSER' | 'UNIAPP' | 'MINIAPP';
+    /**
+     * 登录时的 42 号字段
+     *
+     * https://docs.popo.netease.com/lingxi/d722dd9717d940a6bff97b207bc06cb4?xyz=1703642388639
+     */
+    userAgent: string;
+    os: string;
+    osVer: string;
+    browser: string;
+    browserVer: string;
+    /**
+     * 和 hostEnvEnum 一样，但是是字符串，表示脚本的运行环境。取值有：
+     *
+     * BROWSER, ELECTRON, H5, Weixin, Baidu, Ali, Tiktok, RN
+     */
+    hostEnv: keyof typeof HostEnvTypes;
+    /**
+     * 登录时的 41 号字段
+     *
+     * https://docs.popo.netease.com/lingxi/d722dd9717d940a6bff97b207bc06cb4?xyz=1703642388639
+     */
+    hostEnvEnum: HostEnvTypes;
+    /**
+     * 宿主环境的版本号
+     * - 浏览器：浏览器版本
+     * - 小程序：宿主App版本。比如微信、支付宝版本
+     */
+    hostEnvVer: string;
+    /**
+     * 宿主环境版本号
+     * - 浏览器：浏览器版本
+     * - 小程序：基础库版本
+     */
+    model: string;
+    /**
+     * 和 hostEnv 一样，但是更为精细。
+     * - 浏览器：platform.name
+     * - 小程序：等于 hostEnv
+     */
+    manufactor: string;
+    pushDeviceInfo?: {
+        PRODUCT: string;
+        DEVICE: string;
+        MANUFACTURER: string;
+    };
+}
+declare type AdapterFileProgressObject = {
+    total: number;
+    loaded: number;
+    percentage: number;
+    percentageText: string;
+};
+export interface AdapterUploadFileResult {
+    name: string;
+    ext: string;
+    bucketName: string;
+    ctx: string;
+    objectName: string;
+    token: string;
+    type: string;
+    size: number;
+}
+export interface AdapterFileUploadInfo {
+    bucketName: string;
+    objectName: string;
+    token: string;
+    md5?: string;
+    ctx?: string;
+    payload?: any;
+}
+export interface AdapterUploadFileOptions {
+    payload?: any;
+    type?: 'image' | 'audio' | 'video' | 'file';
+    file?: File;
+    fileInput?: string | HTMLInputElement;
+    filePath?: string;
+    blob?: Blob;
+    dataURL?: string;
+    maxSize?: number;
+    nosScenes?: string;
+    nosSurvivalTime?: number;
+    md5?: string;
+    nosToken: any;
+    chunkUploadHost: string;
+    commonUploadHost: string;
+    onUploadStart?: (task: {
+        abort: () => void;
+        [key: string]: any;
+    }) => void;
+    onUploadProgress?: (obj: AdapterFileProgressObject) => void;
+}
+export interface AdapterRequestParams {
+    method: AdapterRequestMethodNames;
+    headers?: {
+        [key: string]: string;
+    };
+    data?: {
+        [key: string]: string | number | any;
+    };
+    params?: {
+        [key: string]: string | number | any;
+    };
+    timeout?: number;
+    /**
+     * 支付宝需要传 dataType: text 才能让 socket io 嗅探请求不挂
+     */
+    dataType: string;
+}
+export declare function setAdapters(newAdapters: GetAdapterType): void;
+export {};

package/dist/esm/nim/empty.d.ts

@@ -0,0 +1,3 @@
+/**
+ * 无实际作用的申明文件。主要是能够帮助typedoc调整输出文件的路径。使得src文件夹下面的文件生成module时，都加上src_这个前缀。
+ */

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

@@ -0,0 +1,264 @@
+import { IMMessage } from './MsgServiceInterface';
+import { SystemMessage } from './SystemMessageServiceInterface';
+/**
+ * 调用方式:
+ * ```js
+ * nim.cloudSession.queryCloudSessionList(options)
+ * ```
+ */
+export interface CloudSessionServiceInterface {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 查询云端会话列表
+     * @locale
+     *
+     * @locale en
+     * Query the list of sessions on the server
+     * @locale
+     */
+    queryCloudSessionList(options: NIMEQueryCloudSessionListOptions): Promise<NIMEQueryCloudSessionListResult>;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 查询某个云端会话
+     * @locale
+     *
+     * @locale en
+     * Query a specified session
+     * @locale
+     */
+    queryCloudSession(options: NIMEQueryCloudSessionOptions): Promise<NIMECloudSession>;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 更新云端会话
+     * @locale
+     *
+     * @locale en
+     * Update a session on the server
+     * @locale
+     */
+    updateCloudSession(options: NIMEUpdateCloudSessionOptions): Promise<void>;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 删除云端会话列表
+     * @locale
+     *
+     * @locale en
+     * Delete a session on the server
+     * @locale
+     */
+    deleteCloudSessionList(options: NIMEDeleteCloudSessionListOptions): Promise<void>;
+}
+export interface NIMECloudSession {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * sessionId
+     *
+     * 例如 p2p-cs1、team-113879441
+     * @locale
+     *
+     * @locale en
+     * sessionId
+     *
+     * Example: p2p-cs1, team-113879441
+     * @locale
+     */
+    sessionId: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 更新时间
+     * @locale
+     *
+     * @locale en
+     * Update time
+     * @locale
+     */
+    updateTime: number;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 扩展字段，仅自己可见
+     * @locale
+     *
+     * @locale en
+     * Extension, visible only to yourself
+     * @locale
+     */
+    ext?: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 上一条消息的信息.
+     *
+     * 注1: 若最近消息被撤回了, 会返回特殊的标记 isLastMsgRecalled 与 revokedMsg
+     *
+     * 注2: 若最近消息被单向删除了, 或者是这个会话的确没有过消息, 这个定义将不会返回.
+     * @locale
+     *
+     * @locale en
+     * Previous message
+     * @locale
+     */
+    lastMsgInfo?: {
+        /**
+         * @Multi_Lang_Tag
+         * @locale cn
+         * 上一条消息是否被撤回
+         * @locale
+         *
+         * @locale en
+         * Whether the last message is unsent
+         * @locale
+         */
+        isLastMsgRecalled: boolean;
+        /**
+         * @Multi_Lang_Tag
+         * @locale cn
+         * 上一条消息内容，isLastMsgRecalled 为 false 时存在。
+         * @locale
+         *
+         * @locale en
+         * body of the last message, valid if isLastMsgRecalled is set to false
+         * @locale
+         */
+        lastMsg?: IMMessage;
+        /**
+         * @Multi_Lang_Tag
+         * @locale cn
+         * 上一条被撤回的消息通知，isLastMsgRecalled 为 true 时存在。
+         * @locale
+         *
+         * @locale en
+         * notification of the last unsent message, valid if isLastMsgRecalled is set to true
+         * @locale
+         */
+        revokedMsg?: SystemMessage;
+    };
+}
+export interface NIMEQueryCloudSessionListOptions {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 与 maxTimestamp 组成一个时间段。默认 0，代表不限制
+     * @locale
+     *
+     * @locale en
+     * The SDK  determines the parameter order based on the time period it forms with timestamp2. <br>
+     * The default value is 0, which means there is no restriction.
+     * @locale
+     */
+    minTimestamp?: number;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 与 minTimestamp 组成一个时间段。默认 0，代表不限制
+     * @locale
+     *
+     * @locale en
+     * The SDK  determines the parameter order based on the time period it forms with timestamp1. <br>
+     * The default value is 0, which means there is no restriction.
+     * @locale
+     */
+    maxTimestamp?: number;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 分页大小，默认 100
+     * @locale
+     *
+     * @locale en
+     * The number of sessions displayed on a page. The default value is 100.
+     * @locale
+     */
+    limit?: number;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 是否需要返回 last msg。默认 true
+     * @locale
+     *
+     * @locale en
+     * Whether the last message is returned. The default value is true.
+     * @locale
+     */
+    includedLastMsg?: boolean;
+}
+export interface NIMEQueryCloudSessionListResult {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 会话列表
+     * @locale
+     *
+     * @locale en
+     * List of sessions
+     * @locale
+     */
+    sessionList: NIMECloudSession[];
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 是否下一页还有数据
+     * @locale
+     *
+     * @locale en
+     * Whether more data is loaded for the next page
+     * @locale
+     */
+    hasMore: boolean;
+}
+export interface NIMEQueryCloudSessionOptions {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 会话 ID
+     * @locale
+     *
+     * @locale en
+     * Session ID
+     * @locale
+     */
+    sessionId: string;
+}
+export interface NIMEUpdateCloudSessionOptions {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 会话 ID
+     * @locale
+     *
+     * @locale en
+     * Session ID
+     * @locale
+     */
+    sessionId: string;
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 扩展字段，仅自己可见
+     * @locale
+     *
+     * @locale en
+     * The extension field, only visible for the current user
+     * @locale
+     */
+    ext: string;
+}
+export interface NIMEDeleteCloudSessionListOptions {
+    /**
+     * @Multi_Lang_Tag
+     * @locale cn
+     * 要删除的会话 ID 的列表
+     * @locale
+     *
+     * @locale en
+     * The list of sessions to be deleted
+     * @locale
+     */
+    sessionIdList: string[];
+}