@better-auth-ui/core
Version:
Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.
54 lines (53 loc) • 3.58 kB
TypeScript
import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core';
import { InferData } from '../../lib/auth-client';
import { MultiSessionAuthClient } from './multi-session-auth-client';
/**
* Data returned by the Better Auth device sessions endpoint.
*/
export type ListDeviceSessionsData<TAuthClient extends MultiSessionAuthClient = MultiSessionAuthClient> = InferData<TAuthClient["multiSession"]["listDeviceSessions"]>;
/**
* Single device session item returned by the device sessions endpoint.
*/
export type ListDeviceSession<TAuthClient extends MultiSessionAuthClient = MultiSessionAuthClient> = NonNullable<ListDeviceSessionsData<TAuthClient>>[number];
/**
* Parameters accepted by the Better Auth device sessions endpoint.
*/
export type ListDeviceSessionsParams<TAuthClient extends MultiSessionAuthClient = MultiSessionAuthClient> = Parameters<TAuthClient["multiSession"]["listDeviceSessions"]>[0];
/**
* Query options for listing device sessions, excluding the generated query key.
*/
export type ListDeviceSessionsOptions<TAuthClient extends MultiSessionAuthClient = MultiSessionAuthClient> = Omit<QueryOptions<ListDeviceSessionsData<TAuthClient>>, "queryKey"> & ListDeviceSessionsParams<TAuthClient>;
/**
* Query options factory for listing the current user's device sessions.
*
* @param authClient - The Better Auth client with the multi-session plugin.
* @param userId - The current signed-in user's ID. Used for cache partitioning.
* @param params - Parameters forwarded to the device sessions endpoint.
*/
export declare function listDeviceSessionsOptions<TAuthClient extends MultiSessionAuthClient>(authClient: TAuthClient, userId?: string, params?: ListDeviceSessionsParams<TAuthClient>): {
queryKey: readonly ["auth", "user", string | undefined, "multiSession", "list", Record<string, any> | null];
queryFn: typeof skipToken | (({ signal }: {
client: QueryClient;
queryKey: readonly unknown[];
signal: AbortSignal;
meta: import('@tanstack/query-core').QueryMeta | undefined;
pageParam?: unknown;
direction?: unknown;
}) => Promise<InferData<TAuthClient["multiSession"]["listDeviceSessions"]>>);
};
/**
* Get device sessions from cache, fetching them if needed.
*/
export declare const ensureListDeviceSessions: <TAuthClient extends MultiSessionAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListDeviceSessionsOptions<TAuthClient>) => Promise<InferData<TAuthClient["multiSession"]["listDeviceSessions"]>>;
/**
* Prefetch device sessions into the query cache.
*/
export declare const prefetchListDeviceSessions: <TAuthClient extends MultiSessionAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListDeviceSessionsOptions<TAuthClient>) => Promise<void>;
/**
* Fetch and cache device sessions, resolving with data or throwing.
*/
export declare const fetchListDeviceSessions: <TAuthClient extends MultiSessionAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListDeviceSessionsOptions<TAuthClient>) => Promise<InferData<TAuthClient["multiSession"]["listDeviceSessions"]>>;
/**
* Read device sessions synchronously from the query cache.
*/
export declare const getListDeviceSessions: <TAuthClient extends MultiSessionAuthClient = MultiSessionAuthClient>(queryClient: QueryClient, _authClient?: TAuthClient, userId?: string, params?: ListDeviceSessionsParams<TAuthClient>) => InferData<TAuthClient["multiSession"]["listDeviceSessions"]> | undefined;