@better-auth-ui/core
Version:
Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.
24 lines (23 loc) • 2.35 kB
TypeScript
import { DataTag, QueryClient, QueryOptions } from '@tanstack/query-core';
import { APIError } from 'better-auth';
import { OrganizationAuthServer } from '../../../plugins/organization/server/organization-auth-server';
export type ListOrganizationInvitationsData<TAuth extends OrganizationAuthServer = OrganizationAuthServer> = Awaited<ReturnType<TAuth["api"]["listInvitations"]>>;
export type ListOrganizationInvitationsParams<TAuth extends OrganizationAuthServer = OrganizationAuthServer> = Parameters<TAuth["api"]["listInvitations"]>[0];
/**
* Query options factory for invitations of an organization.
*
* @param auth - The Better Auth server instance.
* @param userId - The signed-in user's ID. Used for cache partitioning so
* the key matches the client-side `listOrganizationInvitationsOptions` for SSR hydration.
* @param params - Parameters forwarded to `auth.api.listInvitations`.
*/
export declare function listOrganizationInvitationsOptions<TAuth extends OrganizationAuthServer>(auth: TAuth, userId: string, params: ListOrganizationInvitationsParams<TAuth>): QueryOptions<Awaited<ReturnType<TAuth["api"]["listInvitations"]>>, APIError, Awaited<ReturnType<TAuth["api"]["listInvitations"]>>, readonly ["auth", "user", string | undefined, "organization", "invitations", "list", {
organizationId?: string | undefined;
} | null], never> & {
queryKey: DataTag<readonly ["auth", "user", string | undefined, "organization", "invitations", "list", {
organizationId?: string | undefined;
} | null], Awaited<ReturnType<TAuth["api"]["listInvitations"]>>, APIError>;
};
export declare const ensureListOrganizationInvitations: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationInvitationsParams<TAuth>) => Promise<Awaited<ReturnType<TAuth["api"]["listInvitations"]>>>;
export declare const prefetchListOrganizationInvitations: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationInvitationsParams<TAuth>) => Promise<void>;
export declare const fetchListOrganizationInvitations: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationInvitationsParams<TAuth>) => Promise<Awaited<ReturnType<TAuth["api"]["listInvitations"]>>>;