tuikit-atomicx-vue3 4.5.0 → 4.5.1

package/dist/states/SearchState.d.ts

@@ -1,314 +0,0 @@
-import { ISearchType as SearchType, SearchCloudGroupsParams, SearchCloudMessagesParams, SearchCloudUsersParams } from '@tencentcloud/chat-uikit-engine';
-import { VariantType } from '../types/search';
-import { SearchResult } from '../types/engine';
-
-/**
- * 搜索状态管理 Hook
- * @memberof module:SearchState
- * @description 提供搜索状态的管理和控制功能，支持多种搜索变体和搜索类型
- * @param {VariantType} [variant] - 可选的搜索变体类型，默认为 STANDARD
- * @returns {Object} 返回搜索状态管理对象
- * @returns {ComputedRef<string>} returns.keyword - 当前搜索关键词
- * @returns {ComputedRef<Map<SearchType, SearchResult<SearchType>>>} returns.results - 搜索结果映射
- * @returns {ComputedRef<boolean>} returns.isLoading - 搜索加载状态
- * @returns {ComputedRef<Error | null>} returns.error - 搜索错误信息
- * @returns {ComputedRef<Map<SearchType, SearchParamsMap[SearchType]>>} returns.searchAdvancedParams - 高级搜索参数
- * @returns {ComputedRef<SearchType | 'all'>} returns.selectedSearchType - 选中的搜索类型
- * @returns {Function} returns.setKeyword - 设置搜索关键词函数
- * @returns {Function} returns.loadMore - 加载更多搜索结果函数
- * @returns {Function} returns.setSelectedType - 设置选中搜索类型函数
- * @returns {Function} returns.setSearchMessageAdvancedParams - 设置消息搜索高级参数函数
- * @returns {Function} returns.setSearchUserAdvancedParams - 设置用户搜索高级参数函数
- * @returns {Function} returns.setSearchGroupAdvancedParams - 设置群组搜索高级参数函数
- * @example
- * ```typescript
- * const {
- *   keyword,
- *   results,
- *   isLoading,
- *   error,
- *   setKeyword,
- *   loadMore,
- *   setSelectedType,
- *   setSearchMessageAdvancedParams
- * } = useSearchState(VariantType.STANDARD);
- *
- * // 设置搜索关键词
- * setKeyword('hello world');
- *
- * // 设置搜索类型为消息
- * setSelectedType(SearchType.MESSAGE);
- *
- * // 设置消息搜索高级参数
- * setSearchMessageAdvancedParams({
- *   conversationID: 'conversation123',
- *   senderUserIDList: ['user1', 'user2']
- * });
- *
- * // 加载更多搜索结果
- * await loadMore(SearchType.MESSAGE);
- * ```
- */
-export declare function useSearchState(variant?: VariantType): {
-    keyword: import('vue').ComputedRef<string>;
-    results: import('vue').ComputedRef<Map<SearchType, {
-        resultList: [] | {
-            messageList: {
-                ID: string;
-                type: import("@tencentcloud/chat").default.TYPES;
-                payload: any;
-                conversationID: string;
-                conversationType: import("@tencentcloud/chat").default.TYPES;
-                to: string;
-                from: string;
-                flow: string;
-                time: number;
-                status: string;
-                isRevoked: boolean;
-                priority: import("@tencentcloud/chat").default.TYPES;
-                nick: string;
-                avatar: string;
-                isPeerRead: boolean;
-                nameCard: string;
-                atUserList: string[];
-                cloudCustomData: string;
-                isDeleted: boolean;
-                isModified: boolean;
-                needReadReceipt: boolean;
-                readReceiptInfo: any;
-                isBroadcastMessage: boolean;
-                isSupportExtension: boolean;
-                receiverList?: string[] | undefined;
-                revoker: string;
-                sequence: number;
-                progress: number;
-                revokerInfo: {
-                    userID: string;
-                    nick: string;
-                    avatar: string;
-                };
-                revokeReason: string;
-                hasRiskContent: boolean;
-                reactionList: {
-                    reactionID: string;
-                    totalUserCount: number;
-                    partialUserList: {
-                        userID: string;
-                        nick: string;
-                        avatar: string;
-                    }[];
-                }[];
-                updateProperties: (options: import('@tencentcloud/chat').Message) => void;
-                getMessage: () => import('@tencentcloud/chat').Message;
-                modifyMessage: (options: import('@tencentcloud/chat-uikit-engine').ModifyMessageParams) => Promise<any>;
-                revokeMessage: () => Promise<any>;
-                resendMessage: () => Promise<any>;
-                deleteMessage: () => Promise<any>;
-                quoteMessage: () => import('@tencentcloud/chat').Message;
-                replyMessage: () => import('@tencentcloud/chat').Message;
-                setMessageExtensions: (extensions: object[]) => Promise<any>;
-                deleteMessageExtensions: (keyList?: string[]) => Promise<any>;
-                getMessageExtensions: () => Promise<any>;
-                getSignalingInfo: () => Record<string, any> | null;
-                getMessageContent: () => Record<string, any>;
-            }[];
-            messageCount: number;
-            conversation?: {
-                conversationID: string;
-                type: string;
-                subType: string;
-                unreadCount: number;
-                lastMessage?: {
-                    nick: string;
-                    nameCard: string;
-                    lastTime: number | string;
-                    lastSequence: string;
-                    fromAccount: string;
-                    isRevoked: boolean;
-                    revoker?: string | undefined;
-                    isPeerRead: boolean;
-                    messageForShow: string;
-                    type: string;
-                    payload: any;
-                } | undefined;
-                groupProfile?: any;
-                userProfile?: any;
-                groupAtInfoList?: any[] | undefined;
-                remark: string;
-                isPinned: boolean;
-                messageRemindType: string;
-                markList: string[];
-                customData: string;
-                conversationGroupList: any[];
-                draftText: string;
-                isMuted: boolean;
-                operationType: number;
-                _conversation: any;
-                updateProperties: (options: import('@tencentcloud/chat').Conversation) => void;
-                updateOperationType: (operationType: number) => void;
-                getConversation: () => any;
-                deleteConversation: (clearHistoryMessage?: boolean) => Promise<any>;
-                pinConversation: () => Promise<any>;
-                muteConversation: () => Promise<any>;
-                setMessageRead: () => Promise<any>;
-                getAvatar: () => string;
-                getShowName: () => string;
-                getGroupAtInfo: () => string;
-                getLastMessage: (key: string) => string | null;
-            } | undefined;
-        }[] | {
-            profile: {
-                userID: string;
-                nick: string;
-                gender: import("@tencentcloud/chat").default.TYPES;
-                birthday: number;
-                location: string;
-                selfSignature: string;
-                allowType: import("@tencentcloud/chat").default.TYPES;
-                language: number;
-                avatar: string;
-                messageSettings: number;
-                adminForbidType: import("@tencentcloud/chat").default.TYPES;
-                level: number;
-                role: number;
-                lastUpdatedNumber: number;
-                profileCustomField: Array<any>;
-            };
-            relation: import("@tencentcloud/chat").default.TYPES.SNS_TYPE_NO_RELATION | import("@tencentcloud/chat").default.TYPES.SNS_TYPE_A_WITH_B | import("@tencentcloud/chat").default.TYPES.SNS_TYPE_B_WITH_A | import("@tencentcloud/chat").default.TYPES.SNS_TYPE_BOTH_WAY;
-        }[] | {
-            groupInfo: {
-                groupID: string;
-                name: string;
-                avatar: string;
-                type: import("@tencentcloud/chat").default.TYPES;
-                introduction: string;
-                notification: string;
-                ownerID: string;
-                createTime: string;
-                infoSequence: number;
-                lastInfoTime: number;
-                selfInfo: any;
-                lastMessage: any;
-                nextMessageSeq: number;
-                memberCount: number;
-                maxMemberCount: number;
-                muteAllMembers: boolean;
-                joinOption: import("@tencentcloud/chat").default.TYPES;
-                groupCustomField: Array<any>;
-                isSupportTopic: boolean;
-            };
-            conversation?: {
-                conversationID: string;
-                type: string;
-                subType: string;
-                unreadCount: number;
-                lastMessage?: {
-                    nick: string;
-                    nameCard: string;
-                    lastTime: number | string;
-                    lastSequence: string;
-                    fromAccount: string;
-                    isRevoked: boolean;
-                    revoker?: string | undefined;
-                    isPeerRead: boolean;
-                    messageForShow: string;
-                    type: string;
-                    payload: any;
-                } | undefined;
-                groupProfile?: any;
-                userProfile?: any;
-                groupAtInfoList?: any[] | undefined;
-                remark: string;
-                isPinned: boolean;
-                messageRemindType: string;
-                markList: string[];
-                customData: string;
-                conversationGroupList: any[];
-                draftText: string;
-                isMuted: boolean;
-                operationType: number;
-                _conversation: any;
-                updateProperties: (options: import('@tencentcloud/chat').Conversation) => void;
-                updateOperationType: (operationType: number) => void;
-                getConversation: () => any;
-                deleteConversation: (clearHistoryMessage?: boolean) => Promise<any>;
-                pinConversation: () => Promise<any>;
-                muteConversation: () => Promise<any>;
-                setMessageRead: () => Promise<any>;
-                getAvatar: () => string;
-                getShowName: () => string;
-                getGroupAtInfo: () => string;
-                getLastMessage: (key: string) => string | null;
-            } | undefined;
-        }[];
-        hasMore: boolean;
-        cursor: string;
-        totalCount: number;
-        params: {
-            senderUserIDList?: string[] | undefined;
-            messageTypeList?: any[] | undefined;
-            conversationID?: string | undefined;
-            timePosition?: number | undefined;
-            timePeriod?: number | undefined;
-            keyword?: string | undefined;
-            keywordList?: string[] | undefined;
-            keywordListMatchType?: "or" | "and" | undefined;
-            cursor?: string | undefined;
-            count?: number | undefined;
-        } | {
-            gender?: string | undefined;
-            miniBirthday?: number | undefined;
-            maxBirthday?: number | undefined;
-            keyword?: string | undefined;
-            keywordList?: string[] | undefined;
-            keywordListMatchType?: "or" | "and" | undefined;
-            cursor?: string | undefined;
-            count?: number | undefined;
-        } | {
-            groupTypeList?: any[] | undefined;
-            keyword?: string | undefined;
-            keywordList?: string[] | undefined;
-            keywordListMatchType?: "or" | "and" | undefined;
-            cursor?: string | undefined;
-            count?: number | undefined;
-        };
-    }> & Omit<Map<SearchType, SearchResult<SearchType>>, keyof Map<any, any>>>;
-    isLoading: import('vue').ComputedRef<boolean>;
-    error: import('vue').ComputedRef<Error | null>;
-    searchAdvancedParams: import('vue').ComputedRef<Map<SearchType, {
-        senderUserIDList?: string[] | undefined;
-        messageTypeList?: any[] | undefined;
-        conversationID?: string | undefined;
-        timePosition?: number | undefined;
-        timePeriod?: number | undefined;
-        keyword?: string | undefined;
-        keywordList?: string[] | undefined;
-        keywordListMatchType?: "or" | "and" | undefined;
-        cursor?: string | undefined;
-        count?: number | undefined;
-    } | {
-        gender?: string | undefined;
-        miniBirthday?: number | undefined;
-        maxBirthday?: number | undefined;
-        keyword?: string | undefined;
-        keywordList?: string[] | undefined;
-        keywordListMatchType?: "or" | "and" | undefined;
-        cursor?: string | undefined;
-        count?: number | undefined;
-    } | {
-        groupTypeList?: any[] | undefined;
-        keyword?: string | undefined;
-        keywordList?: string[] | undefined;
-        keywordListMatchType?: "or" | "and" | undefined;
-        cursor?: string | undefined;
-        count?: number | undefined;
-    }> & Omit<Map<SearchType, SearchCloudMessagesParams | SearchCloudUsersParams | SearchCloudGroupsParams>, keyof Map<any, any>>>;
-    selectedSearchType: import('vue').ComputedRef<"all" | SearchType>;
-    setKeyword: (k: string) => void;
-    loadMore: (type?: SearchType) => Promise<void>;
-    setSelectedType: (type: SearchType | "all") => void;
-    setSearchMessageAdvancedParams: (params: SearchCloudMessagesParams) => void;
-    setSearchUserAdvancedParams: (params: SearchCloudUsersParams) => void;
-    setSearchGroupAdvancedParams: (params: SearchCloudGroupsParams) => void;
-};
-export default useSearchState;