import { DataTag, QueryClient } from '@tanstack/react-query'; import { BetterFetchError } from 'better-auth/react'; import { AuthClient, InferData } from '../../lib/auth-client'; export type ListSessionsData = InferData; export type ListSessionsParams = Parameters[0]; export type ListSession = NonNullable>[number]; export type ListSessionsOptions = Omit>, "queryKey" | "queryFn">; /** * Query options factory for the current user's active sessions. * * @param authClient - The Better Auth client. * @param userId - The current signed-in user's ID. Used for cache partitioning. * @param params - Parameters forwarded to `authClient.listSessions`. */ export declare function listSessionsOptions(authClient: TAuthClient, userId: string | undefined, params?: ListSessionsParams): (import('@tanstack/query-core').OmitKeyof, BetterFetchError, InferData, readonly ["auth", "user", string | undefined, "listSessions", Record | null]>, "queryFn"> & { queryFn?: import('@tanstack/query-core').QueryFunction, readonly ["auth", "user", string | undefined, "listSessions", Record | null], never> | undefined; } & { queryKey: readonly ["auth", "user", string | undefined, "listSessions", Record | null] & { [dataTagSymbol]: InferData; [dataTagErrorSymbol]: BetterFetchError; }; }) & { queryKey: DataTag | null], InferData, BetterFetchError>; }; /** * Get the current user's active sessions from the query cache, calling * `fetchListSessions` under the hood if no cached entry exists. Resolves * with the session list, making it ideal for loaders or `beforeLoad` guards. * * @param queryClient - The React Query client. * @param authClient - The Better Auth client. * @param userId - The signed-in user's ID, used for cache partitioning. * @param params - Parameters forwarded to `authClient.listSessions`. */ export declare const ensureListSessions: (queryClient: QueryClient, authClient: TAuthClient, userId: string, params?: ListSessionsParams) => Promise>; /** * Prefetch the current user's active sessions into the query cache. Behaves * like `fetchListSessions`, but does not throw on error and does not return * the data — use this to warm the cache without blocking navigation. * * @param queryClient - The React Query client. * @param authClient - The Better Auth client. * @param userId - The signed-in user's ID, used for cache partitioning. * @param params - Parameters forwarded to `authClient.listSessions`. */ export declare const prefetchListSessions: (queryClient: QueryClient, authClient: TAuthClient, userId: string, params?: ListSessionsParams) => Promise; /** * Fetch and cache the current user's active sessions, resolving with the * data or throwing on error. If a cached entry exists and is neither * invalidated nor older than `staleTime`, the cached value is returned * without a network call; otherwise the latest data is fetched. * * @param queryClient - The React Query client. * @param authClient - The Better Auth client. * @param userId - The signed-in user's ID, used for cache partitioning. * @param params - Parameters forwarded to `authClient.listSessions`. */ export declare const fetchListSessions: (queryClient: QueryClient, authClient: TAuthClient, userId: string, params?: ListSessionsParams) => Promise>; export type UseListSessionsOptions = ListSessionsOptions & ListSessionsParams; /** * Subscribe to the current user's active sessions via TanStack Query. * * Shares a query key with the server-side `listSessionsOptions`, so * SSR-hydrated data is reused from the cache without an immediate refetch. * The query is gated on a signed-in user; while the session is loading or * absent, the underlying `queryFn` is replaced with `skipToken`. * * @param authClient - The Better Auth client. * @param options - `listSessions` params (`query`, `fetchOptions`) merged * with `useQuery` options (e.g. `enabled`, `staleTime`, `select`). * @param queryClient - Optional custom `QueryClient`. Defaults to the client * from the nearest `QueryClientProvider`. */ export declare function useListSessions(authClient: TAuthClient, options?: UseListSessionsOptions, queryClient?: QueryClient): import('@tanstack/react-query').UseQueryResult>, BetterFetchError>;