@better-auth-ui/core/dist/plugins/admin/admin-queries.d.ts

Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.

import { QueryClient, skipToken } from '@tanstack/query-core';
import { InferData } from '../../lib/auth-client';
import { AdminAuthClient } from './admin-auth-client';
type AdminResultError = {
    code?: string;
    message?: string;
    status: number;
    statusText: string;
};
/** Error returned by a Better Auth Admin client request. */
export declare class AdminClientError extends Error {
    readonly code?: string;
    readonly status: number;
    readonly statusText: string;
    constructor(error: AdminResultError);
}
type ListUsersInput = NonNullable<Parameters<AdminAuthClient["admin"]["listUsers"]>[0]>;
export type AdminListUsersParams = NonNullable<ListUsersInput["query"]>;
export type AdminUsersResponse = NonNullable<InferData<AdminAuthClient["admin"]["listUsers"]>>;
export type AdminUser = AdminUsersResponse["users"][number];
export type AdminUserResponse = NonNullable<InferData<AdminAuthClient["admin"]["getUser"]>>;
export type AdminUserSessionsResponse = NonNullable<InferData<AdminAuthClient["admin"]["listUserSessions"]>>;
export type AdminUserSession = AdminUserSessionsResponse["sessions"][number];
export type AdminPermission = Readonly<Record<string, readonly string[]>>;
export type AdminPermissionResponse = NonNullable<InferData<AdminAuthClient["admin"]["hasPermission"]>>;
/** Query options for the Admin user list. */
export declare function adminUsersOptions(authClient: AdminAuthClient, actorUserId?: string, params?: AdminListUsersParams): {
    queryKey: readonly ["auth", "user", string | undefined, "admin", "users", "list", {
        searchValue?: string | undefined;
        searchField?: "email" | "name" | undefined;
        searchOperator?: "contains" | "starts_with" | "ends_with" | undefined;
        limit?: string | number | undefined;
        offset?: string | number | undefined;
        sortBy?: string | undefined;
        sortDirection?: "asc" | "desc" | undefined;
        filterField?: string | undefined;
        filterValue?: string | number | boolean | string[] | number[] | undefined;
        filterOperator?: "in" | "contains" | "starts_with" | "ends_with" | "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "not_in" | undefined;
    }];
    meta: {
        errorPresentation: string;
    };
    queryFn: typeof skipToken | (({ signal }: {
        client: QueryClient;
        queryKey: readonly unknown[];
        signal: AbortSignal;
        meta: import('@tanstack/query-core').QueryMeta | undefined;
        pageParam?: unknown;
        direction?: unknown;
    }) => Promise<{
        users: import('better-auth/plugins').UserWithRole[];
        total: number;
    }>);
};
/** Query options for one user selected in the Admin inspector. */
export declare function adminUserOptions(authClient: AdminAuthClient, actorUserId?: string, targetUserId?: string): {
    queryKey: readonly ["auth", "user", string | undefined, "admin", "users", "detail", string | null];
    meta: {
        errorPresentation: string;
    };
    queryFn: typeof skipToken | (({ signal }: {
        client: QueryClient;
        queryKey: readonly unknown[];
        signal: AbortSignal;
        meta: import('@tanstack/query-core').QueryMeta | undefined;
        pageParam?: unknown;
        direction?: unknown;
    }) => Promise<import('better-auth/plugins').UserWithRole>);
};
/** Query options for sessions belonging to one selected user. */
export declare function adminUserSessionsOptions(authClient: AdminAuthClient, actorUserId?: string, targetUserId?: string): {
    queryKey: readonly ["auth", "user", string | undefined, "admin", "users", "detail", string | null, "sessions"];
    meta: {
        errorPresentation: string;
    };
    queryFn: typeof skipToken | (({ signal }: {
        client: QueryClient;
        queryKey: readonly unknown[];
        signal: AbortSignal;
        meta: import('@tanstack/query-core').QueryMeta | undefined;
        pageParam?: unknown;
        direction?: unknown;
    }) => Promise<{
        sessions: import('better-auth/plugins').SessionWithImpersonatedBy[];
    }>);
};
/** Query options for one permission held by the acting user. */
export declare function adminPermissionOptions(authClient: AdminAuthClient, actorUserId: string | undefined, permission: AdminPermission): {
    queryKey: readonly ["auth", "user", string | undefined, "admin", "permissions", Readonly<Record<string, readonly string[]>>];
    queryFn: typeof skipToken | (({ signal }: {
        client: QueryClient;
        queryKey: readonly unknown[];
        signal: AbortSignal;
        meta: import('@tanstack/query-core').QueryMeta | undefined;
        pageParam?: unknown;
        direction?: unknown;
    }) => Promise<{
        error: null;
        success: boolean;
    }>);
};
export declare const ensureAdminUsers: (queryClient: QueryClient, authClient: AdminAuthClient, actorUserId: string, params?: AdminListUsersParams) => Promise<{
    users: import('better-auth/plugins').UserWithRole[];
    total: number;
}>;
export declare const fetchAdminUser: (queryClient: QueryClient, authClient: AdminAuthClient, actorUserId: string, targetUserId: string) => Promise<import('better-auth/plugins').UserWithRole>;
export {};