@react-chess-tools/react-chess-puzzle 0.1.4 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @react-chess-tools/react-chess-puzzle
+
+## 0.2.0
+
+### Minor Changes
+
+- ea0eafb: Add changesets versioning
+  setup `changesets` and created the first changeset for the available packages. Removed release-it
+
+### Patch Changes
+
+- Updated dependencies [ea0eafb]
+  - @react-chess-tools/react-chess-game@0.2.0

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@react-chess-tools/react-chess-puzzle",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "A lightweight, customizable React component library for rendering and interacting with chess puzzles.",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.mts",
   "scripts": {
     "build": "tsup src/index.ts",
-    "release": "npm run build && release-it --npm.publish=true",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
@@ -33,7 +32,7 @@
   "author": "Daniele Cammareri <daniele.cammareri@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@react-chess-tools/react-chess-game": "0.1.4",
+    "@react-chess-tools/react-chess-game": "0.2.0",
     "chess.js": "^1.0.0-beta.6",
     "lodash": "^4.17.21"
   },

package/src/components/ChessPuzzle/ChessPuzzle.stories.tsx

@@ -0,0 +1,85 @@
+import type { Meta } from "@storybook/react";
+
+import React from "react";
+import { RootProps } from "./parts/Root";
+import { ChessPuzzle } from ".";
+
+const puzzles = [
+  {
+    fen: "4kb1r/p2r1ppp/4qn2/1B2p1B1/4P3/1Q6/PPP2PPP/2KR4 w k - 0 1",
+    moves: ["Bxd7+", "Nxd7", "Qb8+", "Nxb8", "Rd8#"],
+    makeFirstMove: false,
+  },
+  {
+    fen: "6k1/5p1p/p1q1p1p1/1pB1P3/1Pr3Pn/P4P1P/4Q3/3R2K1 b - - 0 31",
+    moves: ["h4f3", "e2f3", "c4c5", "d1d8", "g8g7", "f3f6"],
+    makeFirstMove: true,
+  },
+];
+
+// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction
+const meta = {
+  title: "react-chess-puzzle/Components/Puzzle",
+  component: ChessPuzzle.Root,
+  tags: ["components", "puzzle"],
+  argTypes: {
+    onSolve: { action: "onSolve" },
+    onFail: { action: "onFail" },
+  },
+  parameters: {
+    actions: { argTypesRegex: "^_on.*" },
+  },
+  decorators: [
+    (Story) => (
+      <div style={{ width: "400px" }}>
+        {/* 👇 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it  */}
+        <Story />
+      </div>
+    ),
+  ],
+} satisfies Meta<typeof ChessPuzzle.Root>;
+
+export default meta;
+
+// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
+
+export const Example = (args: RootProps) => {
+  const [puzzleIndex, setPuzzleIndex] = React.useState(0);
+  const puzzle = puzzles[puzzleIndex];
+  return (
+    <div>
+      <ChessPuzzle.Root {...args} puzzle={puzzle}>
+        <ChessPuzzle.Board />
+        <ChessPuzzle.Reset asChild>
+          <button>restart</button>
+        </ChessPuzzle.Reset>
+        <ChessPuzzle.Reset
+          asChild
+          puzzle={puzzles[(puzzleIndex + 1) % puzzles.length]}
+          onReset={() => setPuzzleIndex((puzzleIndex + 1) % puzzles.length)}
+        >
+          <button>next</button>
+        </ChessPuzzle.Reset>
+        <ChessPuzzle.Hint>hint</ChessPuzzle.Hint>
+      </ChessPuzzle.Root>
+    </div>
+  );
+};
+
+export const Underpromotion = (args: RootProps) => {
+  const puzzle = {
+    fen: "8/8/5R1p/8/3pb1P1/kpKp4/8/8 w - - 0 54",
+    moves: ["c3d4", "d3d2", "d4c3", "d2d1n"],
+    makeFirstMove: true,
+  };
+  return (
+    <div>
+      <ChessPuzzle.Root {...args} puzzle={puzzle}>
+        <ChessPuzzle.Board />
+        <ChessPuzzle.Reset asChild>
+          <button>done! Restart</button>
+        </ChessPuzzle.Reset>
+      </ChessPuzzle.Root>
+    </div>
+  );
+};

package/src/components/ChessPuzzle/index.ts

@@ -0,0 +1,11 @@
+import { Root } from "./parts/Root";
+import { PuzzleBoard } from "./parts/PuzzleBoard";
+import { Reset } from "./parts/Reset";
+import { Hint } from "./parts/Hint";
+
+export const ChessPuzzle = {
+  Root,
+  Board: PuzzleBoard,
+  Reset,
+  Hint,
+};

package/src/components/ChessPuzzle/parts/Hint.tsx

@@ -0,0 +1,46 @@
+import React from "react";
+import { Status, isClickableElement } from "../../../utils";
+import { useChessPuzzleContext } from "../../..";
+
+export interface HintProps {
+  asChild?: boolean;
+  showOn?: Status[];
+}
+
+const defaultShowOn: Status[] = ["not-started", "in-progress"];
+
+export const Hint: React.FC<React.PropsWithChildren<HintProps>> = ({
+  children,
+  asChild,
+  showOn = defaultShowOn,
+}) => {
+  const puzzleContext = useChessPuzzleContext();
+  if (!puzzleContext) {
+    throw new Error("PuzzleContext not found");
+  }
+  const { onHint, status } = puzzleContext;
+  const handleClick = () => {
+    onHint();
+  };
+
+  if (!showOn.includes(status)) {
+    return null;
+  }
+
+  if (asChild) {
+    const child = React.Children.only(children);
+    if (isClickableElement(child)) {
+      return React.cloneElement(child, {
+        onClick: handleClick,
+      });
+    } else {
+      throw new Error("Change child must be a clickable element");
+    }
+  }
+
+  return (
+    <button type="button" onClick={handleClick}>
+      {children}
+    </button>
+  );
+};

package/src/components/ChessPuzzle/parts/PuzzleBoard.tsx

@@ -0,0 +1,37 @@
+import React from "react";
+import {
+  ChessGame,
+  useChessGameContext,
+} from "@react-chess-tools/react-chess-game";
+import { getCustomSquareStyles, stringToMove } from "../../../utils";
+import { useChessPuzzleContext } from "../../..";
+
+export interface PuzzleBoardProps
+  extends React.ComponentProps<typeof ChessGame.Board> {}
+export const PuzzleBoard: React.FC<PuzzleBoardProps> = ({ ...rest }) => {
+  const puzzleContext = useChessPuzzleContext();
+  const gameContext = useChessGameContext();
+
+  if (!puzzleContext) {
+    throw new Error("PuzzleContext not found");
+  }
+  if (!gameContext) {
+    throw new Error("ChessGameContext not found");
+  }
+
+  const { game } = gameContext;
+  const { status, hint, isPlayerTurn, nextMove } = puzzleContext;
+
+  return (
+    <ChessGame.Board
+      customSquareStyles={getCustomSquareStyles(
+        status,
+        hint,
+        isPlayerTurn,
+        game,
+        stringToMove(game, nextMove),
+      )}
+      {...rest}
+    />
+  );
+};

package/src/components/ChessPuzzle/parts/Reset.tsx

@@ -0,0 +1,51 @@
+import React from "react";
+import { isClickableElement, type Puzzle, type Status } from "../../../utils";
+import { useChessPuzzleContext } from "../../..";
+
+export interface ResetProps {
+  asChild?: boolean;
+  puzzle?: Puzzle;
+  onReset?: () => void;
+  showOn?: Status[];
+}
+
+const defaultShowOn: Status[] = ["failed", "solved"];
+
+export const Reset: React.FC<React.PropsWithChildren<ResetProps>> = ({
+  children,
+  asChild,
+  puzzle,
+  onReset,
+  showOn = defaultShowOn,
+}) => {
+  const puzzleContext = useChessPuzzleContext();
+  if (!puzzleContext) {
+    throw new Error("PuzzleContext not found");
+  }
+  const { changePuzzle, status } = puzzleContext;
+  const handleClick = () => {
+    changePuzzle(puzzle || puzzleContext.puzzle);
+    onReset?.();
+  };
+
+  if (!showOn.includes(status)) {
+    return null;
+  }
+
+  if (asChild) {
+    const child = React.Children.only(children);
+    if (isClickableElement(child)) {
+      return React.cloneElement(child, {
+        onClick: handleClick,
+      });
+    } else {
+      throw new Error("Change child must be a clickable element");
+    }
+  }
+
+  return (
+    <button type="button" onClick={handleClick}>
+      {children}
+    </button>
+  );
+};

package/src/components/ChessPuzzle/parts/Root.tsx

@@ -0,0 +1,41 @@
+import React from "react";
+import { Puzzle, getOrientation } from "../../../utils";
+import { useChessPuzzle } from "../../../hooks/useChessPuzzle";
+import { ChessGame } from "@react-chess-tools/react-chess-game";
+import { ChessPuzzleContext } from "../../../hooks/useChessPuzzleContext";
+
+export interface RootProps {
+  puzzle: Puzzle;
+  onSolve?: (changePuzzle: (puzzle: Puzzle) => void) => void;
+  onFail?: (changePuzzle: (puzzle: Puzzle) => void) => void;
+}
+
+const PuzzleRoot: React.FC<React.PropsWithChildren<RootProps>> = ({
+  puzzle,
+  onSolve,
+  onFail,
+  children,
+}) => {
+  const context = useChessPuzzle(puzzle, onSolve, onFail);
+
+  return (
+    <ChessPuzzleContext.Provider value={context}>
+      {children}
+    </ChessPuzzleContext.Provider>
+  );
+};
+
+export const Root: React.FC<React.PropsWithChildren<RootProps>> = ({
+  puzzle,
+  onSolve,
+  onFail,
+  children,
+}) => {
+  return (
+    <ChessGame.Root fen={puzzle.fen} orientation={getOrientation(puzzle)}>
+      <PuzzleRoot puzzle={puzzle} onSolve={onSolve} onFail={onFail}>
+        {children}
+      </PuzzleRoot>
+    </ChessGame.Root>
+  );
+};

package/src/hooks/reducer.ts

@@ -0,0 +1,160 @@
+import { Chess, Move } from "chess.js";
+import { useChessGame } from "@react-chess-tools/react-chess-game";
+import { getOrientation, type Puzzle, type Hint, type Status } from "../utils";
+
+export type State = {
+  puzzle: Puzzle;
+  currentMoveIndex: number;
+  status: Status;
+  nextMove?: string | null;
+  hint: Hint;
+  needCpuMove: boolean;
+  isPlayerTurn: boolean;
+};
+
+export type Action =
+  | {
+      type: "INITIALIZE";
+      payload: {
+        puzzle: Puzzle;
+        setPosition: ReturnType<typeof useChessGame>["methods"]["setPosition"];
+      };
+    }
+  | {
+      type: "RESET";
+      payload: {
+        setPosition: ReturnType<typeof useChessGame>["methods"]["setPosition"];
+      };
+    }
+  | { type: "TOGGLE_HINT" }
+  | {
+      type: "CPU_MOVE";
+      payload: {
+        makeMove?: ReturnType<typeof useChessGame>["methods"]["makeMove"];
+      };
+    }
+  | {
+      type: "PLAYER_MOVE";
+      payload: {
+        move?: Move | null;
+        onSolve?: (changePuzzle: (puzzle: Puzzle) => void) => void;
+        onFail?: (changePuzzle: (puzzle: Puzzle) => void) => void;
+        changePuzzle: (puzzle: Puzzle) => void;
+        game: Chess;
+      };
+    };
+
+export const initializePuzzle = ({
+  puzzle,
+  setPosition,
+}: {
+  puzzle: Puzzle;
+  setPosition: ReturnType<typeof useChessGame>["methods"]["setPosition"];
+}): State => {
+  setPosition(puzzle.fen, getOrientation(puzzle));
+  return {
+    puzzle,
+    currentMoveIndex: 0,
+    status: "not-started",
+    nextMove: puzzle.moves[0],
+    hint: "none",
+    needCpuMove: !!puzzle.makeFirstMove,
+    isPlayerTurn: !puzzle.makeFirstMove,
+  };
+};
+
+export const reducer = (state: State, action: Action): State => {
+  switch (action.type) {
+    case "INITIALIZE":
+      return {
+        ...state,
+        ...initializePuzzle(action.payload),
+      };
+    case "RESET":
+      return {
+        ...state,
+        ...initializePuzzle({
+          puzzle: state.puzzle,
+          setPosition: action.payload.setPosition,
+        }),
+      };
+    case "TOGGLE_HINT":
+      if (state.hint === "none") {
+        return { ...state, hint: "piece" };
+      }
+      return { ...state, hint: "move" };
+    case "CPU_MOVE":
+      if (state.isPlayerTurn) {
+        return state;
+      }
+      if (["solved", "failed"].includes(state.status)) {
+        return state;
+      }
+
+      if (state.nextMove) {
+        action.payload.makeMove?.(state.nextMove);
+      }
+
+      return {
+        ...state,
+        currentMoveIndex: state.currentMoveIndex + 1,
+        nextMove:
+          state.currentMoveIndex < state.puzzle.moves.length - 1
+            ? state.puzzle.moves[state.currentMoveIndex + 1]
+            : null,
+        needCpuMove: false,
+        isPlayerTurn: true,
+        status: "in-progress",
+      };
+
+    case "PLAYER_MOVE": {
+      const { move, onSolve, onFail, changePuzzle } = action.payload;
+
+      const isMoveRight = [move?.san, move?.lan].includes(
+        state?.nextMove || "",
+      );
+      const isPuzzleSolved =
+        state.currentMoveIndex === state.puzzle.moves.length - 1;
+
+      if (!isMoveRight) {
+        if (onFail) {
+          onFail(changePuzzle);
+        }
+        return {
+          ...state,
+          status: "failed",
+          nextMove: null,
+          hint: "none",
+          isPlayerTurn: false,
+        };
+      }
+
+      if (isPuzzleSolved) {
+        if (onSolve) {
+          onSolve(changePuzzle);
+        }
+
+        return {
+          ...state,
+          status: "solved",
+          nextMove: null,
+          hint: "none",
+          isPlayerTurn: false,
+        };
+      }
+
+      return {
+        ...state,
+        hint: "none",
+        currentMoveIndex: state.currentMoveIndex + 1,
+        nextMove: state.puzzle.moves[state.currentMoveIndex + 1],
+        status: "in-progress",
+        needCpuMove: true,
+        isPlayerTurn: false,
+      };
+    }
+
+    default:
+      return state;
+  }
+};

package/src/hooks/useChessPuzzle.ts

@@ -0,0 +1,85 @@
+import { useEffect, useReducer } from "react";
+import { initializePuzzle, reducer } from "./reducer";
+import { type Puzzle } from "../utils";
+import { useChessGameContext } from "@react-chess-tools/react-chess-game";
+
+export const useChessPuzzle = (
+  puzzle: Puzzle,
+  onSolve?: (changePuzzle: (puzzle: Puzzle) => void) => void,
+  onFail?: (changePuzzle: (puzzle: Puzzle) => void) => void,
+) => {
+  const gameContext = useChessGameContext();
+
+  const [state, dispatch] = useReducer(
+    reducer,
+    { puzzle, setPosition: gameContext?.methods.setPosition ?? (() => {}) },
+    initializePuzzle,
+  );
+
+  const {
+    game,
+    methods: { makeMove, setPosition },
+  } = gameContext;
+
+  useEffect(() => {
+    if (gameContext && game.fen() === puzzle.fen && state.needCpuMove) {
+      setTimeout(
+        () =>
+          dispatch({
+            type: "CPU_MOVE",
+            payload: {
+              makeMove,
+            },
+          }),
+        0,
+      );
+    }
+  }, [gameContext, state.needCpuMove]);
+
+  if (!gameContext) {
+    throw new Error("useChessPuzzle must be used within a ChessGameContext");
+  }
+
+  const changePuzzle = (puzzle: Puzzle) => {
+    dispatch({ type: "INITIALIZE", payload: { puzzle, setPosition } });
+  };
+
+  useEffect(() => {
+    if (game?.history()?.length <= 0 + (puzzle.makeFirstMove ? 1 : 0)) {
+      return;
+    }
+    if (game.history().length % 2 === (puzzle.makeFirstMove ? 0 : 1)) {
+      dispatch({
+        type: "PLAYER_MOVE",
+        payload: {
+          move: gameContext?.game?.history({ verbose: true })?.pop() ?? null,
+          onSolve,
+          onFail,
+          changePuzzle,
+          game: game,
+        },
+      });
+
+      dispatch({
+        type: "CPU_MOVE",
+        payload: {
+          makeMove,
+        },
+      });
+    }
+  }, [game?.history()?.length]);
+
+  const onHint = () => {
+    dispatch({ type: "TOGGLE_HINT" });
+  };
+
+  return {
+    status: state.status,
+    changePuzzle,
+    puzzle,
+    hint: state.hint,
+    onHint,
+    nextMove: state.nextMove,
+    isPlayerTurn: state.isPlayerTurn,
+  };
+};

package/src/hooks/useChessPuzzleContext.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import { useChessPuzzle } from "./useChessPuzzle";
+
+export const ChessPuzzleContext = React.createContext<ReturnType<
+  typeof useChessPuzzle
+> | null>(null);
+
+export const useChessPuzzleContext = () => {
+  const context = React.useContext(ChessPuzzleContext);
+  if (!context) {
+    throw new Error(
+      "useChessGameContext must be used within a ChessGameProvider",
+    );
+  }
+  return context;
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export { ChessPuzzle } from "./components/ChessPuzzle";
+export { useChessPuzzleContext } from "./hooks/useChessPuzzleContext";

package/src/utils/index.ts

@@ -0,0 +1,103 @@
+import { type Color, Chess, Move } from "chess.js";
+import React, { CSSProperties, ReactElement, ReactNode } from "react";
+import _ from "lodash";
+
+export type Status = "not-started" | "in-progress" | "solved" | "failed";
+
+export type Hint = "none" | "piece" | "move";
+
+export type Puzzle = {
+  fen: string;
+  moves: string[];
+  // if the first move of the puzzle has to be made by the cpu, as in chess.com puzzles
+  makeFirstMove?: boolean;
+};
+
+const FAIL_COLOR = "rgba(201, 52, 48, 0.5)";
+const SUCCESS_COLOR = "rgba(172, 206, 89, 0.5)";
+const HINT_COLOR = "rgba(27, 172, 166, 0.5)";
+
+export const getOrientation = (puzzle: Puzzle): Color => {
+  const fen = puzzle.fen;
+  const game = new Chess(fen);
+  if (puzzle.makeFirstMove) {
+    game.move(puzzle.moves[0]);
+  }
+  return game.turn();
+};
+
+interface ClickableElement extends ReactElement {
+  props: {
+    onClick?: () => void;
+  };
+}
+
+export const isClickableElement = (
+  element: ReactNode,
+): element is ClickableElement => React.isValidElement(element);
+
+export const getCustomSquareStyles = (
+  status: Status,
+  hint: Hint,
+  isPlayerTurn: boolean,
+  game: Chess,
+  nextMove?: Move | null,
+) => {
+  const customSquareStyles: Record<string, CSSProperties> = {};
+
+  const lastMove = _.last(game.history({ verbose: true }));
+
+  if (status === "failed" && lastMove) {
+    customSquareStyles[lastMove.from] = {
+      backgroundColor: FAIL_COLOR,
+    };
+    customSquareStyles[lastMove.to] = {
+      backgroundColor: FAIL_COLOR,
+    };
+  }
+
+  if (
+    lastMove &&
+    (status === "solved" || (status !== "failed" && !isPlayerTurn))
+  ) {
+    customSquareStyles[lastMove.from] = {
+      backgroundColor: SUCCESS_COLOR,
+    };
+    customSquareStyles[lastMove.to] = {
+      backgroundColor: SUCCESS_COLOR,
+    };
+  }
+
+  if (hint === "piece") {
+    if (nextMove) {
+      customSquareStyles[nextMove.from] = {
+        backgroundColor: HINT_COLOR,
+      };
+    }
+  }
+
+  if (hint === "move") {
+    if (nextMove) {
+      customSquareStyles[nextMove.from] = {
+        backgroundColor: HINT_COLOR,
+      };
+      customSquareStyles[nextMove.to] = {
+        backgroundColor: HINT_COLOR,
+      };
+    }
+  }
+
+  return customSquareStyles;
+};
+
+export const stringToMove = (game: Chess, move: string | null | undefined) => {
+  const copy = new Chess(game.fen());
+  if (move === null || move === undefined) {
+    return null;
+  }
+  try {
+    return copy.move(move);
+  } catch (e) {
+    return null;
+  }
+};