@better-auth-ui/core/dist/plugins/organization/full-organization-query.d.ts

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

import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core';
import { InferData } from '../../lib/auth-client';
import { OrganizationAuthClient } from './organization-auth-client';
/**
 * Data returned by the Better Auth full organization endpoint.
 */
export type FullOrganizationData<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = InferData<TAuthClient["organization"]["getFullOrganization"]>;
/**
 * Parameters accepted by the Better Auth full organization endpoint.
 */
export type FullOrganizationParams<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Parameters<TAuthClient["organization"]["getFullOrganization"]>[0];
/**
 * Query options for fetching a full organization, excluding the generated query key.
 */
export type FullOrganizationOptions<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Omit<QueryOptions<FullOrganizationData<TAuthClient>>, "queryKey"> & FullOrganizationParams<TAuthClient>;
/**
 * Query options factory for fetching a full organization.
 *
 * @param authClient - The Better Auth client with the organization plugin.
 * @param userId - The current signed-in user's ID. Used for cache partitioning.
 * @param params - Parameters forwarded to `getFullOrganization`.
 */
export declare function fullOrganizationOptions<TAuthClient extends OrganizationAuthClient>(authClient: TAuthClient, userId?: string, params?: FullOrganizationParams<TAuthClient>): {
    queryKey: readonly ["auth", "user", string | undefined, "organization", "fullDetails", {
        organizationId?: string | undefined;
        organizationSlug?: string | undefined;
        membersLimit?: string | number | undefined;
    } | 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["organization"]["getFullOrganization"]>>);
};
/**
 * Get a full organization from cache, fetching it if needed.
 */
export declare const ensureFullOrganization: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: FullOrganizationOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["getFullOrganization"]>>;
/**
 * Prefetch a full organization into the query cache.
 */
export declare const prefetchFullOrganization: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: FullOrganizationOptions<TAuthClient>) => Promise<void>;
/**
 * Fetch and cache a full organization, resolving with data or throwing.
 */
export declare const fetchFullOrganization: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: FullOrganizationOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["getFullOrganization"]>>;