@better-auth-ui/react 1.6.0

package/dist/hooks/auth/use-sign-in-social.d.ts

@@ -0,0 +1,93 @@
+import { type AuthClient } from "@better-auth-ui/react";
+import type { UseAuthMutationOptions } from "./use-auth-mutation";
+export { useAuthMutation } from "./use-auth-mutation";
+/**
+ * Hook that creates a mutation for social sign-in.
+ *
+ * The mutation initiates a social sign-in flow with the specified provider.
+ *
+ * @returns The `useMutation` result.
+ */
+export declare function useSignInSocial(options?: UseAuthMutationOptions<AuthClient["signIn"]["social"]>): import("./use-auth-mutation").UseAuthMutationResult<(<FetchOptions extends import("better-auth").ClientFetchOption<Partial<{
+    provider: "github" | "apple" | "atlassian" | "cognito" | "discord" | "facebook" | "figma" | "microsoft" | "google" | "huggingface" | "slack" | "spotify" | "twitch" | "twitter" | "dropbox" | "kick" | "linear" | "linkedin" | "gitlab" | "tiktok" | "reddit" | "roblox" | "salesforce" | "vk" | "zoom" | "notion" | "kakao" | "naver" | "line" | "paybin" | "paypal" | "polar" | "railway" | "vercel" | "wechat" | (string & {});
+    callbackURL?: string | undefined;
+    newUserCallbackURL?: string | undefined;
+    errorCallbackURL?: string | undefined;
+    disableRedirect?: boolean | undefined;
+    idToken?: {
+        token: string;
+        nonce?: string | undefined;
+        accessToken?: string | undefined;
+        refreshToken?: string | undefined;
+        expiresAt?: number | undefined;
+        user?: {
+            name?: {
+                firstName?: string | undefined;
+                lastName?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+        } | undefined;
+    } | undefined;
+    scopes?: string[] | undefined;
+    requestSignUp?: boolean | undefined;
+    loginHint?: string | undefined;
+    additionalData?: Record<string, any> | undefined;
+}> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: import("better-auth").Prettify<{
+    provider: "github" | "apple" | "atlassian" | "cognito" | "discord" | "facebook" | "figma" | "microsoft" | "google" | "huggingface" | "slack" | "spotify" | "twitch" | "twitter" | "dropbox" | "kick" | "linear" | "linkedin" | "gitlab" | "tiktok" | "reddit" | "roblox" | "salesforce" | "vk" | "zoom" | "notion" | "kakao" | "naver" | "line" | "paybin" | "paypal" | "polar" | "railway" | "vercel" | "wechat" | (string & {});
+    callbackURL?: string | undefined;
+    newUserCallbackURL?: string | undefined;
+    errorCallbackURL?: string | undefined;
+    disableRedirect?: boolean | undefined;
+    idToken?: {
+        token: string;
+        nonce?: string | undefined;
+        accessToken?: string | undefined;
+        refreshToken?: string | undefined;
+        expiresAt?: number | undefined;
+        user?: {
+            name?: {
+                firstName?: string | undefined;
+                lastName?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+        } | undefined;
+    } | undefined;
+    scopes?: string[] | undefined;
+    requestSignUp?: boolean | undefined;
+    loginHint?: string | undefined;
+    additionalData?: Record<string, any> | undefined;
+} & {
+    fetchOptions?: FetchOptions | undefined;
+}>, data_1?: FetchOptions | undefined) => Promise<import("better-auth/react").BetterFetchResponse<{
+    redirect: boolean;
+    url: string;
+} | (Omit<{
+    redirect: boolean;
+    token: string;
+    url: undefined;
+    user: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined | undefined;
+    };
+}, "user"> & {
+    user: import("better-auth").StripEmptyObjects<{
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined;
+    } & {} & {
+        username?: string | null | undefined;
+        displayUsername?: string | null | undefined;
+    }>;
+}), {
+    code?: string | undefined;
+    message?: string | undefined;
+}, FetchOptions["throw"] extends true ? true : false>>)>;

package/dist/hooks/auth/use-sign-in-social.js

@@ -0,0 +1,13 @@
+import { useAuth, useAuthMutation } from "@better-auth-ui/react";
+export { useAuthMutation } from "./use-auth-mutation";
+/**
+ * Hook that creates a mutation for social sign-in.
+ *
+ * The mutation initiates a social sign-in flow with the specified provider.
+ *
+ * @returns The `useMutation` result.
+ */
+export function useSignInSocial(options) {
+    const { authClient } = useAuth();
+    return useAuthMutation({ authFn: authClient.signIn.social, options });
+}

package/dist/hooks/auth/use-sign-out.d.ts

@@ -0,0 +1,19 @@
+import { type AuthClient } from "@better-auth-ui/react";
+import type { UseAuthMutationOptions } from "./use-auth-mutation";
+export { useAuthMutation } from "./use-auth-mutation";
+/**
+ * Hook that creates a mutation for signing out.
+ *
+ * The mutation signs out the current user and removes auth queries from cache.
+ *
+ * @returns The `useMutation` result.
+ */
+export declare function useSignOut(options?: UseAuthMutationOptions<AuthClient["signOut"]>): import("./use-auth-mutation").UseAuthMutationResult<(<FetchOptions extends import("better-auth").ClientFetchOption<never, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0?: import("better-auth").Prettify<{
+    query?: Record<string, any> | undefined;
+    fetchOptions?: FetchOptions | undefined;
+}> | undefined, data_1?: FetchOptions | undefined) => Promise<import("better-auth/react").BetterFetchResponse<{
+    success: boolean;
+}, {
+    code?: string | undefined;
+    message?: string | undefined;
+}, FetchOptions["throw"] extends true ? true : false>>)>;

package/dist/hooks/auth/use-sign-out.js

@@ -0,0 +1,24 @@
+import { useAuth, useAuthMutation } from "@better-auth-ui/react";
+import { useQueryClient } from "@tanstack/react-query";
+export { useAuthMutation } from "./use-auth-mutation";
+/**
+ * Hook that creates a mutation for signing out.
+ *
+ * The mutation signs out the current user and removes auth queries from cache.
+ *
+ * @returns The `useMutation` result.
+ */
+export function useSignOut(options) {
+    const { authClient } = useAuth();
+    const queryClient = useQueryClient();
+    return useAuthMutation({
+        authFn: authClient.signOut,
+        options: {
+            ...options,
+            onSuccess: async (...args) => {
+                queryClient.removeQueries({ queryKey: ["auth"] });
+                await options?.onSuccess?.(...args);
+            }
+        }
+    });
+}

package/dist/hooks/auth/use-sign-up-email.d.ts

@@ -0,0 +1,526 @@
+import { type AuthClient } from "@better-auth-ui/react";
+import type { UseAuthMutationOptions } from "./use-auth-mutation";
+export { useAuthMutation } from "./use-auth-mutation";
+/**
+ * Hook that creates a mutation for email/password sign-up.
+ *
+ * The mutation sends an email/password sign-up request and
+ * refetches the session on success.
+ *
+ * @returns The `useMutation` result.
+ */
+export declare function useSignUpEmail(options?: UseAuthMutationOptions<AuthClient["signUp"]["email"]>): import("./use-auth-mutation").UseAuthMutationResult<(<FetchOptions extends import("better-auth").ClientFetchOption<Partial<{
+    name: string;
+    email: string;
+    password: string;
+    image?: string | undefined;
+    callbackURL?: string | undefined;
+    rememberMe?: boolean | undefined;
+}> & Record<string, any>, Partial<Record<string, any>> & Record<string, any>, Record<string, any> | undefined>>(data_0: import("better-auth").Prettify<import("better-auth/client").InferSignUpEmailCtx<{
+    plugins: ({
+        id: "magic-link";
+        version: string;
+        $InferServerPlugin: ReturnType<(options: import("better-auth/plugins/magic-link").MagicLinkOptions) => {
+            id: "magic-link";
+            version: string;
+            endpoints: {
+                signInMagicLink: import("better-auth").StrictEndpoint<"/sign-in/magic-link", {
+                    method: "POST";
+                    requireHeaders: true;
+                    body: import("zod").ZodObject<{
+                        email: import("zod").ZodEmail;
+                        name: import("zod").ZodOptional<import("zod").ZodString>;
+                        callbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                        newUserCallbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                        errorCallbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                        metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+                    }, import("zod/v4/core").$strip>;
+                    metadata: {
+                        openapi: {
+                            operationId: string;
+                            description: string;
+                            responses: {
+                                200: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    status: {
+                                                        type: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    status: boolean;
+                }>;
+                magicLinkVerify: import("better-auth").StrictEndpoint<"/magic-link/verify", {
+                    method: "GET";
+                    query: import("zod").ZodObject<{
+                        token: import("zod").ZodString;
+                        callbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                        errorCallbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                        newUserCallbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                    }, import("zod/v4/core").$strip>;
+                    use: ((inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<void>)[];
+                    requireHeaders: true;
+                    metadata: {
+                        openapi: {
+                            operationId: string;
+                            description: string;
+                            responses: {
+                                200: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    session: {
+                                                        $ref: string;
+                                                    };
+                                                    user: {
+                                                        $ref: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    token: string;
+                    user: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    };
+                    session: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        userId: string;
+                        expiresAt: Date;
+                        token: string;
+                        ipAddress?: string | null | undefined;
+                        userAgent?: string | null | undefined;
+                    };
+                }>;
+            };
+            rateLimit: {
+                pathMatcher(path: string): boolean;
+                window: number;
+                max: number;
+            }[];
+            options: import("better-auth/plugins/magic-link").MagicLinkOptions;
+        }>;
+    } | {
+        id: "multi-session";
+        version: string;
+        $InferServerPlugin: ReturnType<(options?: import("better-auth/plugins/multi-session").MultiSessionConfig | undefined) => {
+            id: "multi-session";
+            version: string;
+            endpoints: {
+                listDeviceSessions: import("better-auth").StrictEndpoint<"/multi-session/list-device-sessions", {
+                    method: "GET";
+                    requireHeaders: true;
+                }, {
+                    session: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        userId: string;
+                        expiresAt: Date;
+                        token: string;
+                        ipAddress?: string | null | undefined;
+                        userAgent?: string | null | undefined;
+                    };
+                    user: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    };
+                }[]>;
+                setActiveSession: import("better-auth").StrictEndpoint<"/multi-session/set-active", {
+                    method: "POST";
+                    body: import("zod").ZodObject<{
+                        sessionToken: import("zod").ZodString;
+                    }, import("zod/v4/core").$strip>;
+                    requireHeaders: true;
+                    metadata: {
+                        openapi: {
+                            description: string;
+                            responses: {
+                                200: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    session: {
+                                                        $ref: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    session: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        userId: string;
+                        expiresAt: Date;
+                        token: string;
+                        ipAddress?: string | null | undefined;
+                        userAgent?: string | null | undefined;
+                    } & Record<string, any>;
+                    user: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    } & Record<string, any>;
+                }>;
+                revokeDeviceSession: import("better-auth").StrictEndpoint<"/multi-session/revoke", {
+                    method: "POST";
+                    body: import("zod").ZodObject<{
+                        sessionToken: import("zod").ZodString;
+                    }, import("zod/v4/core").$strip>;
+                    requireHeaders: true;
+                    use: ((inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<{
+                        session: {
+                            session: Record<string, any> & {
+                                id: string;
+                                createdAt: Date;
+                                updatedAt: Date;
+                                userId: string;
+                                expiresAt: Date;
+                                token: string;
+                                ipAddress?: string | null | undefined;
+                                userAgent?: string | null | undefined;
+                            };
+                            user: Record<string, any> & {
+                                id: string;
+                                createdAt: Date;
+                                updatedAt: Date;
+                                email: string;
+                                emailVerified: boolean;
+                                name: string;
+                                image?: string | null | undefined;
+                            };
+                        };
+                    }>)[];
+                    metadata: {
+                        openapi: {
+                            description: string;
+                            responses: {
+                                200: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    status: {
+                                                        type: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    status: boolean;
+                }>;
+            };
+            hooks: {
+                after: {
+                    matcher: (context: import("better-auth").HookEndpointContext) => boolean;
+                    handler: (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<void>;
+                }[];
+            };
+            options: import("better-auth/plugins/multi-session").MultiSessionConfig | undefined;
+            $ERROR_CODES: {
+                INVALID_SESSION_TOKEN: import("better-auth").RawError<"INVALID_SESSION_TOKEN">;
+            };
+        }>;
+        atomListeners: {
+            matcher(path: string): path is "/multi-session/set-active";
+            signal: "$sessionSignal";
+        }[];
+        $ERROR_CODES: {
+            INVALID_SESSION_TOKEN: import("better-auth").RawError<"INVALID_SESSION_TOKEN">;
+        };
+    } | {
+        id: "username";
+        version: string;
+        $InferServerPlugin: ReturnType<(options?: import("better-auth/plugins/username").UsernameOptions | undefined) => {
+            id: "username";
+            version: string;
+            init(ctx: import("better-auth").AuthContext): {
+                options: {
+                    databaseHooks: {
+                        user: {
+                            create: {
+                                before(user: {
+                                    id: string;
+                                    createdAt: Date;
+                                    updatedAt: Date;
+                                    email: string;
+                                    emailVerified: boolean;
+                                    name: string;
+                                    image?: string | null | undefined;
+                                } & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null): Promise<{
+                                    data: {
+                                        displayUsername?: string | undefined;
+                                        username?: string | undefined;
+                                        id: string;
+                                        createdAt: Date;
+                                        updatedAt: Date;
+                                        email: string;
+                                        emailVerified: boolean;
+                                        name: string;
+                                        image?: string | null | undefined;
+                                    };
+                                }>;
+                            };
+                            update: {
+                                before(user: Partial<{
+                                    id: string;
+                                    createdAt: Date;
+                                    updatedAt: Date;
+                                    email: string;
+                                    emailVerified: boolean;
+                                    name: string;
+                                    image?: string | null | undefined;
+                                }> & Record<string, unknown>, context: import("better-auth").GenericEndpointContext | null): Promise<{
+                                    data: {
+                                        displayUsername?: string | undefined;
+                                        username?: string | undefined;
+                                        id?: string | undefined;
+                                        createdAt?: Date | undefined;
+                                        updatedAt?: Date | undefined;
+                                        email?: string | undefined;
+                                        emailVerified?: boolean | undefined;
+                                        name?: string | undefined;
+                                        image?: string | null | undefined;
+                                    };
+                                }>;
+                            };
+                        };
+                    };
+                };
+            };
+            endpoints: {
+                signInUsername: import("better-auth").StrictEndpoint<"/sign-in/username", {
+                    method: "POST";
+                    body: import("zod").ZodObject<{
+                        username: import("zod").ZodString;
+                        password: import("zod").ZodString;
+                        rememberMe: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                        callbackURL: import("zod").ZodOptional<import("zod").ZodString>;
+                    }, import("zod/v4/core").$strip>;
+                    metadata: {
+                        openapi: {
+                            summary: string;
+                            description: string;
+                            responses: {
+                                200: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    token: {
+                                                        type: string;
+                                                        description: string;
+                                                    };
+                                                    user: {
+                                                        $ref: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                            };
+                                        };
+                                    };
+                                };
+                                422: {
+                                    description: string;
+                                    content: {
+                                        "application/json": {
+                                            schema: {
+                                                type: "object";
+                                                properties: {
+                                                    message: {
+                                                        type: string;
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    token: string;
+                    user: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    } & {
+                        username: string;
+                        displayUsername: string;
+                    };
+                }>;
+                isUsernameAvailable: import("better-auth").StrictEndpoint<"/is-username-available", {
+                    method: "POST";
+                    body: import("zod").ZodObject<{
+                        username: import("zod").ZodString;
+                    }, import("zod/v4/core").$strip>;
+                }, {
+                    available: boolean;
+                }>;
+            };
+            schema: {
+                user: {
+                    fields: {
+                        username: {
+                            type: "string";
+                            required: false;
+                            sortable: true;
+                            unique: true;
+                            returned: true;
+                            transform: {
+                                input(value: import("better-auth").DBPrimitive): string | number | boolean | Date | Record<string, unknown> | unknown[] | null | undefined;
+                            };
+                        };
+                        displayUsername: {
+                            type: "string";
+                            required: false;
+                            transform: {
+                                input(value: import("better-auth").DBPrimitive): string | number | boolean | Date | Record<string, unknown> | unknown[] | null | undefined;
+                            };
+                        };
+                    };
+                };
+            };
+            hooks: {
+                before: {
+                    matcher(context: import("better-auth").HookEndpointContext): boolean;
+                    handler: (inputContext: import("better-auth").MiddlewareInputContext<import("better-auth").MiddlewareOptions>) => Promise<void>;
+                }[];
+            };
+            options: import("better-auth/plugins/username").UsernameOptions | undefined;
+            $ERROR_CODES: {
+                EMAIL_NOT_VERIFIED: import("better-auth").RawError<"EMAIL_NOT_VERIFIED">;
+                UNEXPECTED_ERROR: import("better-auth").RawError<"UNEXPECTED_ERROR">;
+                INVALID_USERNAME_OR_PASSWORD: import("better-auth").RawError<"INVALID_USERNAME_OR_PASSWORD">;
+                USERNAME_IS_ALREADY_TAKEN: import("better-auth").RawError<"USERNAME_IS_ALREADY_TAKEN">;
+                USERNAME_TOO_SHORT: import("better-auth").RawError<"USERNAME_TOO_SHORT">;
+                USERNAME_TOO_LONG: import("better-auth").RawError<"USERNAME_TOO_LONG">;
+                INVALID_USERNAME: import("better-auth").RawError<"INVALID_USERNAME">;
+                INVALID_DISPLAY_USERNAME: import("better-auth").RawError<"INVALID_DISPLAY_USERNAME">;
+            };
+        }>;
+        atomListeners: {
+            matcher: (path: string) => path is "/sign-in/username";
+            signal: "$sessionSignal";
+        }[];
+        $ERROR_CODES: {
+            EMAIL_NOT_VERIFIED: import("better-auth").RawError<"EMAIL_NOT_VERIFIED">;
+            UNEXPECTED_ERROR: import("better-auth").RawError<"UNEXPECTED_ERROR">;
+            INVALID_USERNAME_OR_PASSWORD: import("better-auth").RawError<"INVALID_USERNAME_OR_PASSWORD">;
+            USERNAME_IS_ALREADY_TAKEN: import("better-auth").RawError<"USERNAME_IS_ALREADY_TAKEN">;
+            USERNAME_TOO_SHORT: import("better-auth").RawError<"USERNAME_TOO_SHORT">;
+            USERNAME_TOO_LONG: import("better-auth").RawError<"USERNAME_TOO_LONG">;
+            INVALID_USERNAME: import("better-auth").RawError<"INVALID_USERNAME">;
+            INVALID_DISPLAY_USERNAME: import("better-auth").RawError<"INVALID_DISPLAY_USERNAME">;
+        };
+    })[];
+}, FetchOptions>>, data_1?: FetchOptions | undefined) => Promise<import("better-auth/react").BetterFetchResponse<(Omit<{
+    token: null;
+    user: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined | undefined;
+    };
+}, "user"> & {
+    user: import("better-auth").StripEmptyObjects<{
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined;
+    } & {} & {
+        username?: string | null | undefined;
+        displayUsername?: string | null | undefined;
+    }>;
+}) | (Omit<{
+    token: string;
+    user: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined | undefined;
+    };
+}, "user"> & {
+    user: import("better-auth").StripEmptyObjects<{
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        email: string;
+        emailVerified: boolean;
+        name: string;
+        image?: string | null | undefined;
+    } & {} & {
+        username?: string | null | undefined;
+        displayUsername?: string | null | undefined;
+    }>;
+}), {
+    code?: string | undefined;
+    message?: string | undefined;
+}, FetchOptions["throw"] extends true ? true : false>>)>;