@better-auth-ui/react 1.6.30 → 1.6.32

package/src/index.ts

@@ -14,6 +14,7 @@ export type * from "./lib/auth-client"
 export * from "./lib/auth-plugin"
 export * from "./lib/provider-icons"
 export * from "./lib/settings-tab"
+export * from "./mutations/admin/stop-impersonating-mutation"
 export * from "./mutations/api-key/create-api-key-mutation"
 export * from "./mutations/api-key/delete-api-key-mutation"
 export * from "./mutations/auth/request-password-reset-mutation"
@@ -24,9 +25,13 @@ export * from "./mutations/auth/sign-in-social-mutation"
 export * from "./mutations/auth/sign-out-mutation"
 export * from "./mutations/auth/sign-up-email-mutation"
 export * from "./mutations/auth-mutation-options"
+export * from "./mutations/device-authorization/approve-device-mutation"
+export * from "./mutations/device-authorization/deny-device-mutation"
+export * from "./mutations/device-authorization/verify-device-code-mutation"
 export * from "./mutations/magic-link/sign-in-magic-link-mutation"
 export * from "./mutations/multi-session/revoke-multi-session-mutation"
 export * from "./mutations/multi-session/set-active-session-mutation"
+export * from "./mutations/oauth-provider/oauth-consent-mutation"
 export * from "./mutations/organization"
 export * from "./mutations/passkey/add-passkey-mutation"
 export * from "./mutations/passkey/delete-passkey-mutation"
@@ -44,6 +49,7 @@ export * from "./queries/api-key/list-api-keys-query"
 export * from "./queries/auth/session-query"
 export * from "./queries/auth-query-options"
 export * from "./queries/multi-session/list-device-sessions-query"
+export * from "./queries/oauth-provider/public-oauth-client-query"
 export * from "./queries/organization"
 export * from "./queries/passkey/list-passkeys-query"
 export * from "./queries/settings/account-info-query"

package/src/lib/auth-client.ts

@@ -1,6 +1,10 @@
 import type { apiKeyClient } from "@better-auth/api-key/client"
+import type { oauthProviderClient } from "@better-auth/oauth-provider/client"
 import type { passkeyClient } from "@better-auth/passkey/client"
 import type {
+  AdminClientOptions,
+  adminClient,
+  deviceAuthorizationClient,
   lastLoginMethodClient,
   magicLinkClient,
   multiSessionClient,
@@ -17,10 +21,22 @@ export type AuthClient = ReturnType<typeof createAuthClient>
 // Turbopack, older configs, etc.) and keeps the plugin packages out of
 // consumers' runtime bundles entirely.
 
+export type AdminAuthClient = ReturnType<
+  typeof createAuthClient<{
+    plugins: [ReturnType<typeof adminClient<AdminClientOptions>>]
+  }>
+>
+
 export type MagicLinkAuthClient = ReturnType<
   typeof createAuthClient<{ plugins: [ReturnType<typeof magicLinkClient>] }>
 >
 
+export type DeviceAuthorizationAuthClient = ReturnType<
+  typeof createAuthClient<{
+    plugins: [ReturnType<typeof deviceAuthorizationClient>]
+  }>
+>
+
 export type LastLoginMethodAuthClient = ReturnType<
   typeof createAuthClient<{
     plugins: [ReturnType<typeof lastLoginMethodClient>]
@@ -39,6 +55,12 @@ export type ApiKeyAuthClient = ReturnType<
   typeof createAuthClient<{ plugins: [ReturnType<typeof apiKeyClient>] }>
 >
 
+export type OAuthProviderAuthClient = ReturnType<
+  typeof createAuthClient<{
+    plugins: [ReturnType<typeof oauthProviderClient>]
+  }>
+>
+
 export type UsernameAuthClient = ReturnType<
   typeof createAuthClient<{ plugins: [ReturnType<typeof usernameClient>] }>
 >

package/src/mutations/admin/stop-impersonating-mutation.ts

@@ -0,0 +1,71 @@
+import { authQueryKeys } from "@better-auth-ui/core"
+import { adminMutationKeys } from "@better-auth-ui/core/plugins"
+import {
+  mutationOptions,
+  type QueryClient,
+  useMutation
+} from "@tanstack/react-query"
+import type { BetterFetchError } from "better-auth/react"
+
+import type { AdminAuthClient } from "../../lib/auth-client"
+
+export type StopImpersonatingParams<TAuthClient extends AdminAuthClient> =
+  Parameters<TAuthClient["admin"]["stopImpersonating"]>[0]
+
+export type StopImpersonatingOptions<TAuthClient extends AdminAuthClient> =
+  Omit<
+    ReturnType<typeof stopImpersonatingOptions<TAuthClient>>,
+    "mutationKey" | "mutationFn" | "meta"
+  >
+
+/**
+ * Mutation options factory for restoring the administrator's session.
+ *
+ * @param authClient - The Better Auth client with the admin plugin.
+ */
+export function stopImpersonatingOptions<TAuthClient extends AdminAuthClient>(
+  authClient: TAuthClient
+) {
+  const mutationKey = adminMutationKeys.stopImpersonating
+
+  const mutationFn = (params?: StopImpersonatingParams<TAuthClient>) =>
+    authClient.admin.stopImpersonating({
+      ...(params ?? {}),
+      fetchOptions: { ...params?.fetchOptions, throw: true }
+    })
+
+  return mutationOptions<
+    Awaited<ReturnType<typeof mutationFn>>,
+    BetterFetchError,
+    Parameters<typeof mutationFn>[0]
+  >({
+    mutationKey,
+    mutationFn
+  })
+}
+
+/**
+ * Stop impersonating a user and restore the administrator's session.
+ *
+ * On success, `MutationInvalidator` awaits invalidation of the session query
+ * so every auth surface immediately reflects the restored administrator.
+ *
+ * @param authClient - The Better Auth client with the admin plugin.
+ * @param options - React Query options forwarded to `useMutation`.
+ */
+export function useStopImpersonating<TAuthClient extends AdminAuthClient>(
+  authClient: TAuthClient,
+  options?: StopImpersonatingOptions<TAuthClient>,
+  queryClient?: QueryClient
+) {
+  return useMutation(
+    {
+      ...stopImpersonatingOptions(authClient),
+      ...options,
+      meta: {
+        awaits: [authQueryKeys.session]
+      }
+    },
+    queryClient
+  )
+}

package/src/mutations/device-authorization/approve-device-mutation.ts

@@ -0,0 +1,45 @@
+import { deviceAuthorizationMutationKeys } from "@better-auth-ui/core/plugins"
+import { useMutation } from "@tanstack/react-query"
+
+import type { DeviceAuthorizationAuthClient } from "../../lib/auth-client"
+import { authMutationOptions } from "../auth-mutation-options"
+
+export type ApproveDeviceParams<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Parameters<TAuthClient["device"]["approve"]>[0]
+
+export type ApproveDeviceOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Omit<
+  ReturnType<typeof approveDeviceOptions<TAuthClient>>,
+  "mutationKey" | "mutationFn"
+>
+
+/**
+ * Mutation options factory for approving a pending device request.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ */
+export function approveDeviceOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient) {
+  return authMutationOptions(
+    authClient.device.approve,
+    deviceAuthorizationMutationKeys.approve
+  )
+}
+
+/**
+ * Create a mutation for approving a pending device request.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ * @param options - React Query options forwarded to `useMutation`.
+ */
+export function useApproveDevice<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient, options?: ApproveDeviceOptions<TAuthClient>) {
+  return useMutation({
+    ...approveDeviceOptions(authClient),
+    ...options
+  })
+}

package/src/mutations/device-authorization/deny-device-mutation.ts

@@ -0,0 +1,45 @@
+import { deviceAuthorizationMutationKeys } from "@better-auth-ui/core/plugins"
+import { useMutation } from "@tanstack/react-query"
+
+import type { DeviceAuthorizationAuthClient } from "../../lib/auth-client"
+import { authMutationOptions } from "../auth-mutation-options"
+
+export type DenyDeviceParams<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Parameters<TAuthClient["device"]["deny"]>[0]
+
+export type DenyDeviceOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Omit<
+  ReturnType<typeof denyDeviceOptions<TAuthClient>>,
+  "mutationKey" | "mutationFn"
+>
+
+/**
+ * Mutation options factory for denying a pending device request.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ */
+export function denyDeviceOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient) {
+  return authMutationOptions(
+    authClient.device.deny,
+    deviceAuthorizationMutationKeys.deny
+  )
+}
+
+/**
+ * Create a mutation for denying a pending device request.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ * @param options - React Query options forwarded to `useMutation`.
+ */
+export function useDenyDevice<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient, options?: DenyDeviceOptions<TAuthClient>) {
+  return useMutation({
+    ...denyDeviceOptions(authClient),
+    ...options
+  })
+}

package/src/mutations/device-authorization/verify-device-code-mutation.ts

@@ -0,0 +1,48 @@
+import { deviceAuthorizationMutationKeys } from "@better-auth-ui/core/plugins"
+import { useMutation } from "@tanstack/react-query"
+
+import type { DeviceAuthorizationAuthClient } from "../../lib/auth-client"
+import { authMutationOptions } from "../auth-mutation-options"
+
+export type VerifyDeviceCodeParams<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Parameters<TAuthClient["device"]>[0]
+
+export type VerifyDeviceCodeOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+> = Omit<
+  ReturnType<typeof verifyDeviceCodeOptions<TAuthClient>>,
+  "mutationKey" | "mutationFn"
+>
+
+/**
+ * Mutation options factory for verifying and claiming a device user code.
+ *
+ * The Better Auth endpoint uses GET, but this operation is modeled as a
+ * mutation because verification binds the code to the current session.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ */
+export function verifyDeviceCodeOptions<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient) {
+  return authMutationOptions(
+    authClient.device,
+    deviceAuthorizationMutationKeys.verify
+  )
+}
+
+/**
+ * Create a mutation for verifying and claiming a device user code.
+ *
+ * @param authClient - The Better Auth client with the device-authorization plugin.
+ * @param options - React Query options forwarded to `useMutation`.
+ */
+export function useVerifyDeviceCode<
+  TAuthClient extends DeviceAuthorizationAuthClient
+>(authClient: TAuthClient, options?: VerifyDeviceCodeOptions<TAuthClient>) {
+  return useMutation({
+    ...verifyDeviceCodeOptions(authClient),
+    ...options
+  })
+}

package/src/mutations/oauth-provider/oauth-consent-mutation.ts

@@ -0,0 +1,41 @@
+import { oauthProviderMutationKeys } from "@better-auth-ui/core/plugins"
+import { useMutation } from "@tanstack/react-query"
+
+import type { OAuthProviderAuthClient } from "../../lib/auth-client"
+import { authMutationOptions } from "../auth-mutation-options"
+
+export type OAuthConsentParams<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = Parameters<TAuthClient["oauth2"]["consent"]>[0]
+
+export type OAuthConsentOptions<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = Omit<
+  ReturnType<typeof oauthConsentOptions<TAuthClient>>,
+  "mutationKey" | "mutationFn"
+>
+
+/**
+ * Mutation options factory for accepting or denying an OAuth request.
+ *
+ * Better Auth reads the signed authorization query from the current URL and
+ * validates the resulting redirect.
+ */
+export function oauthConsentOptions<
+  TAuthClient extends OAuthProviderAuthClient
+>(authClient: TAuthClient) {
+  return authMutationOptions(
+    authClient.oauth2.consent,
+    oauthProviderMutationKeys.consent
+  )
+}
+
+export function useOAuthConsent<TAuthClient extends OAuthProviderAuthClient>(
+  authClient: TAuthClient,
+  options?: OAuthConsentOptions<TAuthClient>
+) {
+  return useMutation({
+    ...oauthConsentOptions(authClient),
+    ...options
+  })
+}

package/src/queries/oauth-provider/public-oauth-client-query.ts

@@ -0,0 +1,131 @@
+import { oauthProviderQueryKeys } from "@better-auth-ui/core/plugins"
+import {
+  type DataTag,
+  type QueryClient,
+  queryOptions,
+  skipToken,
+  useQuery
+} from "@tanstack/react-query"
+import type { BetterFetchError } from "better-auth/react"
+
+import type { InferData, OAuthProviderAuthClient } from "../../lib/auth-client"
+
+export type PublicOAuthClientData<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = InferData<TAuthClient["oauth2"]["publicClient"]>
+
+export type PublicOAuthClientParams<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = Partial<
+  Omit<
+    NonNullable<Parameters<TAuthClient["oauth2"]["publicClient"]>[0]>,
+    "query"
+  >
+>
+
+export type PublicOAuthClientOptions<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = Omit<
+  ReturnType<typeof publicOAuthClientOptions<TAuthClient>>,
+  "queryKey" | "queryFn"
+>
+
+/**
+ * Query options factory for an OAuth application's public metadata.
+ *
+ * @param authClient - The Better Auth client with the OAuth provider plugin.
+ * @param clientId - The OAuth client ID from the signed authorization request.
+ * @param params - Fetch options forwarded to `oauth2.publicClient`.
+ */
+export function publicOAuthClientOptions<
+  TAuthClient extends OAuthProviderAuthClient
+>(
+  authClient: TAuthClient,
+  clientId: string,
+  params?: PublicOAuthClientParams<TAuthClient>
+) {
+  type TData = PublicOAuthClientData<TAuthClient>
+  const queryKey = oauthProviderQueryKeys.publicClient(clientId)
+
+  const options = queryOptions<TData, BetterFetchError, TData, typeof queryKey>(
+    {
+      queryKey,
+      queryFn: ({ signal }) =>
+        authClient.oauth2.publicClient({
+          ...params,
+          query: { client_id: clientId },
+          fetchOptions: { ...params?.fetchOptions, signal, throw: true }
+        }) as Promise<TData>
+    }
+  )
+
+  return options as typeof options & {
+    queryKey: DataTag<typeof queryKey, TData, BetterFetchError>
+  }
+}
+
+export const ensurePublicOAuthClient = <
+  TAuthClient extends OAuthProviderAuthClient
+>(
+  queryClient: QueryClient,
+  authClient: TAuthClient,
+  clientId: string,
+  params?: PublicOAuthClientParams<TAuthClient>
+) =>
+  queryClient.ensureQueryData(
+    publicOAuthClientOptions(authClient, clientId, params)
+  )
+
+export const prefetchPublicOAuthClient = <
+  TAuthClient extends OAuthProviderAuthClient
+>(
+  queryClient: QueryClient,
+  authClient: TAuthClient,
+  clientId: string,
+  params?: PublicOAuthClientParams<TAuthClient>
+) =>
+  queryClient.prefetchQuery(
+    publicOAuthClientOptions(authClient, clientId, params)
+  )
+
+export const fetchPublicOAuthClient = <
+  TAuthClient extends OAuthProviderAuthClient
+>(
+  queryClient: QueryClient,
+  authClient: TAuthClient,
+  clientId: string,
+  params?: PublicOAuthClientParams<TAuthClient>
+) =>
+  queryClient.fetchQuery(publicOAuthClientOptions(authClient, clientId, params))
+
+export type UsePublicOAuthClientOptions<
+  TAuthClient extends OAuthProviderAuthClient = OAuthProviderAuthClient
+> = PublicOAuthClientOptions<TAuthClient> & PublicOAuthClientParams<TAuthClient>
+
+/**
+ * Subscribe to an OAuth application's public metadata.
+ *
+ * The query is disabled until a client ID is available.
+ */
+export function usePublicOAuthClient<
+  TAuthClient extends OAuthProviderAuthClient
+>(
+  authClient: TAuthClient,
+  clientId: string | undefined,
+  options: UsePublicOAuthClientOptions<TAuthClient> = {},
+  queryClient?: QueryClient
+) {
+  const { fetchOptions, ...queryOptionsRest } = options
+  const baseOptions = publicOAuthClientOptions(authClient, clientId ?? "", {
+    fetchOptions
+  } as PublicOAuthClientParams<TAuthClient>)
+
+  return useQuery(
+    {
+      ...queryOptionsRest,
+      ...baseOptions,
+      queryFn: clientId ? baseOptions.queryFn : skipToken
+    },
+    queryClient
+  )
+}