UNPKG

@better-auth-ui/core

Version:

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

37 lines (36 loc) 2.4 kB
import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core'; import { InferData } from '../../lib/auth-client'; import { OrganizationAuthClient } from './organization-auth-client'; export type ActiveMemberRoleData<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = InferData<TAuthClient["organization"]["getActiveMemberRole"]>; export type ActiveMemberRoleParams<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Parameters<TAuthClient["organization"]["getActiveMemberRole"]>[0]; export type ActiveMemberRoleOptions<TAuthClient extends OrganizationAuthClient = OrganizationAuthClient> = Omit<QueryOptions<ActiveMemberRoleData<TAuthClient>>, "queryKey"> & ActiveMemberRoleParams<TAuthClient>; /** * Query options factory for the signed-in user's own role in an organization. * * Prefer this over scanning `listMembers` for the current user: once the * member list is paginated, the signed-in user may not be on the page that * happens to be loaded. * * @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.getActiveMemberRole`. */ export declare function activeMemberRoleOptions<TAuthClient extends OrganizationAuthClient>(authClient: TAuthClient, userId?: string, params?: ActiveMemberRoleParams<TAuthClient>): { queryKey: readonly ["auth", "user", string | undefined, "organization", "members", "activeRole", { userId?: string | undefined; organizationId?: string | undefined; organizationSlug?: 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"]["getActiveMemberRole"]>>); }; /** * Get the signed-in user's organization role from the cache, fetching if needed. */ export declare const ensureActiveMemberRole: <TAuthClient extends OrganizationAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ActiveMemberRoleOptions<TAuthClient>) => Promise<InferData<TAuthClient["organization"]["getActiveMemberRole"]>>;