better-auth-ui 3.2.5

package/dist/auth-ui-provider-BsH3xJDw.d.ts

@@ -0,0 +1,697 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { ComponentType, ReactNode } from 'react';
+import { f as AccountViewPaths, g as OrganizationViewPaths, h as authLocalization, c as AuthViewPaths, A as AuthLocalization } from './view-paths-CHSJf5dv.js';
+import { b as AuthClient, a as AuthHooks, A as AnyAuthClient } from './auth-hooks-IOEvlYYv.js';
+import { A as AuthMutators } from './auth-mutators-DdqOmQ32.js';
+import { SocialProvider } from 'better-auth/social-providers';
+
+type PasswordValidation = {
+    /**
+     * Maximum password length
+     */
+    maxLength?: number;
+    /**
+     * Minimum password length
+     */
+    minLength?: number;
+    /**
+     * Password validation regex
+     */
+    regex?: RegExp;
+};
+
+interface ProviderIconProps {
+    className?: string;
+}
+type ProviderIcon = ComponentType<ProviderIconProps>;
+declare const AppleIcon: ProviderIcon;
+declare const DiscordIcon: ProviderIcon;
+declare const DropboxIcon: ProviderIcon;
+declare const FacebookIcon: ProviderIcon;
+declare const GitHubIcon: ProviderIcon;
+declare const GitLabIcon: ProviderIcon;
+declare const GoogleIcon: ProviderIcon;
+declare const HuggingFaceIcon: ProviderIcon;
+declare const KickIcon: ProviderIcon;
+declare const LinearIcon: ProviderIcon;
+declare const LinkedInIcon: ProviderIcon;
+declare const MicrosoftIcon: ProviderIcon;
+declare const NotionIcon: ProviderIcon;
+declare const RedditIcon: ProviderIcon;
+declare const RobloxIcon: ProviderIcon;
+declare const SlackIcon: ProviderIcon;
+declare const SpotifyIcon: ProviderIcon;
+declare const TikTokIcon: ProviderIcon;
+declare const TwitchIcon: ProviderIcon;
+declare const VKIcon: ProviderIcon;
+declare const XIcon: ProviderIcon;
+declare const ZoomIcon: ProviderIcon;
+
+type FieldType = "string" | "number" | "boolean";
+interface AdditionalField {
+    description?: ReactNode;
+    instructions?: ReactNode;
+    label: ReactNode;
+    placeholder?: string;
+    required?: boolean;
+    type: FieldType;
+    /**
+     * Render a multi-line textarea for string fields
+     */
+    multiline?: boolean;
+    validate?: (value: string) => Promise<boolean>;
+}
+interface AdditionalFields {
+    [key: string]: AdditionalField;
+}
+
+type AccountOptions = {
+    /**
+     * Base path for account-scoped views
+     * @default "/account"
+     */
+    basePath?: string;
+    /**
+     * Array of fields to show in Account Settings
+     * @default ["image", "name"]
+     */
+    fields: string[];
+    /**
+     * Customize account view paths
+     */
+    viewPaths?: Partial<AccountViewPaths>;
+};
+type AccountOptionsContext = {
+    /**
+     * Base path for account-scoped views
+     * @default "/account"
+     */
+    basePath: string;
+    /**
+     * Array of fields to show in Account Settings
+     * @default ["image", "name"]
+     */
+    fields: string[];
+    /**
+     * Customize account view paths
+     */
+    viewPaths: AccountViewPaths;
+};
+
+type Image = ComponentType<{
+    src: string;
+    alt: string;
+    className?: string;
+}>;
+
+type AvatarOptions = {
+    /**
+     * Upload an avatar image and return the URL string
+     * @remarks `(file: File) => Promise<string>`
+     */
+    upload?: (file: File) => Promise<string | undefined | null>;
+    /**
+     * Delete a previously uploaded avatar image from your storage/CDN
+     * @remarks `(url: string) => Promise<void>`
+     */
+    delete?: (url: string) => Promise<void>;
+    /**
+     * Avatar size for resizing
+     * @default 128 (or 256 if upload is provided)
+     */
+    size: number;
+    /**
+     * File extension for avatar uploads
+     * @default "png"
+     */
+    extension: string;
+    /**
+     * Custom Image component for rendering avatar images
+     * @default AvatarImage from Radix UI
+     */
+    Image?: Image;
+};
+
+type CaptchaProvider = "cloudflare-turnstile" | "google-recaptcha-v2-checkbox" | "google-recaptcha-v2-invisible" | "google-recaptcha-v3" | "hcaptcha";
+
+type CaptchaOptions = {
+    /**
+     * Captcha site key
+     */
+    siteKey: string;
+    /**
+     * Captcha provider type
+     */
+    provider: CaptchaProvider;
+    /**
+     * Hide the captcha badge
+     * @default false
+     */
+    hideBadge?: boolean;
+    /**
+     * Use recaptcha.net domain instead of google.com
+     * @default false
+     */
+    recaptchaNet?: boolean;
+    /**
+     * Enable enterprise mode for Google reCAPTCHA
+     * @default false
+     */
+    enterprise?: boolean;
+    /**
+     * Overrides the default array of paths where captcha validation is enforced
+     * @default ["/sign-up/email", "/sign-in/email", "/forget-password"]
+     */
+    endpoints?: string[];
+};
+
+type CredentialsOptions = {
+    /**
+     * Enable or disable the Confirm Password input
+     * @default false
+     */
+    confirmPassword?: boolean;
+    /**
+     * Enable or disable Forgot Password flow
+     * @default true
+     */
+    forgotPassword?: boolean;
+    /**
+     * Customize the password validation
+     */
+    passwordValidation?: PasswordValidation;
+    /**
+     * Enable or disable Remember Me checkbox
+     * @default false
+     */
+    rememberMe?: boolean;
+    /**
+     * Enable or disable Username support
+     * @default false
+     */
+    username?: boolean;
+};
+
+type DeleteUserOptions = {
+    /**
+     * Enable or disable email verification for account deletion
+     * @default undefined
+     */
+    verification?: boolean;
+};
+
+declare const socialProviders: readonly [{
+    readonly provider: "apple";
+    readonly name: "Apple";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "discord";
+    readonly name: "Discord";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "dropbox";
+    readonly name: "Dropbox";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "facebook";
+    readonly name: "Facebook";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "github";
+    readonly name: "GitHub";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "gitlab";
+    readonly name: "GitLab";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "google";
+    readonly name: "Google";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "huggingface";
+    readonly name: "Hugging Face";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "kick";
+    readonly name: "Kick";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "linear";
+    readonly name: "Linear";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "linkedin";
+    readonly name: "LinkedIn";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "microsoft";
+    readonly name: "Microsoft";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "notion";
+    readonly name: "Notion";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "reddit";
+    readonly name: "Reddit";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "roblox";
+    readonly name: "Roblox";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "slack";
+    readonly name: "Slack";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "spotify";
+    readonly name: "Spotify";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "tiktok";
+    readonly name: "TikTok";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "twitch";
+    readonly name: "Twitch";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "vk";
+    readonly name: "VK";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "twitter";
+    readonly name: "X";
+    readonly icon: ProviderIcon;
+}, {
+    readonly provider: "zoom";
+    readonly name: "Zoom";
+    readonly icon: ProviderIcon;
+}];
+type Provider = {
+    provider: string;
+    name: string;
+    icon?: ProviderIcon;
+};
+
+type GenericOAuthOptions = {
+    /**
+     * Custom OAuth Providers
+     * @default []
+     */
+    providers: Provider[];
+    /**
+     * Custom generic OAuth sign in function
+     */
+    signIn?: (params: Parameters<AuthClient["signIn"]["oauth2"]>[0]) => Promise<unknown>;
+};
+
+type GravatarOptions = {
+    /**
+     * Default image type or URL
+     * Options: '404', 'mp', 'identicon', 'monsterid', 'wavatar', 'retro', 'robohash', 'blank', or custom URL
+     */
+    d?: string;
+    /**
+     * Image size in pixels (1-2048)
+     */
+    size?: number;
+    /**
+     * Whether to append .jpg extension to the hash
+     * @default false
+     */
+    jpg?: boolean;
+    /**
+     * Force default image even if user has Gravatar
+     * @default false
+     */
+    forceDefault?: boolean;
+};
+
+type Link = ComponentType<{
+    href: string;
+    className?: string;
+    children: ReactNode;
+}>;
+
+type OrganizationLogoOptions = {
+    /**
+     * Upload a logo image and return the URL string
+     * @remarks `(file: File) => Promise<string>`
+     */
+    upload?: (file: File) => Promise<string | undefined | null>;
+    /**
+     * Delete a previously uploaded logo image from your storage/CDN
+     * @remarks `(url: string) => Promise<void>`
+     */
+    delete?: (url: string) => Promise<void>;
+    /**
+     * Logo size for resizing
+     * @default 256 if upload is provided, 128 otherwise
+     */
+    size: number;
+    /**
+     * File extension for logo uploads
+     * @default "png"
+     */
+    extension: string;
+};
+
+type OrganizationOptions = {
+    /**
+     * Logo configuration
+     * @default undefined
+     */
+    logo?: boolean | Partial<OrganizationLogoOptions>;
+    /**
+     * Custom roles to add to the built-in roles (owner, admin, member)
+     * @default []
+     */
+    customRoles?: Array<{
+        role: string;
+        label: string;
+    }>;
+    /**
+     * Enable or disable API key support for organizations
+     * @default false
+     */
+    apiKey?: boolean;
+    /**
+     * Base path for organization-scoped views (supports slugged or static base)
+     * When using slug paths, set this to the common prefix (e.g. "/organization")
+     */
+    basePath?: string;
+    /**
+     * Organization path mode
+     * - "default": use active-organization based routes
+     * - "slug": use slug-based URLs where slug becomes the first path segment
+     *   e.g. "/[slug]/members" (or `${basePath}/[slug]/members` if basePath provided)
+     * @default "default"
+     */
+    pathMode?: "default" | "slug";
+    /**
+     * The current organization slug
+     */
+    slug?: string;
+    /**
+     * The path to redirect to when Personal Account is selected
+     */
+    personalPath?: string;
+    /**
+     * Customize organization view paths
+     */
+    viewPaths?: Partial<OrganizationViewPaths>;
+};
+type OrganizationOptionsContext = {
+    /**
+     * Logo configuration
+     * @default undefined
+     */
+    logo?: OrganizationLogoOptions;
+    /**
+     * Custom roles to add to the built-in roles (owner, admin, member)
+     * @default []
+     */
+    customRoles: Array<{
+        role: string;
+        label: string;
+    }>;
+    /**
+     * Enable or disable API key support for organizations
+     * @default false
+     */
+    apiKey?: boolean;
+    /**
+     * Base path for organization-scoped views
+     */
+    basePath: string;
+    /**
+     * Organization path mode
+     * @default "default"
+     */
+    pathMode?: "default" | "slug";
+    /**
+     * The current organization slug
+     */
+    slug?: string;
+    /**
+     * The path to redirect to when Personal Account is selected
+     */
+    personalPath?: string;
+    /**
+     * Customize organization view paths
+     */
+    viewPaths: OrganizationViewPaths;
+};
+
+type ToastVariant = "default" | "success" | "error" | "info" | "warning";
+type RenderToast = ({ variant, message }: {
+    variant?: ToastVariant;
+    message?: string;
+}) => void;
+
+type SignUpOptions = {
+    /**
+     * Array of fields to show in Sign Up form
+     * @default ["name"]
+     */
+    fields?: string[];
+};
+
+type SocialOptions = {
+    /**
+     * Array of Social Providers to enable
+     * @remarks `SocialProvider[]`
+     */
+    providers: SocialProvider[];
+    /**
+     * Custom social sign in function
+     */
+    signIn?: (params: Parameters<AuthClient["signIn"]["social"]>[0]) => Promise<unknown>;
+};
+
+type AuthUIContextType = {
+    authClient: AuthClient;
+    /**
+     * Additional fields for users
+     */
+    additionalFields?: AdditionalFields;
+    /**
+     * API Key plugin configuration
+     */
+    apiKey?: {
+        /**
+         * Prefix for API Keys
+         */
+        prefix?: string;
+        /**
+         * Metadata for API Keys
+         */
+        metadata?: Record<string, unknown>;
+    } | boolean;
+    /**
+     * Avatar configuration
+     * @default undefined
+     */
+    avatar?: AvatarOptions;
+    /**
+     * Base path for the auth views
+     * @default "/auth"
+     */
+    basePath: string;
+    /**
+     * Front end base URL for auth API callbacks
+     */
+    baseURL?: string;
+    /**
+     * Captcha configuration
+     */
+    captcha?: CaptchaOptions;
+    credentials?: CredentialsOptions;
+    /**
+     * Default redirect URL after authenticating
+     * @default "/"
+     */
+    redirectTo: string;
+    /**
+     * Enable or disable user change email support
+     * @default true
+     */
+    changeEmail?: boolean;
+    /**
+     * User Account deletion configuration
+     * @default undefined
+     */
+    deleteUser?: DeleteUserOptions;
+    /**
+     * Show Verify Email card for unverified emails
+     */
+    emailVerification?: boolean;
+    /**
+     * Freshness age for Session data
+     * @default 60 * 60 * 24
+     */
+    freshAge: number;
+    /**
+     * Generic OAuth provider configuration
+     */
+    genericOAuth?: GenericOAuthOptions;
+    /**
+     * Gravatar configuration
+     */
+    gravatar?: boolean | GravatarOptions;
+    hooks: AuthHooks;
+    localization: typeof authLocalization;
+    /**
+     * Enable or disable Magic Link support
+     * @default false
+     */
+    magicLink?: boolean;
+    /**
+     * Enable or disable Email OTP support
+     * @default false
+     */
+    emailOTP?: boolean;
+    /**
+     * Enable or disable Multi Session support
+     * @default false
+     */
+    multiSession?: boolean;
+    mutators: AuthMutators;
+    /**
+     * Whether the name field should be required
+     * @default true
+     */
+    nameRequired?: boolean;
+    /**
+     * Enable or disable One Tap support
+     * @default false
+     */
+    oneTap?: boolean;
+    /**
+     * Perform some User updates optimistically
+     * @default false
+     */
+    optimistic?: boolean;
+    /**
+     * Organization configuration
+     */
+    organization?: OrganizationOptionsContext;
+    /**
+     * Enable or disable Passkey support
+     * @default false
+     */
+    passkey?: boolean;
+    /**
+     * Forces better-auth-tanstack to refresh the Session on the auth callback page
+     * @default false
+     */
+    persistClient?: boolean;
+    /**
+     * Account configuration
+     */
+    account?: AccountOptionsContext;
+    /**
+     * Sign Up configuration
+     */
+    signUp?: SignUpOptions;
+    /**
+     * Social provider configuration
+     */
+    social?: SocialOptions;
+    toast: RenderToast;
+    /**
+     * Enable or disable two-factor authentication support
+     * @default undefined
+     */
+    twoFactor?: ("otp" | "totp")[];
+    viewPaths: AuthViewPaths;
+    /**
+     * Navigate to a new URL
+     * @default window.location.href
+     */
+    navigate: (href: string) => void;
+    /**
+     * Called whenever the Session changes
+     */
+    onSessionChange?: () => void | Promise<void>;
+    /**
+     * Replace the current URL
+     * @default navigate
+     */
+    replace: (href: string) => void;
+    /**
+     * Custom Link component for navigation
+     * @default <a>
+     */
+    Link: Link;
+};
+type AuthUIProviderProps = {
+    children: ReactNode;
+    /**
+     * Better Auth client returned from createAuthClient
+     * @default Required
+     * @remarks `AuthClient`
+     */
+    authClient: AnyAuthClient;
+    /**
+     * Enable account view & account configuration
+     * @default { fields: ["image", "name"] }
+     */
+    account?: boolean | Partial<AccountOptions>;
+    /**
+     * Avatar configuration
+     * @default undefined
+     */
+    avatar?: boolean | Partial<AvatarOptions>;
+    /**
+     * User Account deletion configuration
+     * @default undefined
+     */
+    deleteUser?: DeleteUserOptions | boolean;
+    /**
+     * ADVANCED: Custom hooks for fetching auth data
+     */
+    hooks?: Partial<AuthHooks>;
+    /**
+     * Customize the paths for the auth views
+     * @default authViewPaths
+     * @remarks `AuthViewPaths`
+     */
+    viewPaths?: Partial<AuthViewPaths>;
+    /**
+     * Render custom Toasts
+     * @default Sonner
+     */
+    toast?: RenderToast;
+    /**
+     * Customize the Localization strings
+     * @default authLocalization
+     * @remarks `AuthLocalization`
+     */
+    localization?: AuthLocalization;
+    /**
+     * ADVANCED: Custom mutators for updating auth data
+     */
+    mutators?: Partial<AuthMutators>;
+    /**
+     * Organization plugin configuration
+     */
+    organization?: OrganizationOptions | boolean;
+    /**
+     * Enable or disable Credentials support
+     * @default { forgotPassword: true }
+     */
+    credentials?: boolean | CredentialsOptions;
+    /**
+     * Enable or disable Sign Up form
+     * @default { fields: ["name"] }
+     */
+    signUp?: SignUpOptions | boolean;
+} & Partial<Omit<AuthUIContextType, "authClient" | "viewPaths" | "localization" | "mutators" | "toast" | "hooks" | "avatar" | "account" | "deleteUser" | "credentials" | "signUp" | "organization">>;
+declare const AuthUIContext: React.Context<AuthUIContextType>;
+declare const AuthUIProvider: ({ children, authClient: authClientProp, account: accountProp, avatar: avatarProp, deleteUser: deleteUserProp, social: socialProp, genericOAuth: genericOAuthProp, basePath, baseURL, captcha, redirectTo, credentials: credentialsProp, changeEmail, freshAge, hooks: hooksProp, mutators: mutatorsProp, localization: localizationProp, nameRequired, organization: organizationProp, signUp: signUpProp, toast, viewPaths: viewPathsProp, navigate, replace, Link, ...props }: AuthUIProviderProps) => react_jsx_runtime.JSX.Element;
+
+export { AppleIcon as A, DiscordIcon as D, type FieldType as F, GitHubIcon as G, HuggingFaceIcon as H, KickIcon as K, LinearIcon as L, MicrosoftIcon as M, NotionIcon as N, type PasswordValidation as P, RedditIcon as R, SlackIcon as S, TikTokIcon as T, VKIcon as V, XIcon as X, ZoomIcon as Z, type ProviderIconProps as a, type ProviderIcon as b, DropboxIcon as c, FacebookIcon as d, GitLabIcon as e, GoogleIcon as f, LinkedInIcon as g, RobloxIcon as h, SpotifyIcon as i, TwitchIcon as j, type AuthUIContextType as k, type AuthUIProviderProps as l, AuthUIContext as m, AuthUIProvider as n, type Provider as o, socialProviders as s };