react-chess-replay-trainer 0.0.2 → 0.0.3

package/README.md

@@ -1,44 +1,46 @@
-# react-chess-replay-trainer
-
-A React component for replaying a chess game move-by-move and drilling it.
-
-- **Browse** freely through the game (first / prev / next / last / jump) without
-  recording anything, so you can pick the part of the game you want to study.
-- **Train White / Train Black / Train Both** start a drill at the current ply:
-  you guess each move, and every mistake is reported via `onMiss` so the host can
-  (for example) enroll the missed position into a spaced-repetition deck.
-  - With **Train White** or **Train Black** you only guess that side's moves; the
-    opponent's reply is played automatically after each correct guess, and the
-    board is rotated so the trained side is on the bottom.
-  - With **Train Both** you drill every ply for both colors.
-- **Analyze** opens the built-in analysis board (`AnalysisBoard` from
-  `react-chess-core`) at the current position.
-
-Depends on `react-chess-core` (board, engine, analysis board), `react-chessboard`,
-and `chess.js`.
-
-## Usage
-
-```tsx
-import { ReplayTrainer } from 'react-chess-replay-trainer';
-
-<ReplayTrainer
-  gameId={gameId}
-  startFen={fenWhereUserWasBrowsing}
-  fetchGame={fetchGame}
-  onMiss={(miss) => enrollMissedPosition(miss)}
-  onExit={() => setTraining(null)}
-  theme="dark"
-  engine={{ depth: 18, multiPv: 3 }}
-/>;
-```
-
-For a custom shell, use `useReplayTrainer` with `AnalysisBoard` from the same package:
-
-```tsx
-import {
-  useReplayTrainer,
-  buildReplayAnalysisContext,
-  AnalysisBoard,
-} from 'react-chess-replay-trainer';
-```
+# react-chess-replay-trainer
+
+A React component for replaying a chess game move-by-move and drilling it.
+
+- **Browse** freely through the game (first / prev / next / last / jump) without
+  recording anything, so you can pick the part of the game you want to study.
+- **Train White / Train Black / Train Both** start a drill at the current ply:
+  you guess each move, and every mistake is reported via `onMiss` so the host can
+  (for example) enroll the missed position into a spaced-repetition deck.
+  - With **Train White** or **Train Black** you only guess that side's moves; the
+    opponent's reply is played automatically after each correct guess, and the
+    board is rotated so the trained side is on the bottom.
+  - With **Train Both** you drill every ply for both colors.
+- **Analyze** opens the built-in analysis board (`AnalysisBoard` from
+  `react-chess-core`) at the current position.
+
+Depends on `react-chess-core` (board, engine, analysis board), `react-chessboard`,
+and `chess.js`.
+
+Used in production at [endchess.com](https://endchess.com).
+
+## Usage
+
+```tsx
+import { ReplayTrainer } from 'react-chess-replay-trainer';
+
+<ReplayTrainer
+  gameId={gameId}
+  startFen={fenWhereUserWasBrowsing}
+  fetchGame={fetchGame}
+  onMiss={(miss) => enrollMissedPosition(miss)}
+  onExit={() => setTraining(null)}
+  theme="dark"
+  engine={{ depth: 18, multiPv: 3 }}
+/>;
+```
+
+For a custom shell, use `useReplayTrainer` with `AnalysisBoard` from the same package:
+
+```tsx
+import {
+  useReplayTrainer,
+  buildReplayAnalysisContext,
+  AnalysisBoard,
+} from 'react-chess-replay-trainer';
+```

package/package.json

@@ -1,56 +1,56 @@
-{
-  "name": "react-chess-replay-trainer",
-  "version": "0.0.2",
-  "description": "React component for browsing a chess game and drilling its moves, reporting misses (uses react-chess-core for board and analysis)",
-  "license": "MIT",
-  "author": "Robert Blackwell",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "rollup -c",
-    "prepublishOnly": "npm run build",
-    "storybook": "storybook dev -p 6008",
-    "build-storybook": "storybook build"
-  },
-  "dependencies": {
-    "rollup": "^4.22.2",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "typescript": "^5.6.2"
-  },
-  "peerDependencies": {
-    "chess.js": "^1.0.0-beta.8",
-    "react": "^18.3.1",
-    "react-chess-core": "^0.1.1",
-    "react-chessboard": "^4.7.1"
-  },
-  "devDependencies": {
-    "@chromatic-com/storybook": "^1.9.0",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-typescript": "^12.3.0",
-    "@storybook/addon-essentials": "^8.2.9",
-    "@storybook/addon-interactions": "^8.2.9",
-    "@storybook/addon-links": "^8.2.9",
-    "@storybook/addon-onboarding": "^8.2.9",
-    "@storybook/blocks": "^8.2.9",
-    "@storybook/preset-typescript": "^3.0.0",
-    "@storybook/react": "^8.2.9",
-    "@storybook/react-vite": "^8.2.9",
-    "@storybook/test": "^8.2.9",
-    "@types/react": "^18.3.12",
-    "@types/react-dom": "^18.3.1",
-    "@vitejs/plugin-react": "^4.3.1",
-    "chess.js": "^1.0.0-beta.8",
-    "react": "^18.3.1",
-    "react-chess-core": "^0.1.1",
-    "react-chessboard": "^4.7.1",
-    "react-dom": "^18.3.1",
-    "storybook": "^8.2.9",
-    "tslib": "^2.8.1",
-    "vite-tsconfig-paths": "^5.0.1"
-  }
-}
+{
+  "name": "react-chess-replay-trainer",
+  "version": "0.0.3",
+  "description": "React component for browsing a chess game and drilling its moves, reporting misses (uses react-chess-core for board and analysis)",
+  "license": "MIT",
+  "author": "Robert Blackwell",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "prepublishOnly": "npm run build",
+    "storybook": "storybook dev -p 6008",
+    "build-storybook": "storybook build"
+  },
+  "dependencies": {
+    "rollup": "^4.22.2",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "typescript": "^5.6.2"
+  },
+  "peerDependencies": {
+    "chess.js": "^1.0.0-beta.8",
+    "react": "^18.3.1",
+    "react-chess-core": "^0.1.1",
+    "react-chessboard": "^4.7.1"
+  },
+  "devDependencies": {
+    "@chromatic-com/storybook": "^1.9.0",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@storybook/addon-essentials": "^8.2.9",
+    "@storybook/addon-interactions": "^8.2.9",
+    "@storybook/addon-links": "^8.2.9",
+    "@storybook/addon-onboarding": "^8.2.9",
+    "@storybook/blocks": "^8.2.9",
+    "@storybook/preset-typescript": "^3.0.0",
+    "@storybook/react": "^8.2.9",
+    "@storybook/react-vite": "^8.2.9",
+    "@storybook/test": "^8.2.9",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@vitejs/plugin-react": "^4.3.1",
+    "chess.js": "^1.0.0-beta.8",
+    "react": "^18.3.1",
+    "react-chess-core": "^0.1.1",
+    "react-chessboard": "^4.7.1",
+    "react-dom": "^18.3.1",
+    "storybook": "^8.2.9",
+    "tslib": "^2.8.1",
+    "vite-tsconfig-paths": "^5.0.1"
+  }
+}

package/dist/features/replay/miss/replayMissDisplay.d.ts

@@ -1,16 +0,0 @@
-export type MissSequencePhase = 'wrong' | 'refutation' | 'answer' | 'retry';
-export type MissSequenceState = {
-    setupFen: string;
-    attemptedUci: string;
-    phase: MissSequencePhase;
-};
-export type ReplayMissDisplay = {
-    fen: string | null;
-    arrows: [string, string, string][];
-    animating: boolean;
-};
-export declare const REPLAY_MISS_WRONG_PAUSE_MS = 450;
-export declare const REPLAY_MISS_REFUTATION_PAUSE_MS = 900;
-export declare const REPLAY_MISS_REFUTATION_MAX_WAIT_MS = 4000;
-export declare const REPLAY_MISS_MOVE_ANIMATION_MS = 220;
-export declare function getReplayMissDisplay(sequence: MissSequenceState | null, expectedUci: string | null, refutationUci: string | null, answerArrowColor: string): ReplayMissDisplay;

package/dist/features/replay/miss/useReplayMissBoard.d.ts

@@ -1,28 +0,0 @@
-import type { AnalysisEngineOptions } from 'react-chess-core';
-type ReplayMissFeedback = 'correct' | 'incorrect' | null;
-export declare function useReplayMissBoard({ feedback, expectedUci, positionFen, answerArrowColor, autoShowWrongMoves, engineOptions, }: {
-    feedback: ReplayMissFeedback;
-    expectedUci: string | null;
-    positionFen: string;
-    answerArrowColor: string;
-    autoShowWrongMoves?: boolean;
-    engineOptions?: AnalysisEngineOptions;
-}): {
-    missSequence: {
-        sequence: import("./replayMissDisplay").MissSequenceState | null;
-        refutation: import("..").ReplayRefutationResult;
-        display: import("./replayMissDisplay").ReplayMissDisplay;
-        startSequence: (setupFen: string, attemptedUci: string) => void;
-        clearSequence: () => void;
-    };
-    refutation: import("..").ReplayRefutationResult;
-    customArrows: [string, string, string][];
-    boardPosition: string;
-    boardAnimating: boolean;
-    wrapDropHandler: (onDrop: (source: string, target: string, piece: string) => boolean, { enabled, dropFen, expectedMoveUci, }: {
-        enabled: boolean;
-        dropFen?: string;
-        expectedMoveUci?: string | null;
-    }) => (source: string, target: string, piece: string) => boolean;
-};
-export {};

package/dist/features/replay/miss/useReplayMissSequence.d.ts

@@ -1,10 +0,0 @@
-import type { AnalysisEngineOptions } from 'react-chess-core';
-import { type MissSequencePhase, type MissSequenceState, type ReplayMissDisplay } from './replayMissDisplay';
-export type { MissSequencePhase, ReplayMissDisplay };
-export declare function useReplayMissSequence(feedback: 'correct' | 'incorrect' | null, expectedUci: string | null, engineOptions: AnalysisEngineOptions, answerArrowColor: string, autoShowWrongMoves: boolean): {
-    sequence: MissSequenceState | null;
-    refutation: import("..").ReplayRefutationResult;
-    display: ReplayMissDisplay;
-    startSequence: (setupFen: string, attemptedUci: string) => void;
-    clearSequence: () => void;
-};

package/dist/features/replay/miss/useReplayRefutation.d.ts

@@ -1,3 +0,0 @@
-import { type AnalysisEngineOptions } from 'react-chess-core';
-import { type ReplayRefutationResult } from '../refutation/replayRefutation';
-export declare function useReplayRefutation(setupFen: string | null, attemptedUci: string | null, expectedUci: string | null, enabled: boolean, engineOptions: AnalysisEngineOptions): ReplayRefutationResult;

package/dist/features/replay/refutation/replayRefutation.d.ts

@@ -1,19 +0,0 @@
-import { type AnalysisEngineOptions, type EngineEvaluation, type EngineLine } from 'react-chess-core';
-/** Minimum eval loss (pawns) from the wrong move before showing a refutation. */
-export declare const REPLAY_REFUTATION_EVAL_GAP_PAWNS = 0.5;
-export declare const REPLAY_REFUTATION_EVAL_GAP_CP: number;
-export type ReplayRefutationResult = {
-    fenAfterWrong: string | null;
-    refutationUci: string | null;
-    refutationSan: string | null;
-    refutationLine: string | null;
-    loading: boolean;
-    error: string | null;
-};
-export declare const replayRefutationEngineOptions: AnalysisEngineOptions;
-export declare function fenAfterUci(fen: string, uci: string): string | null;
-/** Centipawn score from side to move, comparable across sibling positions. */
-export declare function lineEvalCpForGap(line: EngineLine | undefined): number | null;
-/** How much better the opponent's eval is after the wrong move vs the correct one. */
-export declare function refutationEvalGapCp(evalAfterWrong: EngineEvaluation, evalAfterCorrect: EngineEvaluation): number | null;
-export declare function refutationFromEvaluation(fenAfterWrong: string, evaluation: EngineEvaluation, evalGapCp: number | null, evalGapApplies: boolean, evalGapLoading: boolean): Omit<ReplayRefutationResult, 'fenAfterWrong'>;