kokopu-react 1.11.1 → 2.0.0

package/dist/lib/movetext/moveFormatter.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import { PieceSymbolMapping } from '../types';
+import './fonts.css';
+/**
+ * Render the given SAN notation according to the given piece symbol style.
+ *
+ * @param pieceSymbols - See {@link moveFormatter}.
+ * @param notation - SAN notation.
+ */
+export declare function formatMove(pieceSymbols: 'native' | 'localized' | 'figurines' | PieceSymbolMapping, notation: string): React.ReactNode;
+/**
+ * Return a callback capable of rendering a SAN notation using the given piece symbol style.
+ *
+ * @param pieceSymbols - One of the following piece symbol style:
+ *                       - `'native'`: use the English chess piece initials (i.e. K, Q, R, B, N, P).
+ *                       - `'localized'`: use the piece symbols defined in {@link i18n.PIECE_SYMBOLS}.
+ *                       - `'figurines'`: use a figurine font.
+ *                       - {@link PieceSymbolMapping}: use the given custom set of chess piece symbols.
+ */
+export declare function moveFormatter(pieceSymbols: 'native' | 'localized' | 'figurines' | PieceSymbolMapping): (notation: string) => React.ReactNode;

package/dist/lib/movetext/moveFormatter.js

@@ -0,0 +1,93 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program 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,         *
+ *    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 { IllegalArgument } from '../exception';
+import { i18n } from '../i18n';
+import { isPieceSymbolMapping } from '../types';
+import './fonts.css';
+/**
+ * Render the given SAN notation according to the given piece symbol style.
+ *
+ * @param pieceSymbols - See {@link moveFormatter}.
+ * @param notation - SAN notation.
+ */
+export function formatMove(pieceSymbols, notation) {
+    const formatter = moveFormatter(pieceSymbols);
+    return formatter(notation);
+}
+/**
+ * Return a callback capable of rendering a SAN notation using the given piece symbol style.
+ *
+ * @param pieceSymbols - One of the following piece symbol style:
+ *                       - `'native'`: use the English chess piece initials (i.e. K, Q, R, B, N, P).
+ *                       - `'localized'`: use the piece symbols defined in {@link i18n.PIECE_SYMBOLS}.
+ *                       - `'figurines'`: use a figurine font.
+ *                       - {@link PieceSymbolMapping}: use the given custom set of chess piece symbols.
+ */
+export function moveFormatter(pieceSymbols) {
+    if (pieceSymbols === 'native') {
+        return notation => notation;
+    }
+    else if (pieceSymbols === 'localized') {
+        const mapping = i18n.PIECE_SYMBOLS;
+        return notation => pieceMappingNotation(mapping, notation);
+    }
+    else if (pieceSymbols === 'figurines') {
+        return notation => figurineNotation('alpha', notation);
+    }
+    else if (isPieceSymbolMapping(pieceSymbols)) {
+        return notation => pieceMappingNotation(pieceSymbols, notation);
+    }
+    else {
+        throw new IllegalArgument('moveFormatter', 'pieceSymbols');
+    }
+}
+/**
+ * Replace the native piece symbols by those defined by the given {@link PieceSymbolMapping}.
+ */
+function pieceMappingNotation(mapping, text) {
+    return text.replace(/[KQRBNP]/g, match => mapping[match]);
+}
+/**
+ * Decompose the given string into piece symbol characters and sections of non piece symbol characters, and transform the piece symbols into
+ * React objects represented with the given chess font.
+ */
+function figurineNotation(fontName, text) {
+    const result = [];
+    let beginOfText = 0;
+    let pieceSymbolIndex = 0;
+    for (let pos = 0; pos < text.length; ++pos) {
+        const currentChar = text.charAt(pos);
+        if (currentChar === 'K' || currentChar === 'Q' || currentChar === 'R' || currentChar === 'B' || currentChar === 'N' || currentChar === 'P') {
+            if (pos > beginOfText) {
+                result.push(text.substring(beginOfText, pos));
+            }
+            beginOfText = pos + 1;
+            const key = 'symbol-' + (pieceSymbolIndex++);
+            result.push(React.createElement("span", { className: 'kokopu-font-' + fontName, key: key }, currentChar));
+        }
+    }
+    if (beginOfText < text.length) {
+        result.push(text.substring(beginOfText));
+    }
+    return React.createElement(React.Fragment, null, result);
+}
+//# sourceMappingURL=moveFormatter.js.map

package/dist/lib/movetext/moveFormatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moveFormatter.js","sourceRoot":"","sources":["../../../src/movetext/moveFormatter.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;gFAmBgF;AAGhF,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAsB,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEpE,OAAO,aAAa,CAAC;AAGrB;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,YAAuE,EAAE,QAAgB;IACnH,MAAM,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC9C,OAAO,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC5B,CAAC;AAGD;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,YAAuE;IACpG,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC9B,OAAO,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC;KAC5B;SACI,IAAI,YAAY,KAAK,WAAW,EAAE;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC;QACnC,OAAO,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC3D;SACI,IAAI,YAAY,KAAK,WAAW,EAAE;QACtC,OAAO,QAAQ,CAAC,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KACvD;SACI,IAAI,oBAAoB,CAAC,YAAY,CAAC,EAAE;QAC5C,OAAO,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;KAChE;SACI;QACJ,MAAM,IAAI,eAAe,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;KAC3D;AACF,CAAC;AAGD;;GAEG;AACH,SAAS,oBAAoB,CAAC,OAA2B,EAAE,IAAY;IACtE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAiC,CAAC,CAAC,CAAC;AACvF,CAAC;AAGD;;;GAGG;AACH,SAAS,gBAAgB,CAAC,QAAgB,EAAE,IAAY;IACvD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,EAAE;YAC3I,IAAI,GAAG,GAAG,WAAW,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;aAC9C;YACD,WAAW,GAAG,GAAG,GAAG,CAAC,CAAC;YACtB,MAAM,GAAG,GAAG,SAAS,GAAG,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,8BAAM,SAAS,EAAE,cAAc,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAG,WAAW,CAAQ,CAAC,CAAC;SACxF;KACD;IACD,IAAI,WAAW,GAAG,IAAI,CAAC,MAAM,EAAE;QAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;KACzC;IACD,OAAO,0CAAG,MAAM,CAAI,CAAC;AACtB,CAAC"}

package/dist/lib/sanitization.d.ts

@@ -0,0 +1,6 @@
+import { IllegalArgument } from './exception';
+export declare function sanitizeString(input: string): string;
+export declare function sanitizeBoolean(input: boolean): boolean;
+export declare function sanitizeInteger(input: number, exceptionBuilder: () => IllegalArgument): number;
+export declare function sanitizeBoundedInteger(input: number, min: number, max: number, exceptionBuilder: () => IllegalArgument): number;
+export declare function sanitizeOptional<T>(input: T | undefined, sanitizationFunction: (val: T) => T): T | undefined;

package/dist/lib/sanitization.js

@@ -0,0 +1,39 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program 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,         *
+ *    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/>.                                         *
+ *                                                                            *
+ * -------------------------------------------------------------------------- */
+export function sanitizeString(input) {
+    return String(input);
+}
+export function sanitizeBoolean(input) {
+    return Boolean(input);
+}
+export function sanitizeInteger(input, exceptionBuilder) {
+    if (typeof input !== 'number' || !Number.isFinite(input)) {
+        throw exceptionBuilder();
+    }
+    return Math.round(input);
+}
+export function sanitizeBoundedInteger(input, min, max, exceptionBuilder) {
+    return Math.min(Math.max(sanitizeInteger(input, exceptionBuilder), min), max);
+}
+export function sanitizeOptional(input, sanitizationFunction) {
+    return input === undefined || input === null ? undefined : sanitizationFunction(input);
+}
+//# sourceMappingURL=sanitization.js.map

package/dist/lib/sanitization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitization.js","sourceRoot":"","sources":["../../src/sanitization.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;gFAmBgF;AAMhF,MAAM,UAAU,cAAc,CAAC,KAAa;IAC3C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC;AAGD,MAAM,UAAU,eAAe,CAAC,KAAc;IAC7C,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAGD,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,gBAAuC;IACrF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACzD,MAAM,gBAAgB,EAAE,CAAC;KACzB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAGD,MAAM,UAAU,sBAAsB,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,gBAAuC;IACtH,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,gBAAgB,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/E,CAAC;AAGD,MAAM,UAAU,gBAAgB,CAAI,KAAoB,EAAE,oBAAmC;IAC5F,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AACxF,CAAC"}

package/dist/lib/types.d.ts

@@ -0,0 +1,151 @@
+import { Square, SquareCouple } from 'kokopu';
+/**
+ * Minimum square size in a {@link Chessboard} component.
+ */
+export declare const MIN_SQUARE_SIZE = 12;
+/**
+ * Maximum square size in a {@link Chessboard} component.
+ */
+export declare const MAX_SQUARE_SIZE = 96;
+/**
+ * Set of parameters describing the colors to use to render a {@link Chessboard} component.
+ *
+ * Each color is defined as string, that must be interpreted as a [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+ */
+export type Colorset = {
+    /** Color of the black squares. */
+    b: string;
+    /** Color of the white squares. */
+    w: string;
+    /** Color of the blue markers. */
+    cb: string;
+    /** Color of the green markers. */
+    cg: string;
+    /** Color of the red markers. */
+    cr: string;
+    /** Color of the yellow markers. */
+    cy: string;
+};
+/**
+ * Set of parameters describing the chess pieces to use to render a {@link Chessboard} component.
+ *
+ * Each field is a string corresponding to the URL of the image of the corresponding chess piece.
+ */
+export type Pieceset = {
+    /** Image for the black bishops. */
+    bb: string;
+    /** Image for the black kings. */
+    bk: string;
+    /** Image for the black knights. */
+    bn: string;
+    /** Image for the black pawns. */
+    bp: string;
+    /** Image for the black queens. */
+    bq: string;
+    /** Image for the black rooks. */
+    br: string;
+    /** Image for the black turn flags. */
+    bx: string;
+    /** Image for the white bishops. */
+    wb: string;
+    /** Image for the white kings. */
+    wk: string;
+    /** Image for the white knights. */
+    wn: string;
+    /** Image for the white pawns. */
+    wp: string;
+    /** Image for the white queens. */
+    wq: string;
+    /** Image for the white rooks. */
+    wr: string;
+    /** Image for the white turn flags. */
+    wx: string;
+};
+/**
+ * Set of aliases for chess pieces symbols.
+ */
+export type PieceSymbolMapping = {
+    K: string;
+    Q: string;
+    R: string;
+    B: string;
+    N: string;
+    P: string;
+};
+/**
+ * Whether the given object is a {@link PieceSymbolMapping} or not.
+ */
+export declare function isPieceSymbolMapping(mapping: unknown): mapping is PieceSymbolMapping;
+/**
+ * Symbol that can be chosen to decorate a square in a {@link Chessboard}.
+ */
+export type AnnotationSymbol = 'plus' | 'times' | 'dot' | 'circle' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+/**
+ * Whether the given object is a {@link AnnotationSymbol} or not.
+ */
+export declare function isAnnotationSymbol(symbol: unknown): symbol is AnnotationSymbol;
+/**
+ * Color that can be chosen to decorate a square or draw an arrow in a {@link Chessboard}.
+ */
+export type AnnotationColor = 'b' | 'g' | 'r' | 'y';
+/**
+ * Whether the given object is a {@link AnnotationSymbol} or not.
+ */
+export declare function isAnnotationColor(color: unknown): color is AnnotationColor;
+/**
+ * Set of square markers (i.e. colorized squares in a {@link Chessboard}).
+ */
+export type SquareMarkerSet = Partial<Record<Square, AnnotationColor>>;
+/**
+ * Set of text markers (i.e. colorized symbols that can decorate the squares of a {@link Chessboard}).
+ */
+export type TextMarkerSet = Partial<Record<Square, {
+    symbol: AnnotationSymbol;
+    color: AnnotationColor;
+}>>;
+/**
+ * Set of arrow markers (i.e. colorized arrows between two squares in a {@link Chessboard}).
+ */
+export type ArrowMarkerSet = Partial<Record<SquareCouple, AnnotationColor>>;
+/**
+ * Transform a {@link SquareMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e4: 'g', d5: 'r' }`
+ * @returns For example: `'Gd5,Ge4'`
+ */
+export declare function flattenSquareMarkers(markers: SquareMarkerSet): string;
+/**
+ * Transform a {@link TextMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e4: { symbol: 'A', color: 'g' }, d5: { symbol: 'z', color: 'r' }, h3: { symbol: 'plus', color: 'y' } }`
+ * @returns For example: `'Rzd5,GAe4,Y(plus)h3'`
+ */
+export declare function flattenTextMarkers(markers: TextMarkerSet): string;
+/**
+ * Transform a {@link ArrowMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e2e4: 'g', g8f6: 'r', g8h6: 'b' }`
+ * @returns For example: `'Ge2e4,Rg8f6,Bg8h6'`
+ */
+export declare function flattenArrowMarkers(markers: ArrowMarkerSet): string;
+/**
+ * Parse a comma-separated string representing a {@link SquareMarkerSet}.
+ *
+ * @param markers - For example: `'Gd5,Ge4'`
+ * @returns For example: `{ e4: 'g', d5: 'r' }`
+ */
+export declare function parseSquareMarkers(markers: string): SquareMarkerSet;
+/**
+ * Parse a comma-separated string representing a {@link TextMarkerSet}.
+ *
+ * @param markers - For example: `'Rzd5,GAe4,Y(plus)h3'`
+ * @returns For example: `{ e4: { symbol: 'A', color: 'g' }, d5: { symbol: 'z', color: 'r' }, h3: { symbol: 'plus', color: 'y' } }`
+ */
+export declare function parseTextMarkers(markers: string): TextMarkerSet;
+/**
+ * Parse a comma-separated string representing a {@link ArrowMarkerSet}.
+ *
+ * @param markers - For example: `'Ge2e4,Rg8f6,Bg8h6'`
+ * @returns For example: `{ e2e4: 'g', g8f6: 'r', g8h6: 'b' }`
+ */
+export declare function parseArrowMarkers(markers: string): ArrowMarkerSet;

package/dist/lib/types.js

@@ -0,0 +1,162 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program 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,         *
+ *    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 { isSquare, isSquareCouple } from 'kokopu';
+import { IllegalArgument } from './exception';
+/**
+ * Minimum square size in a {@link Chessboard} component.
+ */
+export const MIN_SQUARE_SIZE = 12;
+/**
+ * Maximum square size in a {@link Chessboard} component.
+ */
+export const MAX_SQUARE_SIZE = 96;
+/**
+ * Whether the given object is a {@link PieceSymbolMapping} or not.
+ */
+export function isPieceSymbolMapping(mapping) {
+    if (typeof mapping !== 'object' || mapping === null) {
+        return false;
+    }
+    return typeof mapping.K === 'string' &&
+        typeof mapping.Q === 'string' &&
+        typeof mapping.R === 'string' &&
+        typeof mapping.B === 'string' &&
+        typeof mapping.N === 'string' &&
+        typeof mapping.P === 'string';
+}
+/**
+ * Whether the given object is a {@link AnnotationSymbol} or not.
+ */
+export function isAnnotationSymbol(symbol) {
+    return typeof symbol === 'string' && /^(?:[A-Za-z0-9]|plus|times|dot|circle)$/.test(symbol);
+}
+/**
+ * Whether the given object is a {@link AnnotationSymbol} or not.
+ */
+export function isAnnotationColor(color) {
+    return color === 'b' || color === 'g' || color === 'r' || color === 'y';
+}
+/**
+ * Transform a {@link SquareMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e4: 'g', d5: 'r' }`
+ * @returns For example: `'Gd5,Ge4'`
+ */
+export function flattenSquareMarkers(markers) {
+    if (typeof markers !== 'object' || markers === null) {
+        throw new IllegalArgument('flattenSquareMarkers()', 'markers');
+    }
+    return Object.entries(markers)
+        .filter(([sq, color]) => isSquare(sq) && isAnnotationColor(color))
+        .sort((a, b) => a[0].localeCompare(b[0]))
+        .map(([sq, color]) => color.toUpperCase() + sq)
+        .join(',');
+}
+/**
+ * Transform a {@link TextMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e4: { symbol: 'A', color: 'g' }, d5: { symbol: 'z', color: 'r' }, h3: { symbol: 'plus', color: 'y' } }`
+ * @returns For example: `'Rzd5,GAe4,Y(plus)h3'`
+ */
+export function flattenTextMarkers(markers) {
+    if (typeof markers !== 'object' || markers === null) {
+        throw new IllegalArgument('flattenTextMarkers()', 'markers');
+    }
+    return Object.entries(markers)
+        .filter(([sq, desc]) => isSquare(sq) && desc && isAnnotationColor(desc.color) && isAnnotationSymbol(desc.symbol))
+        .sort((a, b) => a[0].localeCompare(b[0]))
+        .map(([sq, desc]) => desc.color.toUpperCase() + (desc.symbol.length === 1 ? desc.symbol : `(${desc.symbol})`) + sq)
+        .join(',');
+}
+/**
+ * Transform a {@link ArrowMarkerSet} into a comma-separated string.
+ *
+ * @param markers - For example: `{ e2e4: 'g', g8f6: 'r', g8h6: 'b' }`
+ * @returns For example: `'Ge2e4,Rg8f6,Bg8h6'`
+ */
+export function flattenArrowMarkers(markers) {
+    if (typeof markers !== 'object' || markers === null) {
+        throw new IllegalArgument('flattenArrowMarkers()', 'markers');
+    }
+    return Object.entries(markers)
+        .filter(([vect, color]) => isSquareCouple(vect) && isAnnotationColor(color))
+        .sort((a, b) => a[0].localeCompare(b[0]))
+        .map(([vect, color]) => color.toUpperCase() + vect)
+        .join(',');
+}
+/**
+ * Parse a comma-separated string representing a {@link SquareMarkerSet}.
+ *
+ * @param markers - For example: `'Gd5,Ge4'`
+ * @returns For example: `{ e4: 'g', d5: 'r' }`
+ */
+export function parseSquareMarkers(markers) {
+    if (typeof markers !== 'string') {
+        throw new IllegalArgument('parseSquareMarkers()', 'markers');
+    }
+    return parseMarkers(markers, token => {
+        return /^([BGRY])([a-h][1-8])$/.test(token) ?
+            { key: RegExp.$2, value: RegExp.$1.toLowerCase() } :
+            undefined;
+    });
+}
+/**
+ * Parse a comma-separated string representing a {@link TextMarkerSet}.
+ *
+ * @param markers - For example: `'Rzd5,GAe4,Y(plus)h3'`
+ * @returns For example: `{ e4: { symbol: 'A', color: 'g' }, d5: { symbol: 'z', color: 'r' }, h3: { symbol: 'plus', color: 'y' } }`
+ */
+export function parseTextMarkers(markers) {
+    if (typeof markers !== 'string') {
+        throw new IllegalArgument('parseTextMarkers()', 'markers');
+    }
+    return parseMarkers(markers, token => {
+        return /^([BGRY])(?:([A-Za-z0-9])|\((plus|times|dot|circle)\))([a-h][1-8])$/.test(token) ?
+            { key: RegExp.$4, value: { symbol: (RegExp.$2 || RegExp.$3), color: RegExp.$1.toLowerCase() } } :
+            undefined;
+    });
+}
+/**
+ * Parse a comma-separated string representing a {@link ArrowMarkerSet}.
+ *
+ * @param markers - For example: `'Ge2e4,Rg8f6,Bg8h6'`
+ * @returns For example: `{ e2e4: 'g', g8f6: 'r', g8h6: 'b' }`
+ */
+export function parseArrowMarkers(markers) {
+    if (typeof markers !== 'string') {
+        throw new IllegalArgument('parseArrowMarkers()', 'markers');
+    }
+    return parseMarkers(markers, token => {
+        return /^([BGRY])([a-h][1-8][a-h][1-8])$/.test(token) ?
+            { key: RegExp.$2, value: RegExp.$1.toLowerCase() } :
+            undefined;
+    });
+}
+function parseMarkers(markers, tokenParser) {
+    const result = {};
+    markers.split(',').map(token => tokenParser(token.trim())).forEach(marker => {
+        if (marker) {
+            result[marker.key] = marker.value;
+        }
+    });
+    return result;
+}
+//# sourceMappingURL=types.js.map

package/dist/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;gFAmBgF;AAGhF,OAAO,EAAwB,QAAQ,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAExE,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAG9C;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AA8FlC;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACpD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE;QACpD,OAAO,KAAK,CAAC;KACb;IACD,OAAO,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ;QAC3D,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ;QACrD,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ;QACrD,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ;QACrD,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ;QACrD,OAAQ,OAA8B,CAAC,CAAC,KAAK,QAAQ,CAAC;AACxD,CAAC;AAYD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAe;IACjD,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,yCAAyC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC7F,CAAC;AASD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC/C,OAAO,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,CAAC;AACzE,CAAC;AAqBD;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAwB;IAC5D,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE;QACpD,MAAM,IAAI,eAAe,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;KAC/D;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC5B,MAAM,CAAC,CAAC,CAAE,EAAE,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;SACnE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxC,GAAG,CAAC,CAAC,CAAE,EAAE,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC;SAChD,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAsB;IACxD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE;QACpD,MAAM,IAAI,eAAe,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;KAC7D;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC5B,MAAM,CAAC,CAAC,CAAE,EAAE,EAAE,IAAI,CAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClH,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxC,GAAG,CAAC,CAAC,CAAE,EAAE,EAAE,IAAI,CAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC;SACpH,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAuB;IAC1D,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE;QACpD,MAAM,IAAI,eAAe,CAAC,uBAAuB,EAAE,SAAS,CAAC,CAAC;KAC9D;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC5B,MAAM,CAAC,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;SAC7E,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxC,GAAG,CAAC,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC;SACpD,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAChC,MAAM,IAAI,eAAe,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;KAC7D;IACD,OAAO,YAAY,CAA0B,OAAO,EAAE,KAAK,CAAC,EAAE;QAC7D,OAAO,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5C,EAAE,GAAG,EAAE,MAAM,CAAC,EAAY,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,WAAW,EAAqB,EAAE,CAAC,CAAC;YACjF,SAAS,CAAC;IACZ,CAAC,CAAC,CAAC;AACJ,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC/C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAChC,MAAM,IAAI,eAAe,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;KAC3D;IACD,OAAO,YAAY,CAA+D,OAAO,EAAE,KAAK,CAAC,EAAE;QAClG,OAAO,qEAAqE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACzF,EAAE,GAAG,EAAE,MAAM,CAAC,EAAY,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,EAAE,CAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,WAAW,EAAqB,EAAE,EAAE,CAAC,CAAC;YAClJ,SAAS,CAAC;IACZ,CAAC,CAAC,CAAC;AACJ,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAChC,MAAM,IAAI,eAAe,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC;KAC5D;IACD,OAAO,YAAY,CAAgC,OAAO,EAAE,KAAK,CAAC,EAAE;QACnE,OAAO,kCAAkC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACtD,EAAE,GAAG,EAAE,MAAM,CAAC,EAAkB,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,WAAW,EAAqB,EAAE,CAAC,CAAC;YACvF,SAAS,CAAC;IACZ,CAAC,CAAC,CAAC;AACJ,CAAC;AAGD,SAAS,YAAY,CAAsB,OAAe,EAAE,WAAgE;IAC3H,MAAM,MAAM,GAA0B,EAAE,CAAC;IACzC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC3E,IAAI,MAAM,EAAE;YACX,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;SAClC;IACF,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AACf,CAAC"}

package/dist/lib/util.d.ts

@@ -0,0 +1,2 @@
+export declare function generateRandomId(): string;
+export declare function fillPlaceholder(message: string, ...placeholderValues: unknown[]): string;

package/dist/lib/util.js

@@ -0,0 +1,36 @@
+/* -------------------------------------------------------------------------- *
+ *                                                                            *
+ *    This file is part of Kokopu-React, a JavaScript chess library.          *
+ *    Copyright (C) 2021-2023  Yoann Le Montagner <yo35 -at- melix.net>       *
+ *                                                                            *
+ *    This program 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,         *
+ *    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/>.                                         *
+ *                                                                            *
+ * -------------------------------------------------------------------------- */
+export function generateRandomId() {
+    const buffer = new Uint32Array(8);
+    crypto.getRandomValues(buffer);
+    let result = '';
+    for (let i = 0; i < buffer.length; ++i) {
+        result += buffer[i].toString(16);
+    }
+    return result;
+}
+export function fillPlaceholder(message, ...placeholderValues) {
+    return message.replace(/{(\d+)}/g, (match, placeholder) => {
+        const placeholderIndex = Number(placeholder);
+        return placeholderIndex < placeholderValues.length ? String(placeholderValues[placeholderIndex]) : match;
+    });
+}
+//# sourceMappingURL=util.js.map

package/dist/lib/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/util.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;gFAmBgF;AAGhF,MAAM,UAAU,gBAAgB;IAC/B,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC/B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACvC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;KACjC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAGD,MAAM,UAAU,eAAe,CAAC,OAAe,EAAE,GAAG,iBAA4B;IAC/E,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;QACzD,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7C,OAAO,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1G,CAAC,CAAC,CAAC;AACJ,CAAC"}