@better-auth-ui/core 1.6.0

package/dist/localization.d.ts

@@ -0,0 +1,159 @@
+export declare const localization: {
+    auth: {
+        /** @remarks `"Account"` */
+        account: string;
+        /** @remarks `"Add Account"` */
+        addAccount: string;
+        /** @remarks `"Already have an account?"` */
+        alreadyHaveAnAccount: string;
+        /** @remarks `"Confirm Password"` */
+        confirmPassword: string;
+        /** @remarks `"Confirm your password"` */
+        confirmPasswordPlaceholder: string;
+        /** @remarks `"Continue with {{provider}}"` */
+        continueWith: string;
+        /** @remarks `"Email"` */
+        email: string;
+        /** @remarks `"Enter your email"` */
+        emailPlaceholder: string;
+        /** @remarks `"Forgot Password"` */
+        forgotPassword: string;
+        /** @remarks `"Forgot password?"` */
+        forgotPasswordLink: string;
+        /** @remarks `"Hide password"` */
+        hidePassword: string;
+        /** @remarks `"Invalid reset password token"` */
+        invalidResetPasswordToken: string;
+        /** @remarks `"Magic Link"` */
+        magicLink: string;
+        /** @remarks `"Magic link sent to your email"` */
+        magicLinkSent: string;
+        /** @remarks `"Name"` */
+        name: string;
+        /** @remarks `"Enter your name"` */
+        namePlaceholder: string;
+        /** @remarks `"Need to create an account?"` */
+        needToCreateAnAccount: string;
+        /** @remarks `"New Password"` */
+        newPassword: string;
+        /** @remarks `"Enter your new password"` */
+        newPasswordPlaceholder: string;
+        /** @remarks `"OR"` */
+        or: string;
+        /** @remarks `"Password"` */
+        password: string;
+        /** @remarks `"Enter your password"` */
+        passwordPlaceholder: string;
+        /** @remarks `"Password reset email sent"` */
+        passwordResetEmailSent: string;
+        /** @remarks `"Password reset successfully"` */
+        passwordResetSuccess: string;
+        /** @remarks `"Passwords do not match"` */
+        passwordsDoNotMatch: string;
+        /** @remarks `"Remember me"` */
+        rememberMe: string;
+        /** @remarks `"Remember your password?"` */
+        rememberYourPassword: string;
+        /** @remarks `"Resend"` */
+        resend: string;
+        /** @remarks `"Reset Password"` */
+        resetPassword: string;
+        /** @remarks `"Send Magic Link"` */
+        sendMagicLink: string;
+        /** @remarks `"Send Reset Link"` */
+        sendResetLink: string;
+        /** @remarks `"Show password"` */
+        showPassword: string;
+        /** @remarks `"Sign In"` */
+        signIn: string;
+        /** @remarks `"Sign Out"` */
+        signOut: string;
+        /** @remarks `"Sign Up"` */
+        signUp: string;
+        /** @remarks `"Switch Account"` */
+        switchAccount: string;
+        /** @remarks `"Verification email sent!"` */
+        verificationEmailSent: string;
+        /** @remarks `"Verify your email"` */
+        verifyYourEmail: string;
+    };
+    settings: {
+        /** @remarks `"Account"` */
+        account: string;
+        /** @remarks `"Account unlinked"` */
+        accountUnlinked: string;
+        /** @remarks `"Active"` */
+        active: string;
+        /** @remarks `"Active sessions"` */
+        activeSessions: string;
+        /** @remarks `"Avatar"` */
+        avatar: string;
+        /** @remarks `"Current Session"` */
+        currentSession: string;
+        /** @remarks `"Avatar changed successfully"` */
+        avatarChangedSuccess: string;
+        /** @remarks `"Avatar deleted successfully"` */
+        avatarDeletedSuccess: string;
+        /** @remarks `"Change avatar"` */
+        changeAvatar: string;
+        /** @remarks `"Delete avatar"` */
+        deleteAvatar: string;
+        /** @remarks `"Link"` */
+        link: string;
+        /** @remarks `"Linked accounts"` */
+        linkedAccounts: string;
+        /** @remarks `"Link your {{provider}} account"` */
+        linkProvider: string;
+        /** @remarks `"Appearance"` */
+        appearance: string;
+        /** @remarks `"Change email"` */
+        changeEmail: string;
+        /** @remarks `"Check your email to confirm the change"` */
+        changeEmailSuccess: string;
+        /** @remarks `"Change password"` */
+        changePassword: string;
+        /** @remarks `"Password changed successfully"` */
+        changePasswordSuccess: string;
+        /** @remarks `"Current Password"` */
+        currentPassword: string;
+        /** @remarks `"Enter your current password"` */
+        currentPasswordPlaceholder: string;
+        /** @remarks `"Dark"` */
+        dark: string;
+        /** @remarks `"Light"` */
+        light: string;
+        /** @remarks `"Manage accounts"` */
+        manageAccounts: string;
+        /** @remarks `"Profile"` */
+        profile: string;
+        /** @remarks `"Profile updated successfully"` */
+        profileUpdatedSuccess: string;
+        /** @remarks `"Revoke"` */
+        revoke: string;
+        /** @remarks `"Revoke Session"` */
+        revokeSession: string;
+        /** @remarks `"Session revoked successfully"` */
+        revokeSessionSuccess: string;
+        /** @remarks `"Save changes"` */
+        saveChanges: string;
+        /** @remarks `"Security"` */
+        security: string;
+        /** @remarks `"Settings"` */
+        settings: string;
+        /** @remarks `"System"` */
+        system: string;
+        /** @remarks `"Theme"` */
+        theme: string;
+        /** @remarks `"Unlink {{provider}}"` */
+        unlinkProvider: string;
+        /** @remarks `"Update email"` */
+        updateEmail: string;
+        /** @remarks `"Update password"` */
+        updatePassword: string;
+        /** @remarks `"Upload avatar"` */
+        uploadAvatar: string;
+    };
+};
+export type Localization = typeof localization;
+export type AuthLocalization = Localization["auth"];
+export type SettingsLocalization = Localization["settings"];

package/dist/localization.js

@@ -0,0 +1,156 @@
+export const localization = {
+    auth: {
+        /** @remarks `"Account"` */
+        account: "Account",
+        /** @remarks `"Add Account"` */
+        addAccount: "Add Account",
+        /** @remarks `"Already have an account?"` */
+        alreadyHaveAnAccount: "Already have an account?",
+        /** @remarks `"Confirm Password"` */
+        confirmPassword: "Confirm Password",
+        /** @remarks `"Confirm your password"` */
+        confirmPasswordPlaceholder: "Confirm your password",
+        /** @remarks `"Continue with {{provider}}"` */
+        continueWith: "Continue with {{provider}}",
+        /** @remarks `"Email"` */
+        email: "Email",
+        /** @remarks `"Enter your email"` */
+        emailPlaceholder: "Enter your email",
+        /** @remarks `"Forgot Password"` */
+        forgotPassword: "Forgot Password",
+        /** @remarks `"Forgot password?"` */
+        forgotPasswordLink: "Forgot password?",
+        /** @remarks `"Hide password"` */
+        hidePassword: "Hide password",
+        /** @remarks `"Invalid reset password token"` */
+        invalidResetPasswordToken: "Invalid reset password token",
+        /** @remarks `"Magic Link"` */
+        magicLink: "Magic Link",
+        /** @remarks `"Magic link sent to your email"` */
+        magicLinkSent: "Magic link sent to your email",
+        /** @remarks `"Name"` */
+        name: "Name",
+        /** @remarks `"Enter your name"` */
+        namePlaceholder: "Enter your name",
+        /** @remarks `"Need to create an account?"` */
+        needToCreateAnAccount: "Need to create an account?",
+        /** @remarks `"New Password"` */
+        newPassword: "New Password",
+        /** @remarks `"Enter your new password"` */
+        newPasswordPlaceholder: "Enter your new password",
+        /** @remarks `"OR"` */
+        or: "OR",
+        /** @remarks `"Password"` */
+        password: "Password",
+        /** @remarks `"Enter your password"` */
+        passwordPlaceholder: "Enter your password",
+        /** @remarks `"Password reset email sent"` */
+        passwordResetEmailSent: "Password reset email sent",
+        /** @remarks `"Password reset successfully"` */
+        passwordResetSuccess: "Password reset successfully",
+        /** @remarks `"Passwords do not match"` */
+        passwordsDoNotMatch: "Passwords do not match",
+        /** @remarks `"Remember me"` */
+        rememberMe: "Remember me",
+        /** @remarks `"Remember your password?"` */
+        rememberYourPassword: "Remember your password?",
+        /** @remarks `"Resend"` */
+        resend: "Resend",
+        /** @remarks `"Reset Password"` */
+        resetPassword: "Reset Password",
+        /** @remarks `"Send Magic Link"` */
+        sendMagicLink: "Send Magic Link",
+        /** @remarks `"Send Reset Link"` */
+        sendResetLink: "Send Reset Link",
+        /** @remarks `"Show password"` */
+        showPassword: "Show password",
+        /** @remarks `"Sign In"` */
+        signIn: "Sign In",
+        /** @remarks `"Sign Out"` */
+        signOut: "Sign Out",
+        /** @remarks `"Sign Up"` */
+        signUp: "Sign Up",
+        /** @remarks `"Switch Account"` */
+        switchAccount: "Switch Account",
+        /** @remarks `"Verification email sent!"` */
+        verificationEmailSent: "Verification email sent!",
+        /** @remarks `"Verify your email"` */
+        verifyYourEmail: "Verify your email"
+    },
+    settings: {
+        /** @remarks `"Account"` */
+        account: "Account",
+        /** @remarks `"Account unlinked"` */
+        accountUnlinked: "Account unlinked",
+        /** @remarks `"Active"` */
+        active: "Active",
+        /** @remarks `"Active sessions"` */
+        activeSessions: "Active sessions",
+        /** @remarks `"Avatar"` */
+        avatar: "Avatar",
+        /** @remarks `"Current Session"` */
+        currentSession: "Current Session",
+        /** @remarks `"Avatar changed successfully"` */
+        avatarChangedSuccess: "Avatar changed successfully",
+        /** @remarks `"Avatar deleted successfully"` */
+        avatarDeletedSuccess: "Avatar deleted successfully",
+        /** @remarks `"Change avatar"` */
+        changeAvatar: "Change avatar",
+        /** @remarks `"Delete avatar"` */
+        deleteAvatar: "Delete avatar",
+        /** @remarks `"Link"` */
+        link: "Link",
+        /** @remarks `"Linked accounts"` */
+        linkedAccounts: "Linked accounts",
+        /** @remarks `"Link your {{provider}} account"` */
+        linkProvider: "Link your {{provider}} account",
+        /** @remarks `"Appearance"` */
+        appearance: "Appearance",
+        /** @remarks `"Change email"` */
+        changeEmail: "Change email",
+        /** @remarks `"Check your email to confirm the change"` */
+        changeEmailSuccess: "Check your email to confirm the change",
+        /** @remarks `"Change password"` */
+        changePassword: "Change password",
+        /** @remarks `"Password changed successfully"` */
+        changePasswordSuccess: "Password changed successfully",
+        /** @remarks `"Current Password"` */
+        currentPassword: "Current Password",
+        /** @remarks `"Enter your current password"` */
+        currentPasswordPlaceholder: "Enter your current password",
+        /** @remarks `"Dark"` */
+        dark: "Dark",
+        /** @remarks `"Light"` */
+        light: "Light",
+        /** @remarks `"Manage accounts"` */
+        manageAccounts: "Manage accounts",
+        /** @remarks `"Profile"` */
+        profile: "Profile",
+        /** @remarks `"Profile updated successfully"` */
+        profileUpdatedSuccess: "Profile updated successfully",
+        /** @remarks `"Revoke"` */
+        revoke: "Revoke",
+        /** @remarks `"Revoke Session"` */
+        revokeSession: "Revoke Session",
+        /** @remarks `"Session revoked successfully"` */
+        revokeSessionSuccess: "Session revoked successfully",
+        /** @remarks `"Save changes"` */
+        saveChanges: "Save changes",
+        /** @remarks `"Security"` */
+        security: "Security",
+        /** @remarks `"Settings"` */
+        settings: "Settings",
+        /** @remarks `"System"` */
+        system: "System",
+        /** @remarks `"Theme"` */
+        theme: "Theme",
+        /** @remarks `"Unlink {{provider}}"` */
+        unlinkProvider: "Unlink {{provider}}",
+        /** @remarks `"Update email"` */
+        updateEmail: "Update email",
+        /** @remarks `"Update password"` */
+        updatePassword: "Update password",
+        /** @remarks `"Upload avatar"` */
+        uploadAvatar: "Upload avatar"
+    }
+};

package/dist/provider-names.d.ts

@@ -0,0 +1,12 @@
+import type { SocialProvider } from "better-auth/social-providers";
+/**
+ * Mapping of social authentication provider identifiers to their human-readable display names.
+ */
+export declare const providerNames: Record<SocialProvider, string>;
+/**
+ * Get the human-readable display name for an authentication provider.
+ *
+ * @param provider - The provider identifier (e.g., "github", "google").
+ * @returns The mapped display name for `provider` if available, otherwise `provider` with its first character capitalized.
+ */
+export declare function getProviderName(provider: string): string;

package/dist/provider-names.js

@@ -0,0 +1,50 @@
+/**
+ * Mapping of social authentication provider identifiers to their human-readable display names.
+ */
+export const providerNames = {
+    apple: "Apple",
+    atlassian: "Atlassian",
+    cognito: "Cognito",
+    discord: "Discord",
+    dropbox: "Dropbox",
+    facebook: "Facebook",
+    figma: "Figma",
+    github: "GitHub",
+    gitlab: "GitLab",
+    google: "Google",
+    huggingface: "Hugging Face",
+    kakao: "Kakao",
+    kick: "Kick",
+    line: "LINE",
+    linear: "Linear",
+    linkedin: "LinkedIn",
+    microsoft: "Microsoft",
+    naver: "Naver",
+    notion: "Notion",
+    paybin: "Paybin",
+    paypal: "PayPal",
+    polar: "Polar",
+    railway: "Railway",
+    reddit: "Reddit",
+    roblox: "Roblox",
+    salesforce: "Salesforce",
+    slack: "Slack",
+    spotify: "Spotify",
+    tiktok: "TikTok",
+    twitch: "Twitch",
+    twitter: "X",
+    vercel: "Vercel",
+    vk: "VK",
+    wechat: "WeChat",
+    zoom: "Zoom"
+};
+/**
+ * Get the human-readable display name for an authentication provider.
+ *
+ * @param provider - The provider identifier (e.g., "github", "google").
+ * @returns The mapped display name for `provider` if available, otherwise `provider` with its first character capitalized.
+ */
+export function getProviderName(provider) {
+    return (providerNames[provider] ||
+        provider.charAt(0).toUpperCase() + provider.slice(1));
+}

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./lib/auth-config";
+export * from "./lib/auth-toast";
+export * from "./lib/base-paths";
+export * from "./lib/localization";
+export * from "./lib/provider-names";
+export * from "./lib/utils";
+export * from "./lib/view-paths";

package/dist/src/index.js

@@ -0,0 +1,7 @@
+export * from "./lib/auth-config";
+export * from "./lib/auth-toast";
+export * from "./lib/base-paths";
+export * from "./lib/localization";
+export * from "./lib/provider-names";
+export * from "./lib/utils";
+export * from "./lib/view-paths";

package/dist/src/lib/auth-config.d.ts

@@ -0,0 +1,148 @@
+import type { SocialProvider } from "better-auth/social-providers";
+import { type Toast } from "./auth-toast";
+import { type Localization } from "./localization";
+import { type ViewPaths } from "./view-paths";
+/**
+ * Configuration options for email and password authentication.
+ */
+export type EmailAndPasswordConfig = {
+    /**
+     * Whether email/password authentication is enabled
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Whether to show a confirm password field on sign-up forms
+     */
+    confirmPassword?: boolean;
+    /**
+     * Whether users can reset forgotten passwords
+     * @default true
+     */
+    forgotPassword: boolean;
+    /**
+     * Maximum password length
+     * @default 128
+     */
+    maxPasswordLength?: number;
+    /**
+     * Minimum password length
+     * @default 8
+     */
+    minPasswordLength?: number;
+    /**
+     * Maximum password length
+     * @default 128
+     */
+    /** Whether to show a "Remember me" checkbox on sign-in forms */
+    rememberMe?: boolean;
+    /** Whether email verification is required before account activation */
+    requireEmailVerification?: boolean;
+};
+/**
+ * Available theme options for the application.
+ */
+export type Theme = "system" | "light" | "dark";
+/**
+ * Configuration options for user settings.
+ */
+export type SettingsConfig = {
+    /**
+     * Whether the settings section is enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Function to set the application theme
+     * @param theme - The theme value to set
+     */
+    setTheme?: (theme: string) => void;
+    /**
+     * Current theme value
+     */
+    theme?: string;
+    /**
+     * Available theme options to display in the theme switcher
+     * @default ["system", "light", "dark"]
+     */
+    themes?: Theme[];
+};
+/**
+ * Core authentication configuration interface.
+ *
+ * Defines the base structure for authentication settings including paths,
+ * providers, navigation functions, and feature flags.
+ */
+export interface AuthConfig {
+    /** Base paths for different application sections */
+    basePaths: {
+        /**
+         * Base path for authentication routes
+         * @default "/auth"
+         */
+        auth: string;
+        /**
+         * Base path for settings routes
+         * @default "/settings"
+         */
+        settings: string;
+        /**
+         * Base path for organization management routes
+         * @default "/organization"
+         */
+        organization: string;
+    };
+    /**
+     * Base URL for API endpoints (optional)
+     * @default ""
+     */
+    baseURL: string;
+    /**
+     * Email and password authentication configuration
+     * @default { enabled: true, forgotPassword: true, minPasswordLength: 8, maxPasswordLength: 128 }
+     */
+    emailAndPassword?: EmailAndPasswordConfig;
+    /** Localization strings for UI components. */
+    localization: Localization;
+    /** Whether magic link (passwordless) authentication is enabled */
+    magicLink?: boolean;
+    /** Whether multi-session support is enabled */
+    multiSession?: boolean;
+    /**
+     * Default redirect path after successful authentication
+     * @default "/"
+     */
+    redirectTo: string;
+    /**
+     * Settings section configuration
+     * @default { enabled: true }
+     */
+    settings: SettingsConfig;
+    /**
+     * List of enabled social authentication providers
+     * @remarks `SocialProvider[]`
+     */
+    socialProviders?: SocialProvider[];
+    /** View path mappings for different authentication views */
+    viewPaths: ViewPaths;
+    /**
+     * Toast notification configuration for user feedback.
+     * @remarks `Toast`
+     */
+    toast: Toast;
+    /**
+     * Function to navigate to a new path
+     * @param options - Navigation options with href and optional replace flag
+     * @default window.location.href = href (or window.location.replace if replace: true)
+     * @example
+     * // TanStack Router
+     * navigate={navigate}
+     * // Next.js
+     * navigate={({href, replace}) => replace ? router.replace(href) : router.push(href)}
+     */
+    navigate: (options: {
+        to: string;
+        replace?: boolean;
+    }) => void;
+}
+export declare const defaultConfig: AuthConfig;

package/dist/src/lib/auth-config.js

@@ -0,0 +1,28 @@
+import { defaultToast } from "./auth-toast";
+import { basePaths } from "./base-paths";
+import { localization } from "./localization";
+import { viewPaths } from "./view-paths";
+export const defaultConfig = {
+    basePaths,
+    baseURL: "",
+    emailAndPassword: {
+        enabled: true,
+        forgotPassword: true,
+        rememberMe: false,
+        minPasswordLength: 8,
+        maxPasswordLength: 128
+    },
+    redirectTo: "/",
+    settings: {
+        enabled: true,
+        themes: ["system", "light", "dark"]
+    },
+    viewPaths,
+    localization,
+    navigate: () => { },
+    toast: {
+        error: defaultToast,
+        success: defaultToast,
+        info: defaultToast
+    }
+};

package/dist/src/lib/auth-toast.d.ts

@@ -0,0 +1,24 @@
+export type RenderToast = (message?: string, options?: {
+    action?: {
+        label: string;
+        onClick: () => Promise<void> | void;
+    };
+    actionProps?: {
+        children: string;
+        onClick: () => Promise<void> | void;
+    };
+}) => string | number | unknown;
+export type DismissToast = (id?: number | string | unknown | any) => string | number | unknown;
+export declare const defaultToast: RenderToast;
+export type Toast = {
+    /** Display an error toast notification */
+    error: RenderToast;
+    /** Display a danger toast notification */
+    danger?: RenderToast;
+    /** Display a success toast notification */
+    success: RenderToast;
+    /** Display an info toast notification */
+    info: RenderToast;
+    /** Optional function to dismiss a toast notification by its ID */
+    dismiss?: DismissToast;
+};

package/dist/src/lib/auth-toast.js

@@ -0,0 +1,10 @@
+export const defaultToast = (message, options) => {
+    if (options?.action) {
+        if (confirm(message)) {
+            options.action.onClick();
+        }
+    }
+    else {
+        alert(message);
+    }
+};

package/dist/src/lib/base-paths.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Defines the base paths for authentication, settings, and organization
+ * features. These paths are used throughout the application for routing and navigation.
+ */
+export declare const basePaths: {
+    auth: string;
+    settings: string;
+    organization: string;
+};

package/dist/src/lib/base-paths.js

@@ -0,0 +1,9 @@
+/**
+ * Defines the base paths for authentication, settings, and organization
+ * features. These paths are used throughout the application for routing and navigation.
+ */
+export const basePaths = {
+    auth: "/auth",
+    settings: "/settings",
+    organization: "/organization"
+};