@djangocfg/layouts 2.1.103 → 2.1.105

package/dist/components.d.mts

@@ -1,583 +0,0 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import React, { ReactNode, Component, ErrorInfo } from 'react';
-import { LucideIcon as LucideIcon$1 } from 'lucide-react';
-import { ZodError } from 'zod';
-
-interface ClientOnlyProps {
-    children: ReactNode;
-    /**
-     * Fallback to show during SSR and initial mount
-     * @default Preloader with "Loading..." text
-     */
-    fallback?: ReactNode;
-}
-/**
- * ClientOnly - Prevents SSR hydration mismatch
- *
- * Use this to wrap components that:
- * - Access browser-only APIs (window, localStorage, etc.)
- * - Have different initial state on server vs client
- * - Use authentication state that differs between SSR and CSR
- */
-declare function ClientOnly({ children, fallback, }: ClientOnlyProps): react_jsx_runtime.JSX.Element;
-
-interface JsonLdProps {
-    data: Record<string, any> | Record<string, any>[];
-}
-/**
- * JsonLd Component
- *
- * Renders JSON-LD structured data for SEO.
- * Use this for schema.org markup (Organization, WebSite, FAQPage, etc.)
- *
- * @example
- * ```tsx
- * <JsonLd data={{
- *   "@context": "https://schema.org",
- *   "@type": "Organization",
- *   "name": "My Company"
- * }} />
- * ```
- */
-declare function JsonLd({ data }: JsonLdProps): react_jsx_runtime.JSX.Element;
-
-interface LucideIconProps extends Omit<React.SVGProps<SVGSVGElement>, 'children'> {
-    /**
-     * Icon name (string) or icon component (LucideIcon)
-     * If string, will be resolved from lucide-react
-     * If component, will be used directly
-     */
-    icon?: LucideIcon$1 | string;
-    /**
-     * Fallback icon if name not found
-     * @default CloudLightning
-     */
-    fallback?: LucideIcon$1;
-    /**
-     * Additional CSS classes
-     */
-    className?: string;
-}
-/**
- * LucideIcon Component
- *
- * Renders a Lucide icon either by name (string) or by component reference.
- * Automatically resolves icon names from lucide-react package.
- *
- * Usage:
- * ```tsx
- * // By name (string)
- * <LucideIcon icon="CloudLightning" className="w-4 h-4" />
- *
- * // By component
- * import { CloudLightning } from 'lucide-react';
- * <LucideIcon icon={CloudLightning} className="w-4 h-4" />
- * ```
- */
-declare function LucideIcon({ icon, fallback, className, ...props }: LucideIconProps): react_jsx_runtime.JSX.Element;
-
-interface SuspenseProps {
-    children: ReactNode;
-    fallback?: ReactNode;
-}
-declare function Suspense({ children, fallback }: SuspenseProps): react_jsx_runtime.JSX.Element;
-
-interface ErrorBoundaryProps {
-    children: ReactNode;
-    supportEmail?: string;
-    onError?: (error: Error, errorInfo: ErrorInfo) => void;
-}
-interface ErrorBoundaryState {
-    hasError: boolean;
-    error: Error | null;
-}
-declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
-    constructor(props: ErrorBoundaryProps);
-    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
-    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
-    render(): string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>> | react_jsx_runtime.JSX.Element;
-}
-
-interface ErrorLayoutProps {
-    /** Error code (e.g., "404", "500", "403") - if provided, auto-configures title/description/icon */
-    code?: string | number;
-    /** Error title (auto-generated from code if not provided) */
-    title?: string;
-    /** Error description (auto-generated from code if not provided) */
-    description?: string;
-    /** Custom action buttons */
-    actions?: React.ReactNode;
-    /** Show default actions (back, home) */
-    showDefaultActions?: boolean;
-    /** Custom illustration/icon (auto-generated from code if not provided) */
-    illustration?: React.ReactNode;
-    /** Support email for contact link */
-    supportEmail?: string;
-}
-/**
- * ErrorLayout Component
- */
-declare function ErrorLayout({ code, title, description, actions, showDefaultActions, illustration, supportEmail, }: ErrorLayoutProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Universal Error Configuration
- *
- * Provides standard error content for common HTTP status codes
- * Use this to maintain consistency across error pages
- *
- * NOTE: Only returns primitives (title, description) - NO React components
- * This ensures safe serialization during prerendering
- */
-interface ErrorContent {
-    title: string;
-    description: string;
-}
-/**
- * Get standardized error content based on status code
- *
- * @param statusCode - HTTP status code or custom error type
- * @returns Error content configuration (title and description only)
- *
- * @example
- * ```tsx
- * const { title, description } = getErrorContent(404);
- * <ErrorLayout title={title} description={description} code={404} />
- * ```
- */
-declare function getErrorContent(statusCode?: number | string): ErrorContent;
-/**
- * Common error codes as constants
- */
-declare const ERROR_CODES: {
-    readonly BAD_REQUEST: 400;
-    readonly UNAUTHORIZED: 401;
-    readonly FORBIDDEN: 403;
-    readonly NOT_FOUND: 404;
-    readonly TIMEOUT: 408;
-    readonly SERVER_ERROR: 500;
-    readonly BAD_GATEWAY: 502;
-    readonly SERVICE_UNAVAILABLE: 503;
-    readonly GATEWAY_TIMEOUT: 504;
-};
-
-/**
- * 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;
-/**
- * Stored error with unique ID
- */
-type StoredError<T extends ErrorDetail = ErrorDetail> = T & {
-    /** Unique identifier for this error instance */
-    id: string;
-};
-/**
- * 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 tracking context value
- */
-interface ErrorTrackingContextValue {
-    /** All errors */
-    errors: StoredError[];
-    /** Validation errors only */
-    validationErrors: StoredError<ValidationErrorDetail>[];
-    /** CORS errors only */
-    corsErrors: StoredError<CORSErrorDetail>[];
-    /** Network errors only */
-    networkErrors: StoredError<NetworkErrorDetail>[];
-    /** Centrifugo errors only */
-    centrifugoErrors: StoredError<CentrifugoErrorDetail>[];
-    /** Clear all errors */
-    clearErrors: () => void;
-    /** Clear errors by type */
-    clearErrorsByType: (type: 'validation' | 'cors' | 'network' | 'centrifugo') => void;
-    /** Clear specific error by ID */
-    clearError: (id: string) => void;
-    /** Get error count */
-    errorCount: number;
-    /** Get latest error */
-    latestError: StoredError | null;
-    /** Configuration */
-    config: {
-        validation: Required<ValidationErrorConfig>;
-        cors: Required<CORSErrorConfig>;
-        network: Required<NetworkErrorConfig>;
-        centrifugo: Required<CentrifugoErrorConfig>;
-    };
-}
-
-/**
- * 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;
-}
-
-interface RedirectPageProps {
-    /**
-     * Path to redirect to when user is authenticated
-     * @default '/private'
-     */
-    authenticatedPath?: string;
-    /**
-     * Path to redirect to when user is not authenticated
-     * @default '/auth'
-     */
-    unauthenticatedPath?: string;
-    /**
-     * Custom loading text
-     * @default 'Loading...'
-     */
-    loadingText?: string;
-}
-/**
- * RedirectPage - Root page component that handles authentication redirect
- *
- * Redirects authenticated users to authenticatedPath, otherwise to unauthenticatedPath
- *
- * Usage:
- * ```tsx
- * // app/page.tsx
- * import { RedirectPage } from '@djangocfg/layouts/components';
- *
- * export default function Page() {
- *   return (
- *     <RedirectPage
- *       authenticatedPath="/private"
- *       unauthenticatedPath="/auth"
- *     />
- *   );
- * }
- * ```
- */
-declare function RedirectPage({ authenticatedPath, unauthenticatedPath, loadingText, }: RedirectPageProps): react_jsx_runtime.JSX.Element;
-
-interface ErrorTrackingProviderProps {
-    children: ReactNode;
-    validation?: Partial<ValidationErrorConfig>;
-    cors?: Partial<CORSErrorConfig>;
-    network?: Partial<NetworkErrorConfig>;
-    centrifugo?: Partial<CentrifugoErrorConfig>;
-    onError?: (error: ErrorDetail) => boolean | void;
-}
-/**
- * Universal Error Tracking Provider
- *
- * Tracks all error types with a single provider
- */
-declare function ErrorTrackingProvider({ children, validation: userValidationConfig, cors: userCorsConfig, network: userNetworkConfig, centrifugo: userCentrifugoConfig, onError, }: ErrorTrackingProviderProps): react_jsx_runtime.JSX.Element;
-/**
- * useErrors Hook
- *
- * Access errors from any component
- *
- * @example
- * ```tsx
- * function ErrorPanel() {
- *   const { errors, validationErrors, clearErrors } = useErrors();
- *
- *   return (
- *     <div>
- *       <h3>Errors ({errors.length})</h3>
- *       <h4>Validation: {validationErrors.length}</h4>
- *       <button onClick={clearErrors}>Clear All</button>
- *     </div>
- *   );
- * }
- * ```
- */
-declare function useErrors(): ErrorTrackingContextValue;
-
-interface ErrorButtonsProps {
-    detail: ValidationErrorDetail | CORSErrorDetail | NetworkErrorDetail | CentrifugoErrorDetail;
-}
-/**
- * Universal error buttons
- */
-declare function ErrorButtons({ detail }: ErrorButtonsProps): react_jsx_runtime.JSX.Element;
-
-/**
- * ErrorToast - Universal toast for all error types
- *
- * Formats validation, CORS, and network errors with appropriate styling
- */
-
-/**
- * Create toast options for any error type
- */
-declare function createErrorToast(detail: ValidationErrorDetail | CORSErrorDetail | NetworkErrorDetail | CentrifugoErrorDetail, config: Required<ValidationErrorConfig | CORSErrorConfig | NetworkErrorConfig | CentrifugoErrorConfig>): {
-    title: string;
-    description: React.ReactNode;
-    variant: "destructive";
-    duration: number;
-};
-
-/**
- * Error Formatters
- *
- * Format different error types for display and copying
- */
-
-/**
- * Format Zod error issues for display
- */
-declare function formatZodIssues(error: ZodError, maxIssues?: number): string;
-/**
- * Format validation error for clipboard
- */
-declare function formatValidationErrorForClipboard(detail: ValidationErrorDetail): string;
-/**
- * Format CORS error for clipboard
- */
-declare function formatCORSErrorForClipboard(detail: CORSErrorDetail): string;
-/**
- * Format network error for clipboard
- */
-declare function formatNetworkErrorForClipboard(detail: NetworkErrorDetail): string;
-/**
- * Format centrifugo error for clipboard
- */
-declare function formatCentrifugoErrorForClipboard(detail: CentrifugoErrorDetail): string;
-/**
- * Extract domain from URL
- */
-declare function extractDomain(url: string): string;
-/**
- * Format error title based on type
- */
-declare function formatErrorTitle(detail: ValidationErrorDetail | CORSErrorDetail | NetworkErrorDetail | CentrifugoErrorDetail): string;
-
-interface CurlOptions {
-    method: string;
-    path: string;
-    token?: string;
-    body?: any;
-    headers?: Record<string, string>;
-    baseUrl?: string;
-    queryParams?: Record<string, string>;
-}
-/**
- * Get authentication token from localStorage
- */
-declare function getAuthToken(): string | null;
-/**
- * Generate cURL command from request details
- */
-declare function generateCurl(options: CurlOptions): string;
-/**
- * Generate cURL from validation error details
- * Auto-fetches token from localStorage
- */
-declare function generateCurlFromError(detail: {
-    method: string;
-    path: string;
-    response?: any;
-}): string;
-
-export { type CORSErrorConfig, type CORSErrorDetail, type CentrifugoErrorConfig, type CentrifugoErrorDetail, ClientOnly, type ClientOnlyProps, type CurlOptions, ERROR_CODES, ErrorBoundary, type ErrorBoundaryConfig, ErrorButtons, type ErrorContent, type ErrorDetail, ErrorLayout, type ErrorLayoutProps, type ErrorTrackingConfig, type ErrorTrackingContextValue, ErrorTrackingProvider, JsonLd, LucideIcon, type LucideIconProps, type NetworkErrorConfig, type NetworkErrorDetail, RedirectPage, type RedirectPageProps, type StoredError, Suspense, type ValidationErrorConfig, type ValidationErrorDetail, createErrorToast, extractDomain, formatCORSErrorForClipboard, formatCentrifugoErrorForClipboard, formatErrorTitle, formatNetworkErrorForClipboard, formatValidationErrorForClipboard, formatZodIssues, generateCurl, generateCurlFromError, getAuthToken, getErrorContent, useErrors };