react-chess-core 0.1.1 → 0.1.3

package/README.md

@@ -1,46 +1,48 @@
-# react-chess-core
-
-```bash
-npm install
-npm run build
-```
-
-Shared **chessboard** (theme + `HighlightChessboard`) and **browser Stockfish** utilities. Used by `react-chess-puzzle-kit` and (planned) `react-chess-explorer`.
-
-Storybook: `npm run storybook` → http://localhost:6007
-
----
-
-## Migration phases (Option B)
-
-| Phase | Status | Work |
-|-------|--------|------|
-| **1** | Done | Scaffold package, Rollup, Storybook |
-| **2** | Done | Board + engine source live in this repo |
-| **3** | Done | `react-chess-puzzle-kit` depends on `file:../react-chess-core`, re-export for compatibility |
-| **4** | Done | Remove duplicate shim files from puzzle-kit; slim public API (no core re-exports from puzzle-kit) |
-| **5** | In progress | `react-chess-explorer` scaffold (core only); requirements → `docs/REQUIREMENTS.md` |
-
----
-
-## Install (consumers)
-
-```bash
-npm install react-chess-core
-```
-
-**Peer dependencies:** `react`, `react-chessboard`, `chess.js`
-
-For Stockfish in the browser:
-
-```bash
-npm install stockfish
-npm run copy:stockfish   # in your app, or copy WASM to public/stockfish/
-```
-
----
-
-## Exports
-
-- **Chessboard:** `ThemeProvider`, `useChessboardTheme`, `HighlightChessboard`, `boardSquareHighlightColors`
-- **Engine:** `useAnalysisEngine`, `StockfishBrowserEngine`, `EngineEvaluationPanel`, `isAnalyzableFen`, types/helpers
+# react-chess-core
+
+```bash
+npm install
+npm run build
+```
+
+Shared **chessboard** (theme + `HighlightChessboard`) and **browser Stockfish** utilities. Used by `react-chess-puzzle-kit` and (planned) `react-chess-explorer`.
+
+Used in production at [endchess.com](https://endchess.com).
+
+Storybook: `npm run storybook` → http://localhost:6007
+
+---
+
+## Migration phases (Option B)
+
+| Phase | Status | Work |
+|-------|--------|------|
+| **1** | Done | Scaffold package, Rollup, Storybook |
+| **2** | Done | Board + engine source live in this repo |
+| **3** | Done | `react-chess-puzzle-kit` depends on `file:../react-chess-core`, re-export for compatibility |
+| **4** | Done | Remove duplicate shim files from puzzle-kit; slim public API (no core re-exports from puzzle-kit) |
+| **5** | In progress | `react-chess-explorer` scaffold (core only); requirements → `docs/REQUIREMENTS.md` |
+
+---
+
+## Install (consumers)
+
+```bash
+npm install react-chess-core
+```
+
+**Peer dependencies:** `react`, `react-chessboard`, `chess.js`
+
+For Stockfish in the browser:
+
+```bash
+npm install stockfish
+npm run copy:stockfish   # in your app, or copy WASM to public/stockfish/
+```
+
+---
+
+## Exports
+
+- **Chessboard:** `ThemeProvider`, `useChessboardTheme`, `HighlightChessboard`, `boardSquareHighlightColors`
+- **Engine:** `useAnalysisEngine`, `StockfishBrowserEngine`, `EngineEvaluationPanel`, `isAnalyzableFen`, types/helpers

package/dist/features/chessboard/ChessboardDnDProvider.d.ts

@@ -1,4 +1,9 @@
 import type { ReactNode } from 'react';
+/**
+ * HTML5 for mouse (desktop + Chrome device emulation), touch backend for real
+ * mobile devices. react-chessboard alone picks TouchBackend whenever
+ * `ontouchstart` is in window, which breaks mouse drags in DevTools emulation.
+ */
 export declare const ChessboardDnDProvider: ({ children, }: {
     children: ReactNode;
 }) => import("react").JSX.Element;

package/dist/features/chessboard/CorrectMoveCheckBadge.d.ts

@@ -0,0 +1,3 @@
+/** Green circle with a white check, anchored to the bottom-right of a square
+ *  square (over the piece). */
+export declare const CorrectMoveCheckBadge: () => import("react").JSX.Element;

package/dist/features/chessboard/HighlightChessboard.d.ts

@@ -2,6 +2,10 @@ export interface HighlightChessboardProps {
     checkSquare: string;
     hintSquare: string | null;
     incorrectMoveSquare: string | null;
+    /** Destination square of the last correct training move — shows a green check. */
+    correctMoveSquare?: string | null;
+    /** Enable click-to-move when `onPieceDrop` is provided. Defaults to true. */
+    clickToMove?: boolean;
     [key: string]: any;
 }
-export declare const HighlightChessboard: ({ checkSquare, hintSquare, incorrectMoveSquare, customSquareStyles: extraSquareStyles, ...props }: HighlightChessboardProps) => import("react").JSX.Element;
+export declare const HighlightChessboard: ({ checkSquare, hintSquare, incorrectMoveSquare, correctMoveSquare, clickToMove, customSquareStyles: extraSquareStyles, customBoardStyle, onPieceDrop, position, arePiecesDraggable, autoPromoteToQueen, isDraggablePiece, onPromotionCheck, onSquareClick, onPromotionPieceSelect, onPieceDragBegin, showPromotionDialog: showPromotionDialogProp, promotionToSquare: promotionToSquareProp, ...props }: HighlightChessboardProps) => import("react").JSX.Element;

package/dist/features/chessboard/boardSquareHighlightColors.d.ts

@@ -6,4 +6,7 @@ export declare const boardSquareHighlightColors: {
     readonly hint: "rgba(119, 177, 212, 0.75)";
     /** Muted red — softer than the in-check highlight. */
     readonly incorrect: "rgba(140, 38, 38, 0.82)";
+    readonly selected: "rgba(255, 255, 0, 0.45)";
+    readonly moveTarget: "radial-gradient(circle, rgba(0, 0, 0, 0.18) 22%, transparent 22%)";
+    readonly captureTarget: "radial-gradient(circle, rgba(0, 0, 0, 0.18) 72%, transparent 72%)";
 };

package/dist/features/chessboard/createFeedbackSquareRenderer.d.ts

@@ -0,0 +1,3 @@
+import type { FC } from 'react';
+import type { CustomSquareProps } from 'react-chessboard/dist/chessboard/types';
+export declare function createFeedbackSquareRenderer(correctMoveSquare: string): FC<CustomSquareProps>;

package/dist/features/chessboard/index.d.ts

@@ -2,4 +2,5 @@ export * from './boardThemes';
 export * from './chessboardTheme';
 export * from './ChessboardDnDProvider';
 export * from './HighlightChessboard';
+export * from './CorrectMoveCheckBadge';
 export * from './boardSquareHighlightColors';

package/dist/features/chessboard/useClickToMove.d.ts

@@ -0,0 +1,28 @@
+import { type Square } from 'chess.js';
+import { type CSSProperties } from 'react';
+type Piece = string;
+export type ClickToMoveSquareStyles = Record<string, CSSProperties>;
+export type UseClickToMoveOptions = {
+    enabled: boolean;
+    position: string | undefined;
+    arePiecesDraggable?: boolean;
+    autoPromoteToQueen?: boolean;
+    isDraggablePiece?: (args: {
+        piece: Piece;
+        sourceSquare: Square;
+    }) => boolean;
+    onPromotionCheck?: (sourceSquare: Square, targetSquare: Square, piece: Piece) => boolean;
+    onPieceDrop?: (sourceSquare: Square, targetSquare: Square, piece: Piece) => boolean;
+    onSquareClick?: (square: Square, piece: Piece | undefined) => void;
+    onPromotionPieceSelect?: (piece?: Piece, promoteFromSquare?: Square, promoteToSquare?: Square) => boolean;
+    onPieceDragBegin?: (piece: Piece, sourceSquare: Square) => void;
+};
+export declare function useClickToMove({ enabled, position, arePiecesDraggable, autoPromoteToQueen, isDraggablePiece, onPromotionCheck, onPieceDrop, onSquareClick, onPromotionPieceSelect, onPieceDragBegin, }: UseClickToMoveOptions): {
+    clickSquareStyles: ClickToMoveSquareStyles;
+    handleSquareClick: (square: Square, piece: Piece | undefined) => void;
+    handlePromotionPieceSelect: (piece?: Piece, promoteFromSquare?: Square, promoteToSquare?: Square) => boolean;
+    handlePieceDragBegin: (piece: Piece, sourceSquare: Square) => void;
+    showPromotionDialog: boolean;
+    promotionToSquare: Square | null;
+};
+export {};

package/dist/features/training/correctMoveFeedbackMs.d.ts

@@ -0,0 +1,2 @@
+/** Pause (ms) to show the correct-move check before advancing the line. */
+export declare const CORRECT_MOVE_FEEDBACK_MS = 450;

package/dist/features/training/index.d.ts

@@ -1,4 +1,6 @@
 export * from './uciFromDrop';
 export * from './expectedMoveDrop';
 export * from './useBoardRevision';
+export * from './correctMoveFeedbackMs';
+export * from './useCorrectMoveFeedback';
 export * from './miss';

package/dist/features/training/useCorrectMoveFeedback.d.ts

@@ -0,0 +1,6 @@
+export declare function useCorrectMoveFeedback(delayMs?: number): {
+    correctMoveSquare: string | null;
+    showCorrectMove: (targetSquare: string, onComplete?: () => void) => void;
+    clearCorrectMoveFeedback: () => void;
+    isShowingCorrectMove: boolean;
+};