@tempots/beatui 0.82.1 → 0.83.0

package/dist/types/beatui-i18n/default.d.ts

@@ -1,3 +1,17 @@
+/**
+ * The default messages for BeatUI components, sourced from the English locale.
+ *
+ * This object serves as the fallback translation and as the type reference
+ * for all locale-specific message bundles.
+ *
+ * @example
+ * ```typescript
+ * import { defaultMessages } from '@tempots/beatui'
+ *
+ * console.log(defaultMessages.confirm) // 'Confirm'
+ * console.log(defaultMessages.cancel)  // 'Cancel'
+ * ```
+ */
 export declare const defaultMessages: {
     loadingExtended: string;
     loadingShort: string;
@@ -52,6 +66,69 @@ export declare const defaultMessages: {
     clearValue: string;
     unknownType: string;
     filesInputInstructions: (maxFiles: number | undefined, maxFileSize: number | undefined, fileSizeUnits: string[]) => string;
+    paginationLabel: string;
+    firstPage: string;
+    previousPage: string;
+    nextPage: string;
+    lastPage: string;
+    breadcrumbs: string;
+    commandPalette: string;
+    typeACommand: string;
+    noResultsFound: string;
+    noMatchingCommands: string;
+    appearanceSystem: string;
+    appearanceLight: string;
+    appearanceDark: string;
+    ok: string;
+    changeTypeConfirmation: string;
+    notifications: string;
+    markAllAsRead: string;
+    noNotifications: string;
+    schemaConflictsDetected: string;
+    schemaViolationsDetected: string;
+    properties: string;
+    uploading: string;
+    dropFilesOrBrowse: string;
+    acceptedTypes: (types: string) => string;
+    enterUrlPrompt: string;
+    exceeded: string;
+    pdfPreview: string;
+    lexical: {
+        fontFamily: string;
+        fontSize: string;
+        fontColor: string;
+        highlightColor: string;
+        backgroundColor: string;
+        bold: string;
+        italic: string;
+        underline: string;
+        strikethrough: string;
+        code: string;
+        clearFormatting: string;
+        normal: string;
+        heading: (level: number) => string;
+        bulletList: string;
+        orderedList: string;
+        checkList: string;
+        indent: string;
+        outdent: string;
+        blockquote: string;
+        codeBlock: string;
+        horizontalRule: string;
+        insertTable: string;
+        link: string;
+        undo: string;
+        redo: string;
+        cut: string;
+        copy: string;
+        paste: string;
+        defaultOption: string;
+        slashCommands: string;
+        noCommandsFound: string;
+        changeBlockType: string;
+        blockTypes: string;
+        enterUrl: string;
+    };
     prosemirror: {
         bold: string;
         italic: string;
@@ -74,5 +151,27 @@ export declare const defaultMessages: {
         renderFailed: string;
     };
 };
+/**
+ * The default locale code used by BeatUI when no locale is explicitly set.
+ *
+ * @default 'en'
+ */
 export declare const defaultLocale = "en";
+/**
+ * The type representing the complete set of BeatUI UI messages.
+ *
+ * Derived from the structure of the default (English) messages object.
+ * All locale translation files must conform to this type.
+ *
+ * @example
+ * ```typescript
+ * import type { BeatUIMessages } from '@tempots/beatui'
+ *
+ * const myMessages: BeatUIMessages = {
+ *   loadingExtended: 'Cargando, por favor espere',
+ *   loadingShort: 'Cargando...',
+ *   // ... all other required keys
+ * }
+ * ```
+ */
 export type BeatUIMessages = typeof defaultMessages;

package/dist/types/beatui-i18n/index.d.ts

@@ -1,2 +1,13 @@
+/**
+ * @fileoverview BeatUI I18n Module
+ *
+ * Provides the built-in internationalization system for BeatUI components.
+ *
+ * Exports:
+ * - {@link defaultMessages} - Default English messages for all BeatUI components
+ * - {@link defaultLocale} - The default locale code (`'en'`)
+ * - {@link BeatUIMessages} - Type representing the complete message shape
+ * - {@link BeatUII18n} - The i18n provider for BeatUI component translations
+ */
 export * from './default';
 export * from './translations';

package/dist/types/beatui-i18n/locales/en.d.ts

@@ -52,6 +52,69 @@ declare const en: {
     clearValue: string;
     unknownType: string;
     filesInputInstructions: (maxFiles: number | undefined, maxFileSize: number | undefined, fileSizeUnits: string[]) => string;
+    paginationLabel: string;
+    firstPage: string;
+    previousPage: string;
+    nextPage: string;
+    lastPage: string;
+    breadcrumbs: string;
+    commandPalette: string;
+    typeACommand: string;
+    noResultsFound: string;
+    noMatchingCommands: string;
+    appearanceSystem: string;
+    appearanceLight: string;
+    appearanceDark: string;
+    ok: string;
+    changeTypeConfirmation: string;
+    notifications: string;
+    markAllAsRead: string;
+    noNotifications: string;
+    schemaConflictsDetected: string;
+    schemaViolationsDetected: string;
+    properties: string;
+    uploading: string;
+    dropFilesOrBrowse: string;
+    acceptedTypes: (types: string) => string;
+    enterUrlPrompt: string;
+    exceeded: string;
+    pdfPreview: string;
+    lexical: {
+        fontFamily: string;
+        fontSize: string;
+        fontColor: string;
+        highlightColor: string;
+        backgroundColor: string;
+        bold: string;
+        italic: string;
+        underline: string;
+        strikethrough: string;
+        code: string;
+        clearFormatting: string;
+        normal: string;
+        heading: (level: number) => string;
+        bulletList: string;
+        orderedList: string;
+        checkList: string;
+        indent: string;
+        outdent: string;
+        blockquote: string;
+        codeBlock: string;
+        horizontalRule: string;
+        insertTable: string;
+        link: string;
+        undo: string;
+        redo: string;
+        cut: string;
+        copy: string;
+        paste: string;
+        defaultOption: string;
+        slashCommands: string;
+        noCommandsFound: string;
+        changeBlockType: string;
+        blockTypes: string;
+        enterUrl: string;
+    };
     prosemirror: {
         bold: string;
         italic: string;

package/dist/types/beatui-i18n/translations.d.ts

@@ -1,3 +1,27 @@
+/**
+ * The BeatUI internationalization provider.
+ *
+ * This provider manages the loading and reactive delivery of BeatUI component
+ * translations. It lazily loads locale files from the `./locales/` directory
+ * and falls back to the default English messages when a locale file is unavailable.
+ *
+ * Supported locales: `en`, `es`, `fr`, `de`, `it`, `pt`, `ja`, `zh`, `ko`, `ru`,
+ * `ar`, `nl`, `pl`, `tr`, `vi`, `hi`, `fa`, `he`, `ur`.
+ *
+ * Must be used within a `Provide(Locale, ...)` context so it can react to locale changes.
+ *
+ * @example
+ * ```typescript
+ * import { Use, Provide } from '@tempots/dom'
+ * import { Locale, BeatUII18n } from '@tempots/beatui'
+ *
+ * Provide(Locale, {}, () =>
+ *   Provide(BeatUII18n, {}, () =>
+ *     Use(BeatUII18n, t => html.p(t.$.confirm))
+ *   )
+ * )
+ * ```
+ */
 export declare const BeatUII18n: import("@tempots/dom").Provider<import("@tempots/dom").Signal<{
     loadingExtended: string;
     loadingShort: string;
@@ -52,6 +76,69 @@ export declare const BeatUII18n: import("@tempots/dom").Provider<import("@tempot
     clearValue: string;
     unknownType: string;
     filesInputInstructions: (maxFiles: number | undefined, maxFileSize: number | undefined, fileSizeUnits: string[]) => string;
+    paginationLabel: string;
+    firstPage: string;
+    previousPage: string;
+    nextPage: string;
+    lastPage: string;
+    breadcrumbs: string;
+    commandPalette: string;
+    typeACommand: string;
+    noResultsFound: string;
+    noMatchingCommands: string;
+    appearanceSystem: string;
+    appearanceLight: string;
+    appearanceDark: string;
+    ok: string;
+    changeTypeConfirmation: string;
+    notifications: string;
+    markAllAsRead: string;
+    noNotifications: string;
+    schemaConflictsDetected: string;
+    schemaViolationsDetected: string;
+    properties: string;
+    uploading: string;
+    dropFilesOrBrowse: string;
+    acceptedTypes: (types: string) => string;
+    enterUrlPrompt: string;
+    exceeded: string;
+    pdfPreview: string;
+    lexical: {
+        fontFamily: string;
+        fontSize: string;
+        fontColor: string;
+        highlightColor: string;
+        backgroundColor: string;
+        bold: string;
+        italic: string;
+        underline: string;
+        strikethrough: string;
+        code: string;
+        clearFormatting: string;
+        normal: string;
+        heading: (level: number) => string;
+        bulletList: string;
+        orderedList: string;
+        checkList: string;
+        indent: string;
+        outdent: string;
+        blockquote: string;
+        codeBlock: string;
+        horizontalRule: string;
+        insertTable: string;
+        link: string;
+        undo: string;
+        redo: string;
+        cut: string;
+        copy: string;
+        paste: string;
+        defaultOption: string;
+        slashCommands: string;
+        noCommandsFound: string;
+        changeBlockType: string;
+        blockTypes: string;
+        enterUrl: string;
+    };
     prosemirror: {
         bold: string;
         italic: string;

package/dist/types/better-auth/components/authenticated.d.ts

@@ -1,4 +1,4 @@
 import { TNode } from '@tempots/dom';
 import { BetterAuthBridge } from '../types';
-export declare function Authenticated(auth: BetterAuthBridge, children: () => TNode): TNode;
-export declare function Unauthenticated(auth: BetterAuthBridge, children: () => TNode): TNode;
+export declare function Authenticated(auth: BetterAuthBridge, children: () => TNode): import("@tempots/dom").Renderable;
+export declare function Unauthenticated(auth: BetterAuthBridge, children: () => TNode): import("@tempots/dom").Renderable;

package/dist/types/better-auth/components/better-auth-container.d.ts

@@ -1,4 +1,4 @@
 import { TNode } from '@tempots/dom';
 import { AuthContainerOptions } from '../../components/auth';
 import { BetterAuthBridge } from '../types';
-export declare function BetterAuthContainer(auth: BetterAuthBridge, overrides?: Partial<AuthContainerOptions>, ...children: TNode[]): TNode;
+export declare function BetterAuthContainer(auth: BetterAuthBridge, overrides?: Partial<AuthContainerOptions>, ...children: TNode[]): import("@tempots/dom").Renderable;

package/dist/types/better-auth/components/better-auth-modal.d.ts

@@ -1,4 +1,4 @@
 import { TNode } from '@tempots/dom';
 import { AuthContainerOptions } from '../../components/auth';
 import { BetterAuthBridge } from '../types';
-export declare function BetterAuthModal(auth: BetterAuthBridge, fn: (open: (overrides?: Partial<AuthContainerOptions>) => void) => TNode): TNode;
+export declare function BetterAuthModal(auth: BetterAuthBridge, fn: (open: (overrides?: Partial<AuthContainerOptions>) => void) => TNode): import("@tempots/dom").Renderable;

package/dist/types/better-auth/index.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Better Auth integration bridge for `@tempots/beatui/better-auth`.
+ *
+ * Connects a `better-auth` client to the BeatUI auth UI components, with
+ * support for session management, passkeys, two-factor authentication,
+ * magic links, and social provider mapping.
+ *
+ * ```ts
+ * import { createBetterAuthBridge, BetterAuth } from '@tempots/beatui/better-auth'
+ * ```
+ *
+ * @module
+ */
 export type { BetterAuthClient, BetterAuthResult, BetterAuthUser, BetterAuthSession, BetterAuthBridge, BetterAuthBridgeOptions, TwoFactorClient, PasskeyClient, PasskeyInfo, } from './types';
 export { createBetterAuthBridge } from './bridge';
 export { createSessionManager } from './session';

package/dist/types/better-auth/provider.d.ts

@@ -1,6 +1,39 @@
+/**
+ * Better Auth Provider
+ *
+ * Defines the BeatUI context provider for the better-auth bridge. Follows the
+ * standard Tempo `Provider<Value, Options>` pattern with `mark` and `create`.
+ *
+ * @module better-auth/provider
+ */
 import { Provider } from '@tempots/dom';
 import { BetterAuthBridge, BetterAuthBridgeOptions, BetterAuthClient } from './types';
+/**
+ * Options for the {@link BetterAuth} provider.
+ *
+ * Extends {@link BetterAuthBridgeOptions} with the required `client` instance.
+ */
 export interface BetterAuthProviderOptions extends BetterAuthBridgeOptions {
+    /** The better-auth client instance to use for authentication operations. */
     client: BetterAuthClient;
 }
+/**
+ * Context provider for the better-auth bridge.
+ *
+ * Creates a {@link BetterAuthBridge} from the provided client and options,
+ * making it available to descendant components via the Tempo provider system.
+ * Automatically disposes the bridge when the provider is removed from the DOM.
+ *
+ * @example
+ * ```ts
+ * import { Provide, Use } from '@tempots/dom'
+ * import { BetterAuth } from '@tempots/beatui/auth'
+ *
+ * Provide(BetterAuth, { client: authClient, socialProviders: ['google'] },
+ *   Use(BetterAuth, (bridge) =>
+ *     AuthContainer(bridge.containerOptions)
+ *   )
+ * )
+ * ```
+ */
 export declare const BetterAuth: Provider<BetterAuthBridge, BetterAuthProviderOptions>;

package/dist/types/better-auth/types.d.ts

@@ -1,5 +1,23 @@
+/**
+ * Better Auth Types
+ *
+ * TypeScript interfaces for the better-auth integration layer. Defines structural
+ * interfaces for the better-auth client (avoiding hard import dependencies),
+ * session types, bridge configuration, and plugin client interfaces for
+ * two-factor authentication and passkeys.
+ *
+ * @module better-auth/types
+ */
 import { Signal } from '@tempots/dom';
 import { AuthContainerLabels, AuthContainerOptions, AuthProviderInfo, AuthProviderName, PasswordRules, ResetPasswordFormOptions, SignInFormOptions, SignUpFormOptions } from '../components/auth';
+/**
+ * Structural interface for the better-auth client.
+ *
+ * Defines the expected shape of the better-auth client object without
+ * importing the actual library, avoiding a hard dependency. Components
+ * that receive a `BetterAuthClient` can work with any object that
+ * satisfies this interface.
+ */
 export interface BetterAuthClient {
     signIn: {
         email: (opts: {
@@ -59,20 +77,42 @@ export interface BetterAuthClient {
         }) => Promise<BetterAuthResult<unknown>>;
     };
 }
+/**
+ * Result type returned by better-auth client methods.
+ *
+ * Either `data` or `error` will be non-null, but not both.
+ *
+ * @typeParam T - The type of the success data.
+ */
 export interface BetterAuthResult<T> {
+    /** The success data, or `null` if the operation failed. */
     data: T | null;
+    /** The error details, or `null` if the operation succeeded. */
     error: {
         message: string;
         status: number;
         statusText: string;
     } | null;
 }
+/**
+ * Represents a user object from the better-auth system.
+ */
 export interface BetterAuthUser {
+    /** The unique user identifier. */
     id: string;
+    /** The user's display name. */
     name?: string;
+    /** The user's email address. */
     email: string;
+    /** URL to the user's profile image. */
     image?: string;
 }
+/**
+ * Client interface for two-factor authentication operations.
+ *
+ * Provides methods for enabling/disabling 2FA, verifying TOTP codes,
+ * sending and verifying OTP codes, and managing backup codes.
+ */
 export interface TwoFactorClient {
     enable: (opts: {
         password: string;
@@ -109,6 +149,11 @@ export interface TwoFactorClient {
         code: string;
     }) => Promise<BetterAuthResult<unknown>>;
 }
+/**
+ * Client interface for passkey (WebAuthn) operations.
+ *
+ * Provides methods for adding, listing, deleting, and renaming passkeys.
+ */
 export interface PasskeyClient {
     addPasskey: (opts?: {
         name?: string;
@@ -122,43 +167,110 @@ export interface PasskeyClient {
         name: string;
     }) => Promise<BetterAuthResult<unknown>>;
 }
+/**
+ * Information about a registered passkey.
+ */
 export interface PasskeyInfo {
+    /** The unique passkey identifier. */
     id: string;
+    /** The user-assigned name for this passkey. */
     name?: string;
+    /** The ISO 8601 date string when the passkey was created. */
     createdAt: string;
 }
+/**
+ * Configuration options for the better-auth bridge.
+ *
+ * Controls OAuth callback URLs, social providers, form display options,
+ * session polling, and event callbacks.
+ */
 export interface BetterAuthBridgeOptions {
+    /** The URL to redirect to after successful authentication. */
     callbackURL?: string;
+    /** The URL to redirect to when an authentication error occurs. */
     errorCallbackURL?: string;
+    /** List of social provider names to display login buttons for. */
     socialProviders?: AuthProviderName[];
+    /** Password validation rules for sign-in and sign-up forms. */
     passwordRules?: PasswordRules;
+    /** Whether to show the "remember me" checkbox. */
     showRememberMe?: boolean;
+    /** Whether to show the name field on the sign-up form. */
     showNameField?: boolean;
+    /** Whether to show the confirm password field on the sign-up form. */
     showConfirmPassword?: boolean;
+    /** Whether to show the password strength indicator on the sign-up form. */
     showPasswordStrength?: boolean;
+    /** Session polling interval in milliseconds. Set to `0` to disable. @default 0 */
     refreshInterval?: number;
+    /**
+     * Callback invoked whenever the session state changes.
+     * @param session - The new session, or `null` if the user signed out.
+     */
     onSessionChange?: (session: BetterAuthSession | null) => void;
+    /**
+     * Callback invoked when an authentication error occurs.
+     * @param error - The error details including message and HTTP status.
+     */
     onError?: (error: {
         message: string;
         status: number;
     }) => void;
+    /** Custom label overrides for all auth form text. */
     labels?: AuthContainerLabels;
 }
+/**
+ * Represents an active authentication session.
+ *
+ * Contains the authenticated user and any additional session data
+ * from the better-auth backend.
+ */
 export interface BetterAuthSession {
+    /** The authenticated user. */
     user: BetterAuthUser;
+    /** Additional session properties from the backend. */
     [key: string]: unknown;
 }
+/**
+ * The bridge object returned by {@link createBetterAuthBridge}.
+ *
+ * Provides reactive session state, pre-configured form options for auth
+ * components, and methods for sign-out and session management.
+ *
+ * @example
+ * ```ts
+ * const bridge = createBetterAuthBridge(authClient, { socialProviders: ['google'] })
+ *
+ * // Use reactive state
+ * When(bridge.isAuthenticated, () => html.div('Welcome!'))
+ *
+ * // Use pre-configured options
+ * AuthContainer(bridge.containerOptions)
+ * ```
+ */
 export interface BetterAuthBridge {
+    /** Reactive signal containing the current session, or `null` if not authenticated. */
     session: Signal<BetterAuthSession | null>;
+    /** Reactive signal that is `true` while the initial session fetch is in progress. */
     isPending: Signal<boolean>;
+    /** Reactive signal containing the current user, or `null` if not authenticated. */
     user: Signal<BetterAuthUser | null>;
+    /** Reactive signal that is `true` when the user is authenticated. */
     isAuthenticated: Signal<boolean>;
+    /** Pre-configured options for the {@link AuthContainer} component. */
     containerOptions: AuthContainerOptions;
+    /** Pre-configured options for the {@link SignInForm} component. */
     signInOptions: SignInFormOptions;
+    /** Pre-configured options for the {@link SignUpForm} component. */
     signUpOptions: SignUpFormOptions;
+    /** Pre-configured options for the {@link ResetPasswordForm} component. */
     resetOptions: ResetPasswordFormOptions;
+    /** The list of social provider configurations derived from bridge options. */
     socialProviders: AuthProviderInfo[];
+    /** Signs the user out and refreshes the session state. */
     signOut: () => Promise<void>;
+    /** Manually refreshes the session by re-fetching from the server. */
     refreshSession: () => Promise<void>;
+    /** Disposes all reactive signals and clears any polling intervals. */
     dispose: () => void;
 }

package/dist/types/components/auth/auth-container.d.ts

@@ -1,6 +1,67 @@
+/**
+ * Auth Container Component
+ *
+ * The main authentication UI container that switches between sign-in,
+ * sign-up, and reset-password modes. Coordinates social login buttons,
+ * form fields, mode navigation links, and i18n labels.
+ *
+ * @module auth/auth-container
+ */
 import { TNode } from '@tempots/dom';
 import { AuthContainerOptions } from './index';
-export declare function AuthContainer({ mode: initialMode, socialProviders, initialName, initialEmail, passwordRules, showRememberMe, showSocialDivider, showPasswordStrength, labels, onSignIn, onSignUp, onResetPassword, onModeChange, onSocialLogin, showContainer, }: AuthContainerOptions, ...children: TNode[]): TNode;
+/**
+ * Renders the main authentication container that switches between sign-in,
+ * sign-up, and reset-password modes.
+ *
+ * The container manages mode state, renders the appropriate form for the
+ * current mode, displays optional social login buttons with a divider,
+ * and provides navigation links to switch between modes.
+ *
+ * @param options - Configuration options for the auth container.
+ * @param children - Additional child nodes to render inside the container.
+ * @returns A `TNode` representing the complete auth container UI.
+ *
+ * @example
+ * ```ts
+ * AuthContainer({
+ *   mode: 'signin',
+ *   socialProviders: [{ provider: 'google' }, { provider: 'github' }],
+ *   onSignIn: async (data) => {
+ *     const error = await api.signIn(data)
+ *     return error ?? null
+ *   },
+ *   onSignUp: async (data) => {
+ *     const error = await api.signUp(data)
+ *     return error ?? null
+ *   },
+ *   onResetPassword: async (data) => {
+ *     const error = await api.resetPassword(data)
+ *     return error ?? null
+ *   },
+ *   showRememberMe: true,
+ *   showSocialDivider: true,
+ * })
+ * ```
+ */
+export declare function AuthContainer({ mode: initialMode, socialProviders, initialName, initialEmail, passwordRules, showRememberMe, showSocialDivider, showPasswordStrength, labels, onSignIn, onSignUp, onResetPassword, onModeChange, onSocialLogin, showContainer, }: AuthContainerOptions, ...children: TNode[]): import("@tempots/dom").Renderable;
+/**
+ * Creates an authentication container displayed inside a modal dialog.
+ *
+ * Provides a callback-based API where the consumer receives an `open` function
+ * that triggers the modal with auth container content. The modal is small-sized,
+ * dismissable, and includes a close button.
+ *
+ * @param fn - A function that receives an `open` callback and returns the trigger `TNode`.
+ *   The `open` callback accepts {@link AuthContainerOptions} plus an optional `modalTitle`.
+ * @returns A `TNode` that includes both the trigger element and the modal.
+ *
+ * @example
+ * ```ts
+ * AuthModal((open) =>
+ *   Button({ onClick: () => open({ onSignIn: handleSignIn }) }, 'Sign In')
+ * )
+ * ```
+ */
 export declare function AuthModal(fn: (open: (options: AuthContainerOptions & {
     modalTitle?: () => string;
-}) => void) => TNode): TNode;
+}) => void) => TNode): import("@tempots/dom").Renderable;

package/dist/types/components/auth/auth-divider.d.ts

@@ -1,8 +1,38 @@
+/**
+ * Auth Divider Component
+ *
+ * A horizontal divider with centered text (typically "or") used to visually
+ * separate social login buttons from the email/password form.
+ *
+ * @module auth/auth-divider
+ */
 import { Renderable, Value } from '@tempots/dom';
+/**
+ * Options for the {@link AuthDivider} component.
+ */
 export interface AuthDividerOptions {
+    /** Optional label overrides. */
     labels?: {
+        /** Custom text to display in the divider (e.g., `'or'`). Falls back to i18n `orDivider`. */
         text?: () => string;
     };
+    /** Additional CSS class names to apply to the divider container. */
     className?: Value<string>;
 }
+/**
+ * Renders a horizontal divider line with centered text.
+ *
+ * Typically displays "or" (localized) between social login buttons and
+ * the email/password form. The text can be customized via the `labels` option
+ * or overridden by the active locale's `orDivider` translation.
+ *
+ * @param options - Configuration options for the divider.
+ * @returns A `Renderable` DOM element representing the divider.
+ *
+ * @example
+ * ```ts
+ * AuthDivider()
+ * AuthDivider({ labels: { text: () => 'or continue with email' } })
+ * ```
+ */
 export declare function AuthDivider({ labels, className, }?: AuthDividerOptions): Renderable;