@better-auth-ui/core/dist/plugins/dash/dash-plugin.d.ts

Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.

import { DashLocalizationOverrides } from './dash-localization';
declare module "../../lib/view-paths" {
    interface SettingsViewPaths {
        /** @default "activity" */
        activity?: string;
    }
}
export type DashPluginOptions = {
    /** Add activity to the admin user inspector. @default true */
    admin?: boolean;
    /** Add activity to personal settings. @default true */
    user?: boolean;
    /** Add activity to organization settings. @default true */
    organization?: boolean;
    /** Number of events loaded per page. Clamped to 1–100. @default 20 */
    pageSize?: number;
    /** Show recorded IP addresses next to event locations. @default false */
    showIpAddress?: boolean;
    /** @default "activity" */
    path?: string;
    localization?: DashLocalizationOverrides;
};
/**
 * Adds user and organization activity views backed by Better Auth
 * Infrastructure Dash audit logs.
 *
 * Pair this UI plugin with `dash()` on the server and `dashClient()` on the
 * Better Auth client.
 */
export declare const dashPlugin: ((options?: DashPluginOptions | undefined) => {
    admin: boolean;
    user: boolean;
    organization: boolean;
    pageSize: number;
    showIpAddress: boolean;
    localization: {
        eventLabels: {
            account_linked: "Account linked";
            account_unlinked: "Account unlinked";
            all_sessions_revoked: "All sessions revoked";
            email_changed: "Email changed";
            email_verification_sent: "Verification email sent";
            email_verified: "Email verified";
            organization_created: "Organization created";
            organization_member_added: "Member added";
            organization_member_invite_accepted: "Invitation accepted";
            organization_member_invite_canceled: "Invitation canceled";
            organization_member_invite_rejected: "Invitation rejected";
            organization_member_invited: "Member invited";
            organization_member_removed: "Member removed";
            organization_member_role_updated: "Member role updated";
            organization_team_created: "Team created";
            organization_team_deleted: "Team deleted";
            organization_team_member_added: "Team member added";
            organization_team_member_removed: "Team member removed";
            organization_team_updated: "Team updated";
            organization_updated: "Organization updated";
            password_changed: "Password changed";
            password_reset_completed: "Password reset completed";
            password_reset_requested: "Password reset requested";
            profile_image_updated: "Profile image updated";
            profile_updated: "Profile updated";
            session_created: "Session created";
            session_revoked: "Session revoked";
            two_factor_disabled: "Two-factor authentication disabled";
            two_factor_enabled: "Two-factor authentication enabled";
            two_factor_verified: "Two-factor authentication verified";
            user_banned: "User banned";
            user_created: "Account created";
            user_deleted: "User deleted";
            user_impersonated: "User impersonated";
            user_impersonated_stopped: "User impersonation stopped";
            user_sign_in_failed: "Sign-in failed";
            user_signed_in: "Signed in";
            user_signed_out: "Signed out";
            user_unbanned: "User unbanned";
        };
        retry: string;
        nextPage: string;
        previousPage: string;
        identifier: string;
        eventType: string;
        activity: string;
        activityDescription: string;
        adminUserActivityDescription: string;
        adminActivityDescription: string;
        organizationActivityDescription: string;
        organizationWide: string;
        personalOnly: string;
        noActivity: string;
        noActivityDescription: string;
        activityLoadError: string;
        activityLoadErrorDescription: string;
        paginationRange: string;
        allEvents: string;
        identifierPlaceholder: string;
        unknownEvent: string;
    };
    viewPaths: {
        settings: {
            activity: string;
        };
    };
} & {
    id: "dash";
}) & {
    id: "dash";
};