@better-auth-ui/core 1.6.0

package/dist/base-paths.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Base path configuration for authentication, settings, and organization routes.
+ */
+export type 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;
+};
+export declare const basePaths: BasePaths;

package/dist/base-paths.js

@@ -0,0 +1,5 @@
+export const basePaths = {
+    auth: "/auth",
+    settings: "/settings",
+    organization: "/organization"
+};

package/dist/config/appearance-config.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Available theme options for the application.
+ */
+export type Theme = "system" | "light" | "dark";
+/**
+ * Configuration options for appearance/theme settings.
+ */
+export type AppearanceConfig = {
+    /**
+     * 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[];
+};

package/dist/config/appearance-config.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,87 @@
+import type { SocialProvider } from "better-auth/social-providers";
+import { type BasePaths } from "../lib/base-paths";
+import { type Localization } from "../lib/localization";
+import { type ViewPaths } from "../lib/view-paths";
+import type { AppearanceConfig } from "./appearance-config";
+import type { AvatarConfig } from "./avatar-config";
+import type { DeleteUserConfig } from "./delete-user-config";
+import type { EmailAndPasswordConfig } from "./email-and-password-config";
+/**
+ * Core authentication configuration interface.
+ *
+ * Defines the base structure for authentication settings including paths,
+ * providers, navigation functions, and feature flags.
+ */
+export interface AuthConfig {
+    /**
+     * Appearance/theme configuration
+     * @remarks `AppearanceConfig`
+     * @default { themes: ["system", "light", "dark"] }
+     */
+    appearance: AppearanceConfig;
+    /**
+     * Avatar upload, optimization, and deletion configuration.
+     * @remarks `AvatarConfig`
+     * @default { enabled: true, resize: resizeAvatar, size: 256, extension: "png" }
+     */
+    avatar: AvatarConfig;
+    /**
+     * Base paths for different application sections
+     * @remarks `BasePaths`
+     */
+    basePaths: BasePaths;
+    /**
+     * Base URL for API endpoints (optional)
+     * @default ""
+     */
+    baseURL: string;
+    /**
+     * Allow users to delete their account
+     * @remarks `DeleteUserConfig`
+     */
+    deleteUser?: DeleteUserConfig;
+    /**
+     * Email and password authentication configuration
+     * @remarks `EmailAndPasswordConfig`
+     */
+    emailAndPassword: EmailAndPasswordConfig;
+    /**
+     * Localization strings for UI components
+     * @remarks `Localization`
+     */
+    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;
+    /**
+     * List of enabled social authentication providers
+     * @remarks `SocialProvider[]`
+     */
+    socialProviders?: SocialProvider[];
+    /**
+     * View path mappings for different authentication views
+     * @remarks `ViewPaths`
+     */
+    viewPaths: ViewPaths;
+    /**
+     * 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 defaultAuthConfig: AuthConfig;

package/dist/config/auth-config.js

@@ -0,0 +1,35 @@
+import { basePaths } from "../lib/base-paths";
+import { localization } from "../lib/localization";
+import { resizeAvatar } from "../lib/utils";
+import { viewPaths } from "../lib/view-paths";
+export const defaultAuthConfig = {
+    appearance: {
+        themes: ["system", "light", "dark"]
+    },
+    avatar: {
+        enabled: true,
+        resize: resizeAvatar,
+        size: 256,
+        extension: "png"
+    },
+    basePaths,
+    baseURL: "",
+    emailAndPassword: {
+        enabled: true,
+        forgotPassword: true,
+        rememberMe: false,
+        minPasswordLength: 8,
+        maxPasswordLength: 128
+    },
+    redirectTo: "/",
+    viewPaths,
+    localization,
+    navigate: ({ to, replace }) => {
+        if (replace) {
+            window.location.replace(to);
+        }
+        else {
+            window.location.href = to;
+        }
+    }
+};

package/dist/config/avatar-config.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Configuration options for avatar handling.
+ */
+export type AvatarConfig = {
+    /**
+     * Delete the current avatar (e.g. remove from storage).
+     * Gets called after the user's avatar is updated to null.
+     */
+    delete?: (url: string) => Promise<void>;
+    /**
+     * Whether avatar changing is enabled.
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Output image format.
+     * @default "png"
+     */
+    extension: "png" | "jpg" | "webp" | "inherit";
+    /**
+     * Resize an image file before upload. Overrides the default resize behavior.
+     * @default Resizes to `size` pixels, square-cropped, output as `extension`.
+     */
+    resize: (file: File, size?: number, extension?: "png" | "jpg" | "webp" | "inherit") => Promise<File>;
+    /**
+     * Max dimension in pixels for the optimized avatar.
+     * @default 256
+     */
+    size: number;
+    /**
+     * Upload a file and return the URL where it was stored.
+     * When undefined, the image is base64-encoded and saved directly to `user.image`.
+     */
+    upload?: (file: File) => Promise<string>;
+};

package/dist/config/avatar-config.js

@@ -0,0 +1 @@
+export {};

package/dist/config/delete-user-config.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Configuration for account deletion in the UI (mirrors server `user.deleteUser` flags).
+ */
+export interface DeleteUserConfig {
+    /**
+     * Whether the delete user feature is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * When `true`, matches server `sendDeleteAccountVerification`: deletion starts by sending a
+     * verification email instead of deleting immediately in this request.
+     */
+    sendDeleteAccountVerification?: boolean;
+}

package/dist/config/delete-user-config.js

@@ -0,0 +1 @@
+export {};

package/dist/config/email-and-password-config.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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;
+};

package/dist/config/email-and-password-config.js

@@ -0,0 +1 @@
+export {};

package/dist/config/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./appearance-config";
+export * from "./auth-config";
+export * from "./avatar-config";
+export * from "./delete-user-config";
+export * from "./email-and-password-config";

package/dist/config/index.js

@@ -0,0 +1,5 @@
+export * from "./appearance-config";
+export * from "./auth-config";
+export * from "./avatar-config";
+export * from "./delete-user-config";
+export * from "./email-and-password-config";

package/dist/config/settings-config.d.ts

@@ -0,0 +1,17 @@
+import type { AppearanceConfig } from "./appearance-config";
+import type { AvatarConfig } from "./avatar-config";
+/**
+ * Configuration options for user settings.
+ */
+export type SettingsConfig = {
+    /**
+     * Appearance/theme configuration
+     * @default { themes: ["system", "light", "dark"] }
+     */
+    appearance: AppearanceConfig;
+    /**
+     * Avatar upload, optimization, and deletion configuration.
+     * @default { enabled: true, optimize: optimizeAvatar, size: 256 }
+     */
+    avatar: AvatarConfig;
+};

package/dist/config/settings-config.js

@@ -0,0 +1 @@
+export {};

package/dist/config/toast-config.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Function signature for rendering a toast notification.
+ *
+ * @param message - The message to display in the toast.
+ * @param options - Optional configuration for the toast.
+ * @param options.action - Action button displayed within the toast.
+ * @param options.action.label - Label text for the action button.
+ * @param options.action.onClick - Callback invoked when the action button is clicked.
+ * @param options.actionProps - Alternative action props (used by some toast libraries).
+ * @param options.actionProps.children - Label text for the action button.
+ * @param options.actionProps.onClick - Callback invoked when the action button is clicked.
+ * @returns A toast identifier (type varies by toast library), or void.
+ */
+export type RenderToast = (message?: string, options?: {
+    action?: {
+        label: string;
+        onClick: () => Promise<void> | void;
+    };
+    actionProps?: {
+        children: string;
+        onClick: () => Promise<void> | void;
+    };
+}) => string | number | unknown;
+/**
+ * Function signature for dismissing a toast notification by its ID.
+ *
+ * @param id - The identifier of the toast to dismiss (returned by {@link RenderToast}).
+ * @returns A toast identifier, or void.
+ */
+export type DismissToast = (id?: number | string | unknown | any) => string | number | unknown;
+/**
+ * Fallback toast implementation using native browser dialogs.
+ *
+ * Uses `confirm()` for toasts with an action (invokes the action on confirm)
+ * and `alert()` for plain messages.
+ */
+export declare const defaultToast: RenderToast;
+/**
+ * Configuration for toast notifications used throughout the UI.
+ *
+ * Provide your own toast library functions (e.g. sonner, react-hot-toast)
+ * to customize how notifications are displayed.
+ */
+export type ToastConfig = {
+    /** Display an error toast notification. */
+    error: RenderToast;
+    /** Display a danger toast notification (e.g. destructive actions). */
+    danger?: RenderToast;
+    /** Display a success toast notification. */
+    success: RenderToast;
+    /** Display an informational toast notification. */
+    info: RenderToast;
+    /**
+     * Dismiss a toast notification by its ID.
+     * When provided, allows programmatic dismissal of active toasts.
+     */
+    dismiss?: DismissToast;
+};

package/dist/config/toast-config.js

@@ -0,0 +1,16 @@
+/**
+ * Fallback toast implementation using native browser dialogs.
+ *
+ * Uses `confirm()` for toasts with an action (invokes the action on confirm)
+ * and `alert()` for plain messages.
+ */
+export const defaultToast = (message, options) => {
+    if (options?.action) {
+        if (confirm(message)) {
+            options.action.onClick();
+        }
+    }
+    else {
+        alert(message);
+    }
+};

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./config";
+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/index.js

@@ -0,0 +1,6 @@
+export * from "./config";
+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/lib/auth-callback-options.d.ts

@@ -0,0 +1,8 @@
+import type { AuthError } from "./auth-error";
+/**
+ * Common callback options for auth operations.
+ */
+export interface AuthCallbackOptions {
+    onError?: (error: AuthError) => unknown | Promise<unknown>;
+    onSuccess?: () => unknown | Promise<unknown>;
+}

package/dist/lib/auth-callback-options.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,198 @@
+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;
+};
+/**
+ * Configuration options for avatar handling.
+ */
+export type AvatarConfig = {
+    /**
+     * Delete the current avatar (e.g. remove from storage).
+     * When undefined, avatar deletion is disabled.
+     */
+    delete?: (url: string) => Promise<void>;
+    /**
+     * Whether avatar changing is enabled.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Output image format.
+     * @default "png"
+     */
+    extension?: "png" | "jpg" | "webp" | "inherit";
+    /**
+     * Resize an image file before upload.
+     * @default Resizes to max size, square-cropped, output as configured extension.
+     */
+    resize?: (file: File, size?: number, extension?: "png" | "jpg" | "webp" | "inherit") => Promise<File>;
+    /**
+     * Max dimension in pixels for the optimized avatar.
+     * @default 256
+     */
+    size?: number;
+    /**
+     * Upload a file and return the URL where it was stored.
+     * When undefined, the image is base64-encoded and saved directly to `user.image`.
+     */
+    upload?: (file: File) => Promise<string>;
+};
+/**
+ * Available theme options for the application.
+ */
+export type Theme = "system" | "light" | "dark";
+/**
+ * Configuration options for appearance/theme settings.
+ */
+export type AppearanceConfig = {
+    /**
+     * 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[];
+};
+/**
+ * Configuration options for user settings.
+ */
+export type SettingsConfig = {
+    /**
+     * Appearance/theme configuration
+     * @default { themes: ["system", "light", "dark"] }
+     */
+    appearance: AppearanceConfig;
+    /**
+     * Avatar upload, optimization, and deletion configuration.
+     * @default { enabled: true, optimize: optimizeAvatar, size: 256 }
+     */
+    avatar: AvatarConfig;
+    /**
+     * Whether the settings section is enabled
+     * @default true
+     */
+    enabled?: boolean;
+};
+/**
+ * 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/lib/auth-config.js

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

package/dist/lib/auth-error.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Error type returned by Better Auth client methods.
+ */
+export type AuthError = {
+    code?: string;
+    message?: string;
+    status: number;
+    statusText: string;
+};

package/dist/lib/auth-error.js

@@ -0,0 +1 @@
+export {};

package/dist/lib/auth-hook-options.d.ts

@@ -0,0 +1,8 @@
+import type { AuthError } from "./auth-error";
+/**
+ * Common options for auth hooks.
+ */
+export interface AuthHookOptions {
+    onError?: (error: AuthError) => unknown | Promise<unknown>;
+    onSuccess?: () => unknown | Promise<unknown>;
+}

package/dist/lib/auth-hook-options.js

@@ -0,0 +1 @@
+export {};