import { type AuthStrategy, type EditorConfig } from "../../EditorConfig"; import { type DocumentVersion } from "./document"; import type { Repository } from "./repository"; interface SearchDocumentsArgs { coreApiBaseUrl: URL; documentSearchBaseUrl: URL; authStrategy: AuthStrategy; repository: string; searchTerm?: string; customTypes?: string[]; tags?: string[]; authors?: string[]; status?: DocumentVersion["status"][]; locale?: string; /** * TODO: Remove after all repos have been migrated to storageVerison 7 or above (PBD-1908) */ storageVersion?: Repository["storageVersion"]; signal: AbortSignal; } export declare function searchDocuments(args: SearchDocumentsArgs): Promise<{ results: { language: { id: string; label: string; isMaster: boolean; }; title: string; id: string; custom_type_id: string; group_lang_id: string; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; custom_type_label: string; author: { email?: string | undefined; id?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; uploadedAvatar?: string | undefined; }; uid?: string | undefined; preview_image?: string | undefined; preview_summary?: string | undefined; })[]; ai_abm_thread_id?: string | undefined; }[]; } | { results: { title: string; id: string; custom_type_id: string; group_lang_id: string; locale_id?: string | undefined; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; summary?: string | undefined; uid?: string | undefined; preview_image?: string | undefined; custom_type_id?: string | undefined; author_ids?: string[] | undefined; highlights?: { uid?: string | undefined; } | undefined; })[]; }[]; }>; interface SearchDocumentsQueryOptionsArgs { searchTerm?: string; customTypes?: string[]; tags?: string[]; authors?: string[]; status?: DocumentVersion["status"][]; locale?: string; /** * TODO: Remove after all repos have been migrated to storageVerison 7 or above (PBD-1908) */ storageVersion?: Repository["storageVersion"]; config: SearchDocumentsConfig; } export declare function searchDocumentsQueryOptions(args: SearchDocumentsQueryOptionsArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{ results: { language: { id: string; label: string; isMaster: boolean; }; title: string; id: string; custom_type_id: string; group_lang_id: string; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; custom_type_label: string; author: { email?: string | undefined; id?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; uploadedAvatar?: string | undefined; }; uid?: string | undefined; preview_image?: string | undefined; preview_summary?: string | undefined; })[]; ai_abm_thread_id?: string | undefined; }[]; } | { results: { title: string; id: string; custom_type_id: string; group_lang_id: string; locale_id?: string | undefined; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; summary?: string | undefined; uid?: string | undefined; preview_image?: string | undefined; custom_type_id?: string | undefined; author_ids?: string[] | undefined; highlights?: { uid?: string | undefined; } | undefined; })[]; }[]; }, Error, { results: { language: { id: string; label: string; isMaster: boolean; }; title: string; id: string; custom_type_id: string; group_lang_id: string; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; custom_type_label: string; author: { email?: string | undefined; id?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; uploadedAvatar?: string | undefined; }; uid?: string | undefined; preview_image?: string | undefined; preview_summary?: string | undefined; })[]; ai_abm_thread_id?: string | undefined; }[]; } | { results: { title: string; id: string; custom_type_id: string; group_lang_id: string; locale_id?: string | undefined; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; summary?: string | undefined; uid?: string | undefined; preview_image?: string | undefined; custom_type_id?: string | undefined; author_ids?: string[] | undefined; highlights?: { uid?: string | undefined; } | undefined; })[]; }[]; }, readonly ["searchDocuments", { readonly coreApiBaseUrl: URL; readonly documentSearchBaseUrl: URL; readonly authStrategy: AuthStrategy; readonly repository: string; readonly searchTerm: string | undefined; readonly customTypes: string[] | undefined; readonly tags: string[] | undefined; readonly authors: string[] | undefined; readonly status: ("unclassified" | "published" | "release" | "archived")[] | undefined; readonly locale: string | undefined; readonly storageVersion: { major: number; minor: number; } | undefined; }]> & { initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{ results: { language: { id: string; label: string; isMaster: boolean; }; title: string; id: string; custom_type_id: string; group_lang_id: string; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; custom_type_label: string; author: { email?: string | undefined; id?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; uploadedAvatar?: string | undefined; }; uid?: string | undefined; preview_image?: string | undefined; preview_summary?: string | undefined; })[]; ai_abm_thread_id?: string | undefined; }[]; } | { results: { title: string; id: string; custom_type_id: string; group_lang_id: string; locale_id?: string | undefined; versions: (({ status: "unclassified"; } | { status: "published"; } | { status: "release"; release_id: string; } | { status: "archived"; }) & { tags: string[]; version_id: string; last_modified_date: Date; summary?: string | undefined; uid?: string | undefined; preview_image?: string | undefined; custom_type_id?: string | undefined; author_ids?: string[] | undefined; highlights?: { uid?: string | undefined; } | undefined; })[]; }[]; }> | undefined; } & { queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E; }; type SearchDocumentsConfig = Pick; export {};