@better-auth-ui/core
Version:
Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.
43 lines (42 loc) • 3.19 kB
TypeScript
import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core';
import { InferData } from '../../lib/auth-client';
import { OrganizationAuthClient } from './organization-auth-client';
export type ListUserInvitationsData<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = InferData<TAuthClient["organization"]["listUserInvitations"]>;
export type ListUserInvitationsParams<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Parameters<TAuthClient["organization"]["listUserInvitations"]>[0];
export type ListUserInvitationsOptions<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Omit<QueryOptions<ListUserInvitationsData<TAuthClient>>, "queryKey"> & ListUserInvitationsParams<TAuthClient>;
/**
* Query options factory for invitations addressed to the current user.
*
* @param authClient - The Better Auth organization client.
* @param userId - The current signed-in user's ID. Used for cache partitioning.
* @param params - Parameters forwarded to `authClient.organization.listUserInvitations`.
*/
export declare function listUserInvitationsOptions<TAuthClient extends OrganizationAuthClient>(authClient: TAuthClient, userId?: string, params?: ListUserInvitationsParams<TAuthClient>): {
queryKey: readonly ["auth", "user", string | undefined, "organization", "userInvitations", "list", {
email?: string | 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"]["listUserInvitations"]>>);
};
/**
* Get user invitations from the cache, fetching if needed.
*/
export declare const ensureListUserInvitations: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListUserInvitationsOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["listUserInvitations"]>>;
/**
* Prefetch user invitations into the query cache.
*/
export declare const prefetchListUserInvitations: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListUserInvitationsOptions<TAuthClient>) => Promise<void>;
/**
* Fetch and cache user invitations, resolving with data or throwing on error.
*/
export declare const fetchListUserInvitations: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListUserInvitationsOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["listUserInvitations"]>>;
/**
* Read user invitations synchronously from the query cache without fetching.
*/
export declare const getListUserInvitations: <TAuthClient extends OrganizationAuthClient = OrganizationAuthClient>(queryClient: QueryClient, _authClient?: TAuthClient, userId?: string, params?: ListUserInvitationsParams<TAuthClient>) => InferData<TAuthClient["organization"]["listUserInvitations"]> | undefined;