@djangocfg/layouts 2.1.102 → 2.1.104

package/dist/layouts.d.ts

@@ -1,748 +0,0 @@
-import React, { ErrorInfo, ReactNode } from 'react';
-import { LucideIcon } from 'lucide-react';
-import { AuthConfig, AuthLayoutProps, AuthFormContextType, AuthHelpProps } from '@djangocfg/api/auth';
-export { AuthChannel, AuthFormContextType, AuthFormState, AuthHelpProps, AuthLayoutConfig, AuthLayoutProps, AuthStep } from '@djangocfg/api/auth';
-import { ZodError } from 'zod';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-
-/**
- * Provider Configuration Types
- *
- * Configuration types for layout providers (theme, SWR, MCP chat, Centrifugo)
- * Note: Analytics, PWA, Push, and Error types are defined in their respective modules
- */
-interface ThemeConfig {
-    defaultTheme?: 'light' | 'dark' | 'system';
-    storageKey?: string;
-}
-interface SWRConfigOptions {
-    revalidateOnFocus?: boolean;
-    revalidateOnReconnect?: boolean;
-    dedupingInterval?: number;
-}
-interface McpChatConfig {
-    /** Enable MCP chat widget */
-    enabled?: boolean;
-    /** API endpoint for chat */
-    apiEndpoint?: string;
-    /** Chat widget title */
-    title?: string;
-    /** Input placeholder */
-    placeholder?: string;
-    /** Greeting message */
-    greeting?: string;
-    /** Widget position */
-    position?: 'bottom-right' | 'bottom-left';
-    /** Widget variant */
-    variant?: 'default' | 'minimal';
-    /** Enable streaming responses */
-    enableStreaming?: boolean;
-    /** Auto-detect environment (dev/prod) */
-    autoDetectEnvironment?: boolean;
-    /** Custom class name */
-    className?: string;
-}
-interface CentrifugoConfig {
-    /** Enable Centrifugo (default: true) */
-    enabled?: boolean;
-    /** Auto-connect on mount (default: false) */
-    autoConnect?: boolean;
-    /** Centrifugo server URL */
-    url?: string;
-}
-
-/**
- * Analytics Configuration Types
- *
- * Configuration for Google Analytics integration
- */
-interface AnalyticsConfig {
-    /** Google Analytics tracking ID (e.g., 'G-XXXXXXXXXX') */
-    googleTrackingId?: string;
-}
-
-/**
- * PWA Install Configuration Types
- *
- * Configuration for Progressive Web App installation features
- */
-interface PwaInstallConfig {
-    /** Enable PWA installation features */
-    enabled?: boolean;
-    /** Show A2HS (Add to Home Screen) hint (enabled by default when enabled is true) */
-    showInstallHint?: boolean;
-    /** Number of days before re-showing dismissed hint (null = never show again) */
-    resetAfterDays?: number | null;
-    /** Delay before showing hint (ms) */
-    delayMs?: number;
-    /** App logo URL to display in hint */
-    logo?: string;
-    /**
-     * Resume last page when opening PWA
-     * When enabled, saves current pathname on navigation and restores it on PWA launch
-     * @default false
-     */
-    resumeLastPage?: boolean;
-}
-
-/**
- * Push Notifications Configuration Types
- *
- * Configuration for Web Push Notifications with VAPID authentication
- */
-interface PushNotificationsConfig {
-    /** Enable push notifications */
-    enabled?: boolean;
-    /** VAPID public key for push notifications (required when enabled) */
-    vapidPublicKey: string;
-    /** API endpoint for subscription (default: '/api/push/subscribe') */
-    subscribeEndpoint?: string;
-    /** Only show push prompt if PWA is installed (default: true) */
-    requirePWA?: boolean;
-    /** Delay before showing push prompt after PWA install (ms) */
-    delayMs?: number;
-    /** Number of days before re-showing dismissed push prompt */
-    resetAfterDays?: number;
-    /** Auto-subscribe on mount if permission already granted */
-    autoSubscribe?: boolean;
-}
-
-/**
- * Error Tracking Types
- *
- * Common types for all error tracking functionality
- */
-
-/**
- * Base error detail from CustomEvent
- */
-interface BaseErrorDetail {
-    /** Timestamp of the error */
-    timestamp: Date;
-}
-/**
- * Validation error detail (from zod-validation-error event)
- */
-interface ValidationErrorDetail extends BaseErrorDetail {
-    type: 'validation';
-    /** Operation/function name that failed validation */
-    operation: string;
-    /** API endpoint path */
-    path: string;
-    /** HTTP method */
-    method: string;
-    /** Zod validation error */
-    error: ZodError;
-    /** Raw response data that failed validation */
-    response: any;
-}
-/**
- * CORS error detail (from cors-error event)
- */
-interface CORSErrorDetail extends BaseErrorDetail {
-    type: 'cors';
-    /** API endpoint that was blocked */
-    url: string;
-    /** HTTP method */
-    method: string;
-    /** Error message */
-    error: string;
-}
-/**
- * Network error detail (from network-error event)
- */
-interface NetworkErrorDetail extends BaseErrorDetail {
-    type: 'network';
-    /** API endpoint that failed */
-    url: string;
-    /** HTTP method */
-    method: string;
-    /** Error message */
-    error: string;
-    /** Status code if available */
-    statusCode?: number;
-}
-/**
- * Centrifugo error detail (from centrifugo-error event)
- */
-interface CentrifugoErrorDetail extends BaseErrorDetail {
-    type: 'centrifugo';
-    /** RPC method that failed */
-    method: string;
-    /** Error message */
-    error: string;
-    /** Error code from Centrifugo */
-    code?: number;
-    /** Additional data sent with the request */
-    data?: any;
-}
-/**
- * Union type of all error details
- */
-type ErrorDetail = ValidationErrorDetail | CORSErrorDetail | NetworkErrorDetail | CentrifugoErrorDetail;
-/**
- * Configuration for specific error type
- */
-interface ErrorTypeConfig {
-    /**
-     * Enable tracking for this error type
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Show toast notifications
-     * @default true
-     */
-    showToast?: boolean;
-    /**
-     * Maximum number of errors to keep in history
-     * @default 50
-     */
-    maxErrors?: number;
-    /**
-     * Toast duration in milliseconds (0 = no auto-dismiss)
-     * @default 8000 for validation, 0 for cors/network
-     */
-    duration?: number;
-}
-/**
- * Validation error specific config
- */
-interface ValidationErrorConfig extends ErrorTypeConfig {
-    /**
-     * Show operation name in toast
-     * @default true
-     */
-    showOperation?: boolean;
-    /**
-     * Show endpoint path in toast
-     * @default true
-     */
-    showPath?: boolean;
-    /**
-     * Show error count in toast
-     * @default true
-     */
-    showErrorCount?: boolean;
-    /**
-     * Maximum number of issues to show in toast
-     * @default 3
-     */
-    maxIssuesInToast?: number;
-}
-/**
- * CORS error specific config
- */
-interface CORSErrorConfig extends ErrorTypeConfig {
-    /**
-     * Show full URL in toast
-     * @default true
-     */
-    showUrl?: boolean;
-    /**
-     * Show HTTP method in toast
-     * @default true
-     */
-    showMethod?: boolean;
-}
-/**
- * Network error specific config
- */
-interface NetworkErrorConfig extends ErrorTypeConfig {
-    /**
-     * Show full URL in toast
-     * @default true
-     */
-    showUrl?: boolean;
-    /**
-     * Show HTTP method in toast
-     * @default true
-     */
-    showMethod?: boolean;
-    /**
-     * Show status code in toast
-     * @default true
-     */
-    showStatusCode?: boolean;
-}
-/**
- * Centrifugo error specific config
- */
-interface CentrifugoErrorConfig extends ErrorTypeConfig {
-    /**
-     * Show RPC method in toast
-     * @default true
-     */
-    showMethod?: boolean;
-    /**
-     * Show error code in toast
-     * @default true
-     */
-    showCode?: boolean;
-}
-/**
- * Complete error tracking configuration
- */
-interface ErrorTrackingConfig {
-    /**
-     * Validation error tracking configuration
-     */
-    validation?: ValidationErrorConfig;
-    /**
-     * CORS error tracking configuration
-     */
-    cors?: CORSErrorConfig;
-    /**
-     * Network error tracking configuration
-     */
-    network?: NetworkErrorConfig;
-    /**
-     * Centrifugo error tracking configuration
-     */
-    centrifugo?: CentrifugoErrorConfig;
-    /**
-     * Custom error handler (called before toast for all errors)
-     * Return false to prevent default toast notification
-     */
-    onError?: (error: ErrorDetail) => boolean | void;
-}
-
-/**
- * Error Handling Configuration Types
- *
- * Configuration types for ErrorTrackingProvider and ErrorBoundary
- */
-
-/**
- * Error Boundary Configuration
- *
- * Configuration for React ErrorBoundary component
- */
-interface ErrorBoundaryConfig {
-    /** Enable error boundary (default: true) */
-    enabled?: boolean;
-    /** Support email to display in error UI */
-    supportEmail?: string;
-    /** Custom error handler called when error is caught */
-    onError?: (error: Error, errorInfo: ErrorInfo) => void;
-}
-
-/**
- * UI Component Types
- *
- * Types for layout UI components (navigation, footer, user menu)
- */
-
-interface NavigationItem {
-    label: string;
-    href: string;
-    icon?: LucideIcon | string;
-    badge?: string | number;
-    external?: boolean;
-}
-interface NavigationSection {
-    title?: string;
-    items: NavigationItem[];
-}
-interface FooterLink$1 {
-    label: string;
-    path: string;
-    external?: boolean;
-}
-interface FooterMenuSection$1 {
-    title: string;
-    items: FooterLink$1[];
-}
-interface FooterSocialLinks$1 {
-    github?: string;
-    linkedin?: string;
-    twitter?: string;
-    telegram?: string;
-    youtube?: string;
-    facebook?: string;
-    instagram?: string;
-    whatsapp?: string;
-    email?: string;
-}
-interface FooterConfig {
-    siteName?: string;
-    description?: string;
-    logo?: string;
-    badge?: {
-        icon: LucideIcon;
-        text: string;
-    };
-    socialLinks?: FooterSocialLinks$1;
-    links?: FooterLink$1[];
-    menuSections?: FooterMenuSection$1[];
-    copyright?: string;
-    credits?: {
-        text: string;
-        url?: string;
-    };
-    variant?: 'full' | 'simple';
-}
-interface UserMenuItem {
-    /** Menu item label */
-    label: string;
-    /** Link href (optional if onClick is provided) */
-    href?: string;
-    /** Icon component */
-    icon?: LucideIcon;
-    /** Visual variant */
-    variant?: 'default' | 'destructive';
-    /** Click handler (optional if href is provided) */
-    onClick?: () => void;
-    /** Open link in new tab */
-    external?: boolean;
-}
-interface UserMenuGroup {
-    /** Optional group title (renders DropdownMenuLabel) */
-    title?: string;
-    /** Menu items in this group */
-    items: UserMenuItem[];
-}
-interface UserMenuConfig {
-    /** Menu groups for authenticated users */
-    groups?: UserMenuGroup[];
-    /** Auth page path (for sign in button) */
-    authPath?: string;
-}
-
-/**
- * Base Layout Types
- *
- * Core layout configuration that combines all provider configs
- */
-
-/**
- * Base Layout Props
- *
- * Core configuration for BaseApp component.
- * All provider configs are imported from their respective modules.
- */
-interface BaseLayoutProps {
-    children: ReactNode;
-    /** Theme configuration */
-    theme?: ThemeConfig;
-    /** Auth configuration */
-    auth?: AuthConfig;
-    /** Analytics configuration (from snippets/Analytics) */
-    analytics?: AnalyticsConfig;
-    /** Centrifugo configuration */
-    centrifugo?: CentrifugoConfig;
-    /** Error tracking configuration (from components/errors) */
-    errorTracking?: ErrorTrackingConfig;
-    /** SWR configuration */
-    swr?: SWRConfigOptions;
-    /** Error boundary configuration (from components/errors, enabled by default) */
-    errorBoundary?: ErrorBoundaryConfig;
-    /** MCP chat configuration */
-    mcpChat?: McpChatConfig;
-    /** PWA Install configuration (from snippets/PWAInstall) */
-    pwaInstall?: PwaInstallConfig;
-    /** Push Notifications configuration (from snippets/PushNotifications) */
-    pushNotifications?: PushNotificationsConfig;
-}
-
-interface UserMenuProps {
-    /** Display variant */
-    variant?: 'desktop' | 'mobile';
-    /** Menu groups for authenticated users */
-    groups?: UserMenuGroup[];
-    /** Auth page path (for sign in button) */
-    authPath?: string;
-}
-declare function UserMenu({ variant, groups, authPath, }: UserMenuProps): react_jsx_runtime.JSX.Element;
-
-type LayoutMode = 'public' | 'private' | 'admin';
-interface AppLayoutProps {
-    children: ReactNode;
-    /** Public layout component with enabled paths */
-    publicLayout?: {
-        component: React.ComponentType<{
-            children: ReactNode;
-        }>;
-        enabledPath?: string | string[];
-    };
-    /** Private layout component with enabled paths */
-    privateLayout?: {
-        component: React.ComponentType<{
-            children: ReactNode;
-        }>;
-        enabledPath?: string | string[];
-    };
-    /** Admin layout component with enabled paths */
-    adminLayout?: {
-        component: React.ComponentType<{
-            children: ReactNode;
-        }>;
-        enabledPath?: string | string[];
-    };
-    /**
-     * Paths that render without any layout wrapper (fullscreen pages)
-     * Providers (auth, theme, etc.) are still applied, only layout is skipped
-     * Useful for: fullscreen terminal, embed pages, print views
-     */
-    noLayoutPaths?: string | string[];
-    /** Theme configuration */
-    theme?: ThemeConfig;
-    /** Auth configuration */
-    auth?: AuthConfig;
-    /** Analytics configuration */
-    analytics?: AnalyticsConfig;
-    /** Centrifugo configuration */
-    centrifugo?: CentrifugoConfig;
-    /** Error tracking configuration */
-    errorTracking?: ErrorTrackingConfig;
-    /** SWR configuration */
-    swr?: SWRConfigOptions;
-    /** Error boundary configuration */
-    errorBoundary?: ErrorBoundaryConfig;
-    /** MCP Chat configuration */
-    mcpChat?: McpChatConfig;
-    /** PWA Install configuration */
-    pwaInstall?: PwaInstallConfig;
-    /** Push Notifications configuration */
-    pushNotifications?: PushNotificationsConfig;
-}
-/**
- * AppLayout - Main Component with All Providers
- */
-declare function AppLayout(props: AppLayoutProps): react_jsx_runtime.JSX.Element;
-
-type BaseAppProps = BaseLayoutProps;
-/**
- * BaseApp - Core providers wrapper for any React/Next.js app
- *
- * Includes: ThemeProvider, TooltipProvider, SWRConfig, AuthProvider, AnalyticsProvider,
- * CentrifugoProvider, PwaProvider, PushProvider, ErrorTrackingProvider,
- * ErrorBoundary (optional), MCP Chat (optional)
- * Also renders global Toaster and PageProgress components
- */
-declare function BaseApp({ children, theme, auth, analytics, centrifugo, errorTracking, errorBoundary, swr, mcpChat, pwaInstall, pushNotifications, }: BaseAppProps): react_jsx_runtime.JSX.Element;
-
-interface PublicLayoutProps {
-    children: ReactNode;
-    /** Logo path or URL */
-    logo?: string;
-    /** Site name */
-    siteName?: string;
-    /** Navigation items */
-    navigation?: NavigationItem[];
-    /** User menu configuration (optional, uses useAuth() for authentication state) */
-    userMenu?: UserMenuConfig;
-}
-declare function PublicLayout({ children, logo, siteName, navigation, userMenu, }: PublicLayoutProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Public Footer Types
- */
-
-interface FooterLink {
-    label: string;
-    path: string;
-    external?: boolean;
-}
-interface FooterMenuSection {
-    title: string;
-    items: FooterLink[];
-}
-interface FooterSocialLinks {
-    github?: string;
-    linkedin?: string;
-    twitter?: string;
-    telegram?: string;
-    youtube?: string;
-    facebook?: string;
-    instagram?: string;
-    whatsapp?: string;
-    email?: string;
-}
-interface PublicFooterProps {
-    /** Project name */
-    siteName: string;
-    /** Project description */
-    description?: string;
-    /** Logo path or URL */
-    logo?: string;
-    /** Optional badge */
-    badge?: {
-        icon: LucideIcon;
-        text: string;
-    };
-    /** Social media links */
-    socialLinks?: FooterSocialLinks;
-    /** Quick links (bottom bar) */
-    links?: FooterLink[];
-    /** Footer menu sections (desktop grid) */
-    menuSections?: FooterMenuSection[];
-    /** Copyright text (auto-generated if not provided) */
-    copyright?: string;
-    /** Credits */
-    credits?: {
-        text: string;
-        url?: string;
-    };
-    /** Variant: full (with all sections) or simple (minimal) */
-    variant?: 'full' | 'simple';
-}
-
-declare function PublicFooter({ siteName, description, logo, badge, socialLinks, links, menuSections, copyright: copyrightProp, credits: creditsProp, variant, }: PublicFooterProps): react_jsx_runtime.JSX.Element;
-
-interface FooterProjectInfoProps {
-    siteName: string;
-    description?: string;
-    logo?: string;
-    badge?: {
-        icon: LucideIcon;
-        text: string;
-    };
-    socialLinks?: FooterSocialLinks;
-    variant?: 'mobile' | 'desktop';
-}
-declare function FooterProjectInfo({ siteName, description, logo, badge, socialLinks, variant, }: FooterProjectInfoProps): react_jsx_runtime.JSX.Element;
-
-interface FooterMenuSectionsProps {
-    menuSections: FooterMenuSection[];
-}
-declare function FooterMenuSections({ menuSections }: FooterMenuSectionsProps): react_jsx_runtime.JSX.Element;
-
-interface FooterBottomProps {
-    copyright: string;
-    credits?: {
-        text: string;
-        url?: string;
-    };
-    links?: FooterLink[];
-    variant?: 'mobile' | 'desktop';
-}
-declare function FooterBottom({ copyright, credits, links, variant, }: FooterBottomProps): react_jsx_runtime.JSX.Element;
-
-interface FooterSocialLinksProps {
-    socialLinks?: FooterSocialLinks;
-    className?: string;
-    iconClassName?: string;
-}
-declare function FooterSocialLinksComponent({ socialLinks, className, iconClassName, }: FooterSocialLinksProps): react_jsx_runtime.JSX.Element;
-
-/**
- * DjangoCFG Logo Component
- *
- * Default SVG logo for DjangoCFG
- */
-interface DjangoCFGLogoProps {
-    className?: string;
-    size?: number;
-}
-declare function DjangoCFGLogo({ className, size }: DjangoCFGLogoProps): react_jsx_runtime.JSX.Element;
-
-interface SidebarItem {
-    label: string;
-    href: string;
-    icon?: string | LucideIcon;
-    badge?: string | number;
-}
-interface SidebarConfig {
-    items: SidebarItem[];
-    homeHref?: string;
-}
-interface HeaderConfig {
-    title?: string;
-    /** User menu groups */
-    groups?: UserMenuConfig['groups'];
-    /** Auth page path (for sign in button) */
-    authPath?: string;
-}
-interface PrivateLayoutProps {
-    children: ReactNode;
-    /** Sidebar configuration */
-    sidebar?: SidebarConfig;
-    /** Header configuration */
-    header?: HeaderConfig;
-    /** Content padding */
-    contentPadding?: 'none' | 'default';
-}
-declare function PrivateLayout({ children, sidebar, header, contentPadding, }: PrivateLayoutProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Auth Layout
- *
- * Layout for authentication pages with OTP (email/phone), OAuth (GitHub), and 2FA support.
- * Supports multi-step authentication flow: identifier → OTP → 2FA (if enabled)
- */
-
-declare const AuthLayout: React.FC<AuthLayoutProps>;
-
-declare const AuthFormProvider: React.FC<AuthLayoutProps>;
-declare const useAuthFormContext: () => AuthFormContextType;
-
-declare const IdentifierForm: React.FC;
-
-declare const OTPForm: React.FC;
-
-declare const AuthHelp: React.FC<AuthHelpProps>;
-
-/**
- * OAuth Providers Component
- *
- * Shows OAuth login buttons (GitHub, etc.) when enabled.
- */
-declare const OAuthProviders: React.FC;
-
-interface OAuthCallbackProps {
-    onSuccess?: (user: any, isNewUser: boolean, provider: string) => void;
-    onError?: (error: string) => void;
-    redirectUrl?: string;
-}
-/**
- * OAuth Callback Handler Component
- *
- * Processes OAuth callback from providers (GitHub, etc.).
- * Reads code, state, and provider from URL params and exchanges for tokens.
- *
- * Usage:
- * Place this component on your /auth page to handle OAuth callbacks.
- *
- * @example
- * ```tsx
- * // app/auth/page.tsx
- * import { OAuthCallback, AuthLayout } from '@djangocfg/layouts';
- *
- * export default function AuthPage() {
- *   return (
- *     <>
- *       <OAuthCallback
- *         onSuccess={(user) => console.log('OAuth success:', user)}
- *         onError={(error) => console.error('OAuth error:', error)}
- *       />
- *       <AuthLayout enableGithubAuth>
- *         {/* Your auth content *\/}
- *       </AuthLayout>
- *     </>
- *   );
- * }
- * ```
- */
-declare const OAuthCallback: React.FC<OAuthCallbackProps>;
-
-interface AdminLayoutProps extends PrivateLayoutProps {
-    children: ReactNode;
-}
-/**
- * Admin Layout Component
- *
- * Wrapper around PrivateLayout with admin-specific defaults
- * Same API as PrivateLayout - just a convenience export
- */
-declare function AdminLayout(props: AdminLayoutProps): react_jsx_runtime.JSX.Element;
-
-interface ProfileLayoutProps {
-    onUnauthenticated?: () => void;
-    title?: string;
-    enable2FA?: boolean;
-    enableDeleteAccount?: boolean;
-}
-declare const ProfileLayout: React.FC<ProfileLayoutProps>;
-
-export { AdminLayout, type AdminLayoutProps, type AnalyticsConfig, AppLayout, type AppLayoutProps, AuthFormProvider, AuthHelp, AuthLayout, BaseApp, type BaseAppProps, type BaseLayoutProps, type CORSErrorConfig, type CentrifugoConfig, DjangoCFGLogo, type ErrorBoundaryConfig, type ErrorTrackingConfig, FooterBottom, type FooterConfig, type FooterLink$1 as FooterLink, type FooterMenuSection$1 as FooterMenuSection, FooterMenuSections, FooterProjectInfo, type FooterSocialLinks$1 as FooterSocialLinks, FooterSocialLinksComponent, type HeaderConfig, IdentifierForm, type LayoutMode, type McpChatConfig, type NavigationItem, type NavigationSection, type NetworkErrorConfig, OAuthCallback, type OAuthCallbackProps, OAuthProviders, OTPForm, PrivateLayout, type PrivateLayoutProps, ProfileLayout, PublicFooter, type PublicFooterProps, PublicLayout, type PublicLayoutProps, type PushNotificationsConfig, type PwaInstallConfig, type SWRConfigOptions, type SidebarConfig, type SidebarItem, type ThemeConfig, UserMenu, type UserMenuConfig, type UserMenuGroup, type UserMenuItem, type UserMenuProps, type ValidationErrorConfig, useAuthFormContext };