UNPKG

@better-auth-ui/core

Version:

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

44 lines (43 loc) 3.25 kB
import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core'; import { InferData } from '../../lib/auth-client'; import { OrganizationAuthClient } from './organization-auth-client'; export type HasPermissionData<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = InferData<TAuthClient["organization"]["hasPermission"]>; export type HasPermissionParams<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Parameters<TAuthClient["organization"]["hasPermission"]>[0]; export type HasPermissionOptions<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Omit<QueryOptions<HasPermissionData<TAuthClient>>, "queryKey"> & HasPermissionParams<TAuthClient>; /** * Query options factory for checking organization permissions. * * Unlike most organization queries, `hasPermission` uses flat params rather than * a nested `query` object. Missing user or organization IDs disable the query. * * @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.hasPermission`. */ export declare function hasPermissionOptions<TAuthClient extends OrganizationAuthClient>(authClient: TAuthClient, userId: string | undefined, params: HasPermissionParams<TAuthClient>): { queryKey: readonly ["auth", "user", string | undefined, "organization", "permissions", "has", Omit<HasPermissionParams<TAuthClient>, "fetchOptions"> | 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"]["hasPermission"]>>); }; /** * Get organization permission data from cache, fetching if needed. */ export declare const ensureHasPermission: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: HasPermissionOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["hasPermission"]>>; /** * Prefetch organization permission data into the query cache. */ export declare const prefetchHasPermission: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: HasPermissionOptions<TAuthClient>) => Promise<void>; /** * Fetch and cache organization permission data, resolving with data or throwing. */ export declare const fetchHasPermission: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: HasPermissionOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["hasPermission"]>>; /** * Read organization permission data synchronously from the query cache. */ export declare const getHasPermission: <TAuthClient extends OrganizationAuthClient = OrganizationAuthClient>(queryClient: QueryClient, _authClient?: TAuthClient, userId?: string, params?: HasPermissionParams<TAuthClient>) => InferData<TAuthClient["organization"]["hasPermission"]> | undefined;