kokopu-react 3.0.1 → 3.1.0

package/src/errorbox/parsing.tsx

@@ -0,0 +1,158 @@
+/*!
+ * -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
+ *    modify it under the terms of the GNU Lesser General Public License      *
+ *    as published by the Free Software Foundation, either version 3 of       *
+ *    the License, or (at your option) any later version.                     *
+ *                                                                            *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
+ *    GNU Lesser General Public License for more details.                     *
+ *                                                                            *
+ *    You should have received a copy of the GNU Lesser General               *
+ *    Public License along with this program. If not, see                     *
+ *    <http://www.gnu.org/licenses/>.                                         *
+ *                                                                            *
+ * -------------------------------------------------------------------------- */
+
+
+import * as React from 'react';
+
+import { exception as kokopuException, i18n as kokopuI18n, Database, Game, GameVariant, MoveDescriptor, Position, isGameVariant, pgnRead } from 'kokopu';
+
+import { IllegalArgument } from '../exception';
+import { i18n } from '../i18n';
+
+import { ErrorBox } from './ErrorBox';
+
+
+/**
+ * Try to interpret the given object as a chess position.
+ */
+export function parsePosition(position: Position | string, componentName: string):
+	{ error: true, errorBox: JSX.Element } | { error: false, position: Position }
+{
+	if (position instanceof Position) {
+		return { error: false, position: position };
+	}
+	else if (position === 'start' || position === 'empty') {
+		return { error: false, position: new Position(position) };
+	}
+	else if (typeof position === 'string') {
+		try {
+			const { variant, fen } = splitGameVariantAndFEN(position);
+			const result = new Position(variant, 'empty');
+			result.fen(fen);
+			return { error: false, position: result };
+		}
+		catch (e) {
+			// istanbul ignore else
+			if (e instanceof kokopuException.InvalidFEN) {
+				return { error: true, errorBox: <ErrorBox title={i18n.INVALID_FEN_ERROR_TITLE} message={e.message} /> };
+			}
+			else {
+				throw e;
+			}
+		}
+	}
+	else {
+		throw new IllegalArgument(componentName, 'position');
+	}
+}
+
+
+/**
+ * Look for an optional 'chess-variant:' prefix in the position attribute.
+ */
+function splitGameVariantAndFEN(position: string): { variant: GameVariant, fen: string } {
+	const separatorIndex = position.indexOf(':');
+	if (separatorIndex < 0) {
+		return { variant: 'regular', fen: position };
+	}
+	const variant = position.substring(0, separatorIndex);
+	return isGameVariant(variant) ? { variant: variant, fen: position.substring(separatorIndex + 1) } : { variant: 'regular', fen: position };
+}
+
+
+/**
+ * Try to interpret the given object `move` as a move descriptor based on the given position.
+ */
+export function parseMove(position: Position, move: MoveDescriptor | string | undefined, componentName: string):
+	{ error: true, errorBox: JSX.Element } | { error: false, type: 'none' | 'null-move' } | { error: false, type: 'regular', move: MoveDescriptor }
+{
+	if (move === undefined || move === null) {
+		return { error: false, type: 'none' };
+	}
+	else if (move instanceof MoveDescriptor) {
+		return { error: false, type: 'regular', move: move };
+	}
+	else if (typeof move === 'string') {
+		if (move === '--') {
+			if (position.isNullMoveLegal()) {
+				return { error: false, type: 'null-move' };
+			}
+			else {
+				return { error: true, errorBox: <ErrorBox title={i18n.INVALID_NOTATION_ERROR_TITLE} message={kokopuI18n.ILLEGAL_NULL_MOVE} /> };
+			}
+		}
+		else {
+			try {
+				return { error: false, type: 'regular', move: position.notation(move) };
+			}
+			catch (e) {
+				// istanbul ignore else
+				if (e instanceof kokopuException.InvalidNotation) {
+					return { error: true, errorBox: <ErrorBox title={i18n.INVALID_NOTATION_ERROR_TITLE} message={e.message} /> };
+				}
+				else {
+					throw e;
+				}
+			}
+		}
+	}
+	else {
+		throw new IllegalArgument(componentName, 'move');
+	}
+}
+
+
+/**
+ * Try to interpret the given object as a chess game.
+ */
+export function parseGame(game: Game | Database | string, gameIndex: number, componentName: string):
+	{ error: true, errorBox: JSX.Element } | { error: false, game: Game }
+{
+	if (game instanceof Game) {
+		return { error: false, game: game };
+	}
+	else if (game instanceof Database || typeof game === 'string') {
+		if (!Number.isInteger(gameIndex) || gameIndex < 0) {
+			throw new IllegalArgument(componentName, 'gameIndex');
+		}
+		try {
+			const result = game instanceof Database ? game.game(gameIndex) : pgnRead(game, gameIndex);
+			return { error: false, game: result };
+		}
+		catch (e) {
+			// istanbul ignore else
+			if (e instanceof kokopuException.InvalidPGN) {
+				return {
+					error: true,
+					errorBox: <ErrorBox title={i18n.INVALID_PGN_ERROR_TITLE} message={e.message} text={e.pgn} errorIndex={e.index} lineNumber={e.lineNumber} />,
+				};
+			}
+			else {
+				throw e;
+			}
+		}
+	}
+	else {
+		throw new IllegalArgument(componentName, 'game');
+	}
+}

package/src/exception.ts

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/i18n.ts

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *
@@ -35,6 +37,13 @@ export let LINE = 'line {0}';
 export let INVALID_FEN_ERROR_TITLE = 'Invalid FEN string.';
 export let INVALID_NOTATION_ERROR_TITLE = 'Invalid move notation.';
 
+// Navigation board
+export let TOOLTIP_GO_FIRST = 'Go to the beginning of the game';
+export let TOOLTIP_GO_PREVIOUS = 'Go to the previous move';
+export let TOOLTIP_GO_NEXT = 'Go to the next move';
+export let TOOLTIP_GO_LAST = 'Go to the end of the game';
+export let TOOLTIP_FLIP = 'Flip the board';
+
 // Movetext
 export let PIECE_SYMBOLS = { 'K':'K', 'Q':'Q', 'R':'R', 'B':'B', 'N':'N', 'P':'P' };
 export let ANNOTATED_BY = 'Annotated by {0}';

package/src/icons/AnnotationSymbolShape.css

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/AnnotationSymbolShape.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/ArrowMarkerIcon.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/ArrowTip.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/ChessPieceIcon.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/SquareMarkerIcon.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/TextMarkerIcon.tsx

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/icons/arrow.css

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *

package/src/index.ts

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *
@@ -34,7 +36,11 @@ export { TextMarkerIcon, TextMarkerIconProps } from './icons/TextMarkerIcon';
 export { ArrowMarkerIcon, ArrowMarkerIconProps } from './icons/ArrowMarkerIcon';
 export { ChessPieceIcon, ChessPieceIconProps } from './icons/ChessPieceIcon';
 
-export { Chessboard, ChessboardProps, SmallScreenLimit } from './chessboard/Chessboard';
+export { SmallScreenLimit } from './chessboard/BoardProperties';
+export { Chessboard, ChessboardProps } from './chessboard/Chessboard';
 
 export { formatMove, moveFormatter } from './movetext/moveFormatter';
 export { Movetext, MovetextProps, MoveSelectEventOrigin } from './movetext/Movetext';
+
+export { firstNodeId, previousNodeId, nextNodeId, lastNodeId } from './navigationboard/NavigationField';
+export { NavigationBoard, NavigationBoardProps } from './navigationboard/NavigationBoard';

package/src/movetext/Movetext.css

@@ -1,14 +1,16 @@
-/* -------------------------------------------------------------------------- *
+/*!
+ * -------------------------------------------------------------------------- *
  *                                                                            *
- *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *    Kokopu-React - A React-based library of chess-related components.       *
+ *    <https://www.npmjs.com/package/kokopu-react>                            *
+ *    Copyright (C) 2021-2024  Yoann Le Montagner <yo35 -at- melix.net>       *
  *                                                                            *
- *    This program is free software: you can redistribute it and/or           *
+ *    Kokopu-React is free software: you can redistribute it and/or           *
  *    modify it under the terms of the GNU Lesser General Public License      *
  *    as published by the Free Software Foundation, either version 3 of       *
  *    the License, or (at your option) any later version.                     *
  *                                                                            *
- *    This program is distributed in the hope that it will be useful,         *
+ *    Kokopu-React is distributed in the hope that it will be useful,         *
  *    but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
  *    GNU Lesser General Public License for more details.                     *
@@ -106,16 +108,3 @@ div.kokopu-subVariation {
 	text-decoration: underline;
 	cursor: pointer;
 }
-
-.kokopu-focusFieldContainer {
-	position: fixed;
-	bottom: 0px;
-	right: 0px;
-	width: 0px;
-	height: 0px;
-	overflow: hidden;
-}
-
-.kokopu-focusField {
-	position: absolute; /* see #1 */
-}