@fgv/ts-sudoku-ui 5.1.0-2 → 5.1.0-21

package/dist/ts-sudoku-ui.d.ts

@@ -1,668 +0,0 @@
-import { CellId } from '@fgv/ts-sudoku-lib';
-import { ICage } from '@fgv/ts-sudoku-lib';
-import { ICellContents } from '@fgv/ts-sudoku-lib';
-import { IPuzzleDefinition } from '@fgv/ts-sudoku-lib';
-import { Logging } from '@fgv/ts-utils';
-import { NavigationDirection } from '@fgv/ts-sudoku-lib';
-import { NavigationWrap } from '@fgv/ts-sudoku-lib';
-import { PuzzleSession } from '@fgv/ts-sudoku-lib';
-import { default as React_2 } from 'react';
-import { ReactNode } from 'react';
-import { Result } from '@fgv/ts-utils';
-
-/**
- * Component for rendering cage boundaries and sum indicators in Killer Sudoku
- * @public
- */
-export declare const CageOverlay: React_2.FC<ICageOverlayProps>;
-
-/**
- * Component for displaying the target sum of a cage in Killer Sudoku
- * @public
- */
-export declare const CageSumIndicator: React_2.FC<ICageSumIndicatorProps>;
-
-/**
- * Individual combination card component with toggle functionality
- * @public
- */
-export declare const CombinationCard: React_2.NamedExoticComponent<ICombinationCardProps>;
-
-/**
- * Grid layout component for displaying combination cards
- * @public
- */
-export declare const CombinationGrid: React_2.FC<ICombinationGridProps>;
-
-/**
- * Compact control ribbon with icon-only badges for actions and status indicator
- * @public
- */
-export declare const CompactControlRibbon: React_2.FC<ICompactControlRibbonProps>;
-
-/**
- * Default diagnostic logger (no-op for production).
- * @public
- */
-export declare const DefaultDiagnosticLogger: Logging.LogReporter<unknown>;
-
-/**
- * Device type detection result
- * @public
- */
-export declare type DeviceType = 'mobile' | 'tablet' | 'desktop';
-
-/**
- * React context for diagnostic logging.
- * Provides access to diagnostic logger throughout the component tree.
- * @public
- */
-export declare const DiagnosticLoggerContext: React_2.Context<Logging.LogReporter<unknown>>;
-
-/**
- * Provider component that makes diagnostic logger available to all child components.
- *
- * @example
- * ```tsx
- * // Basic usage with default no-op logger
- * <DiagnosticLoggerProvider>
- *   <SudokuGrid />
- * </DiagnosticLoggerProvider>
- *
- * // Console logging for development
- * const consoleLogger = new Logging.LogReporter({
- *   logger: new Logging.ConsoleLogger('info')
- * });
- * <DiagnosticLoggerProvider logger={consoleLogger}>
- *   <SudokuGrid />
- * </DiagnosticLoggerProvider>
- *
- * // In-memory logger for tests
- * const testLogger = new Logging.LogReporter({
- *   logger: new Logging.InMemoryLogger('detail')
- * });
- * <DiagnosticLoggerProvider logger={testLogger}>
- *   <SudokuGrid />
- * </DiagnosticLoggerProvider>
- * ```
- *
- * @param props - Provider configuration
- * @returns JSX provider element
- * @public
- */
-export declare const DiagnosticLoggerProvider: React_2.FC<IDiagnosticLoggerProviderProps>;
-
-/**
- * Dual keypad component with responsive layout for mobile and desktop sudoku input
- * @public
- */
-export declare const DualKeypad: React_2.FC<IDualKeypadProps>;
-
-/**
- * Display information for a cage in Killer Sudoku
- * @public
- */
-export declare interface ICageDisplayInfo {
-    readonly cage: ICage;
-    readonly isHighlighted: boolean;
-    readonly currentSum?: number;
-    readonly isComplete: boolean;
-    readonly isValid: boolean;
-}
-
-/**
- * Props for the CageOverlay component
- * @public
- */
-export declare interface ICageOverlayProps {
-    readonly cages: ICageDisplayInfo[];
-    readonly gridSize: {
-        width: number;
-        height: number;
-    };
-    readonly cellSize: number;
-    readonly numRows?: number;
-    readonly numColumns?: number;
-    readonly className?: string;
-}
-
-/**
- * Props for the CageSumIndicator component
- * @public
- */
-export declare interface ICageSumIndicatorProps {
-    readonly cage: ICage;
-    readonly currentSum?: number;
-    readonly isComplete: boolean;
-    readonly isValid: boolean;
-    readonly position: {
-        top: number;
-        left: number;
-    };
-    readonly className?: string;
-}
-
-/**
- * Display information for a single cell
- * @public
- */
-export declare interface ICellDisplayInfo {
-    readonly id: CellId;
-    readonly row: number;
-    readonly column: number;
-    readonly contents: ICellContents;
-    readonly isImmutable: boolean;
-    readonly hasValidationError: boolean;
-}
-
-/**
- * Props for the CombinationCard component
- * @public
- */
-export declare interface ICombinationCardProps {
-    readonly combination: ICombinationDisplayInfo;
-    readonly onToggle: (signature: string) => void;
-    readonly className?: string;
-}
-
-/**
- * Display information for a single combination
- * @public
- */
-export declare interface ICombinationDisplayInfo {
-    readonly combination: number[];
-    readonly signature: string;
-    readonly isEliminated: boolean;
-}
-
-/**
- * Props for the CombinationGrid component
- * @public
- */
-export declare interface ICombinationGridProps {
-    readonly combinations: ICombinationDisplayInfo[];
-    readonly onToggle: (signature: string) => void;
-    readonly mode: IKillerCombinationsMode;
-    readonly className?: string;
-}
-
-/**
- * Props for the CompactControlRibbon component
- * @public
- */
-export declare interface ICompactControlRibbonProps {
-    /** Whether undo is available */
-    readonly canUndo: boolean;
-    /** Whether redo is available */
-    readonly canRedo: boolean;
-    /** Whether reset is available */
-    readonly canReset: boolean;
-    /** Whether the puzzle is valid */
-    readonly isValid: boolean;
-    /** Whether the puzzle is solved */
-    readonly isSolved: boolean;
-    /** Validation errors for error count display */
-    readonly validationErrors: ReadonlyArray<{
-        readonly type: string;
-        readonly cellId: string;
-        readonly message: string;
-    }>;
-    /** Callback for undo action */
-    readonly onUndo: () => void;
-    /** Callback for redo action */
-    readonly onRedo: () => void;
-    /** Callback for reset action */
-    readonly onReset: () => void;
-    /** Callback for export action */
-    readonly onExport: () => void;
-    /** Whether to show combinations button (for killer sudoku) */
-    readonly showCombinations?: boolean;
-    /** Whether combinations button should be enabled */
-    readonly canShowCombinations?: boolean;
-    /** Callback for combinations action */
-    readonly onCombinations?: () => void;
-    /** Additional CSS class name */
-    readonly className?: string;
-}
-
-/**
- * Props for the DiagnosticLoggerProvider component.
- * @public
- */
-export declare interface IDiagnosticLoggerProviderProps {
-    /** Child components that will have access to the diagnostic logger */
-    children: ReactNode;
-    /** Optional logger to provide (defaults to no-op logger) */
-    logger?: Logging.LogReporter<unknown>;
-}
-
-/**
- * Props for the DualKeypad component
- * @public
- */
-export declare interface IDualKeypadProps {
-    /** Current input mode */
-    readonly inputMode: InputMode;
-    /** Callback when input mode changes */
-    readonly onInputModeChange: (mode: InputMode) => void;
-    /** Callback when a number is pressed for notes */
-    readonly onNotePress: (number: number) => void;
-    /** Callback when a number is pressed for values */
-    readonly onValuePress: (number: number) => void;
-    /** Callback when clear notes is pressed */
-    readonly onClearNotes: () => void;
-    /** Callback when clear values is pressed */
-    readonly onClearValues: () => void;
-    /** Whether any cells are selected */
-    readonly hasCellSelection: boolean;
-    /** Number of selected cells */
-    readonly selectedCellCount: number;
-    /** Whether the keypad is disabled */
-    readonly disabled?: boolean;
-    /** Additional CSS class name */
-    readonly className?: string;
-    /** Force a specific layout mode (overrides responsive detection) */
-    readonly forceLayoutMode?: KeypadLayoutMode;
-    /** Whether to show the overlay toggle for desktop */
-    readonly showOverlayToggle?: boolean;
-}
-
-/**
- * State management for combination elimination
- * @public
- */
-export declare interface IEliminationState {
-    readonly eliminatedSignatures: Set<string>;
-    readonly toggleElimination: (signature: string) => void;
-    readonly clearAll: () => void;
-}
-
-/**
- * Options for keyboard shortcut configuration
- * @public
- */
-export declare interface IKeyboardShortcutOptions {
-    readonly ctrl?: boolean;
-    readonly meta?: boolean;
-    readonly shift?: boolean;
-    readonly preventDefault?: boolean;
-}
-
-/**
- * Props for the KillerCombinationsExplorer component
- * @public
- */
-export declare interface IKillerCombinationsExplorerProps {
-    readonly selectedCage: ICage | null;
-    readonly puzzleId?: string;
-    readonly isOpen: boolean;
-    readonly onClose: () => void;
-    readonly mobileBreakpoint?: number;
-    readonly className?: string;
-}
-
-/**
- * Props for the KillerCombinationsModal component
- */
-declare interface IKillerCombinationsModalProps {
-    readonly cage: ICage;
-    readonly combinations: ICombinationDisplayInfo[];
-    readonly onToggle: (signature: string) => void;
-    readonly onClose: () => void;
-    readonly isOpen: boolean;
-    readonly className?: string;
-}
-
-/**
- * Display mode for killer combinations explorer
- * @public
- */
-export declare type IKillerCombinationsMode = 'panel' | 'modal';
-
-/**
- * Props for the KillerCombinationsPanel component
- */
-declare interface IKillerCombinationsPanelProps {
-    readonly cage: ICage;
-    readonly combinations: ICombinationDisplayInfo[];
-    readonly onToggle: (signature: string) => void;
-    readonly onClose: () => void;
-    readonly isOpen: boolean;
-    readonly className?: string;
-}
-
-/**
- * Input mode for cell interactions
- * @public
- */
-declare type InputMode = 'value' | 'notes';
-
-/**
- * Props for the NumberKeypad component
- * @public
- */
-export declare interface INumberKeypadProps {
-    /** Type of keypad - affects styling and behavior */
-    readonly keypadType: 'notes' | 'values';
-    /** Current input mode */
-    readonly inputMode: InputMode;
-    /** Whether this keypad is currently active */
-    readonly isActive: boolean;
-    /** Callback when a number is pressed */
-    readonly onNumberPress: (number: number) => void;
-    /** Callback when clear is pressed */
-    readonly onClear: () => void;
-    /** Whether the keypad is disabled */
-    readonly disabled?: boolean;
-    /** Additional CSS class name */
-    readonly className?: string;
-    /** Compact mode for smaller screens */
-    readonly compact?: boolean;
-}
-
-/**
- * Responsive layout information
- * @public
- */
-export declare interface IResponsiveLayoutInfo {
-    /** Device type based on screen size and touch capability */
-    readonly deviceType: DeviceType;
-    /** Current screen orientation */
-    readonly orientation: ScreenOrientation_2;
-    /** Recommended keypad layout mode */
-    readonly keypadLayoutMode: KeypadLayoutMode;
-    /** Screen width in pixels */
-    readonly screenWidth: number;
-    /** Screen height in pixels */
-    readonly screenHeight: number;
-    /** Whether touch is supported */
-    readonly isTouchDevice: boolean;
-    /** Whether the screen is considered small */
-    readonly isSmallScreen: boolean;
-    /** Whether the screen has enough space for dual keypads */
-    readonly hasSpaceForDualKeypads: boolean;
-}
-
-/**
- * Props for the SudokuCell component
- * @public
- */
-export declare interface ISudokuCellProps {
-    readonly cellInfo: ICellDisplayInfo;
-    readonly isSelected: boolean;
-    readonly inputMode: InputMode;
-    readonly puzzleDimensions?: {
-        readonly numRows: number;
-        readonly numColumns: number;
-        readonly cageHeight: number;
-        readonly cageWidth: number;
-    };
-    readonly onSelect: (event?: React.MouseEvent) => void;
-    readonly onLongPressToggle?: (event: React.TouchEvent | React.MouseEvent) => void;
-    readonly onValueChange: (value: number | undefined) => void;
-    readonly onNoteToggle: (note: number) => void;
-    readonly onClearAllNotes: () => void;
-    readonly onDragOver?: () => void;
-    readonly className?: string;
-}
-
-/**
- * Props for the SudokuControls component
- * @public
- */
-export declare interface ISudokuControlsProps {
-    readonly canUndo: boolean;
-    readonly canRedo: boolean;
-    readonly canReset: boolean;
-    readonly isValid: boolean;
-    readonly isSolved: boolean;
-    readonly onUndo: () => void;
-    readonly onRedo: () => void;
-    readonly onReset: () => void;
-    readonly onExport: () => void;
-    readonly className?: string;
-}
-
-/**
- * Props for the main SudokuGridEntry component
- * @public
- */
-export declare interface ISudokuGridEntryProps {
-    /**
-     * Optional initial puzzle session to load. If not provided, an empty puzzle is created.
-     */
-    readonly initialPuzzleDescription?: IPuzzleDefinition;
-    /**
-     * Callback fired when the puzzle state changes
-     */
-    readonly onStateChange?: (isValid: boolean, isSolved: boolean) => void;
-    /**
-     * Callback fired when validation errors occur
-     */
-    readonly onValidationErrors?: (errors: IValidationError[]) => void;
-    /**
-     * Optional CSS class name for styling
-     */
-    readonly className?: string;
-    /**
-     * Optional forced layout mode for testing (overrides responsive detection)
-     */
-    readonly forceLayoutMode?: KeypadLayoutMode;
-}
-
-/**
- * Props for the SudokuGrid component
- * @public
- */
-export declare interface ISudokuGridProps {
-    readonly numRows: number;
-    readonly numColumns: number;
-    readonly cells: ICellDisplayInfo[];
-    readonly cages?: ICageDisplayInfo[];
-    readonly selectedCell: CellId | null;
-    readonly selectedCells: CellId[];
-    readonly inputMode: InputMode;
-    readonly puzzleType?: string;
-    readonly puzzleDimensions?: {
-        readonly cageHeightInCells: number;
-        readonly cageWidthInCells: number;
-        readonly boardWidthInCages: number;
-        readonly boardHeightInCages: number;
-        readonly totalRows: number;
-        readonly totalColumns: number;
-        readonly maxValue: number;
-        readonly totalCages: number;
-        readonly basicCageTotal: number;
-    };
-    readonly onCellSelect: (cellId: CellId, event?: React.MouseEvent) => void;
-    readonly onLongPressToggle?: (cellId: CellId, event: React.TouchEvent | React.MouseEvent) => void;
-    readonly onCellValueChange: (cellId: CellId, value: number | undefined) => void;
-    readonly onNoteToggle: (cellId: CellId, note: number) => void;
-    readonly onClearAllNotes: (cellId: CellId) => void;
-    readonly onNavigate: (direction: NavigationDirection) => void;
-    readonly onDragOver?: (cellId: CellId) => void;
-    readonly onDragEnd?: () => void;
-    readonly isDragging?: boolean;
-    readonly className?: string;
-}
-
-/**
- * Props for the ValidationDisplay component
- * @public
- */
-export declare interface IValidationDisplayProps {
-    readonly errors: IValidationError[];
-    readonly isValid: boolean;
-    readonly isSolved: boolean;
-    readonly className?: string;
-}
-
-/**
- * Validation error for display in the UI
- * @public
- */
-export declare interface IValidationError {
-    readonly cellId: CellId;
-    readonly type: 'duplicate-row' | 'duplicate-column' | 'duplicate-section' | 'duplicate-diagonal' | 'invalid-value';
-    readonly conflictingCells: CellId[];
-    readonly message: string;
-}
-
-/**
- * Layout mode for dual keypad
- * @public
- */
-export declare type KeypadLayoutMode = 'side-by-side' | 'stacked' | 'overlay' | 'hidden';
-
-/**
- * Main killer combinations explorer container component
- * Automatically switches between panel (desktop) and modal (mobile) based on screen size
- * @public
- */
-export declare const KillerCombinationsExplorer: React_2.FC<IKillerCombinationsExplorerProps>;
-
-/**
- * Mobile modal variant for killer combinations explorer
- * @public
- */
-export declare const KillerCombinationsModal: React_2.FC<IKillerCombinationsModalProps>;
-
-/**
- * Desktop panel variant for killer combinations explorer
- * @public
- */
-export declare const KillerCombinationsPanel: React_2.FC<IKillerCombinationsPanelProps>;
-
-/**
- * Reusable number keypad component for sudoku input
- * @public
- */
-export declare const NumberKeypad: React_2.FC<INumberKeypadProps>;
-
-/**
- * Screen orientation
- * @public
- */
-declare type ScreenOrientation_2 = 'portrait' | 'landscape';
-export { ScreenOrientation_2 as ScreenOrientation }
-
-/**
- * Individual Sudoku cell component with input handling and validation display
- * @public
- */
-export declare const SudokuCell: React_2.FC<ISudokuCellProps>;
-
-/**
- * Control panel for grid-wide operations
- * @public
- */
-export declare const SudokuControls: React_2.FC<ISudokuControlsProps>;
-
-/**
- * Grid component that renders the 9x9 Sudoku grid with proper visual structure
- * @public
- */
-export declare const SudokuGrid: React_2.FC<ISudokuGridProps>;
-
-/**
- * Main container component that orchestrates puzzle entry
- * @public
- */
-export declare const SudokuGridEntry: React_2.FC<ISudokuGridEntryProps>;
-
-/**
- * Hook for managing combination elimination state with session storage persistence
- * @param puzzleId - Unique identifier for the puzzle
- * @param cageId - Unique identifier for the cage
- * @returns Elimination state with toggle and clear operations
- * @public
- */
-export declare function useCombinationElimination(puzzleId: string | undefined, cageId: string | undefined): IEliminationState;
-
-/**
- * Hook to access the current diagnostic logger.
- *
- * Provides access to diagnostic logging for development and debugging.
- *
- * @example
- * ```tsx
- * function CageOverlay({ cages }: ICageOverlayProps) {
- *   const log = useDiagnosticLogger();
- *
- *   useEffect(() => {
- *     log.info('CageOverlay rendered', {
- *       cageCount: cages.length,
- *       cages: cages.map((c) => ({ id: c.cage.id, cellIds: c.cage.cellIds }))
- *     });
- *   }, [cages, log]);
- *
- *   return <div>...</div>;
- * }
- * ```
- *
- * @returns The current diagnostic logger
- * @public
- */
-export declare const useDiagnosticLogger: () => Logging.LogReporter<unknown>;
-
-/**
- * Hook for registering global keyboard shortcuts
- * @param key - The key to listen for (e.g., 'k', 'Escape')
- * @param callback - Function to call when shortcut is activated
- * @param options - Optional modifier keys and behavior
- * @public
- */
-export declare function useKeyboardShortcut(key: string, callback: () => void, options?: IKeyboardShortcutOptions): void;
-
-/**
- * Hook to get all valid killer cage combinations for a selected cage
- * @param cage - The selected killer cage
- * @returns Result containing combination display information
- * @public
- */
-export declare function useKillerCombinations(cage: ICage | null): Result<ICombinationDisplayInfo[]>;
-
-/**
- * Hook for managing puzzle session state and operations
- * @public
- */
-export declare function usePuzzleSession(initialPuzzleDescription?: IPuzzleDefinition): {
-    session: PuzzleSession | null;
-    selectedCell: CellId | null;
-    selectedCells: CellId[];
-    inputMode: InputMode;
-    setSelectedCell: (cell: CellId | null) => void;
-    setSelectedCells: (cells: CellId[]) => void;
-    setInputMode: (mode: InputMode) => void;
-    cellDisplayInfo: ICellDisplayInfo[];
-    cageDisplayInfo: ICageDisplayInfo[];
-    validationErrors: IValidationError[];
-    isValid: boolean;
-    isSolved: boolean;
-    canUndo: boolean;
-    canRedo: boolean;
-    error: string | null;
-    updateCellValue: (cellId: CellId, value: number | undefined) => void;
-    toggleCellNote: (cellId: CellId, note: number) => void;
-    clearCellNotes: (cellId: CellId) => void;
-    navigateToCell: (direction: NavigationDirection, wrap?: NavigationWrap) => void;
-    undo: () => void;
-    redo: () => void;
-    reset: () => void;
-    exportPuzzle: () => IPuzzleDefinition | null;
-};
-
-/**
- * Hook to detect responsive layout information for optimal keypad display
- * @param forceLayoutMode - Optional layout mode override for testing
- * @public
- */
-export declare function useResponsiveLayout(forceLayoutMode?: KeypadLayoutMode): IResponsiveLayoutInfo;
-
-/**
- * Component to display validation errors and puzzle status
- * @public
- */
-export declare const ValidationDisplay: React_2.FC<IValidationDisplayProps>;
-
-export { }