kokopu-react 1.3.1 → 1.5.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 ChangeLog
 =========
 
+1.5.0 (April 27, 2022)
+----------------------
+* Add component `Movetext` to display chess games.
+
+1.4.1 (January 1, 2022)
+-----------------------
+* Upgrade dependencies.
+
+1.4.0 (October 21, 2021)
+------------------------
+* Add support for plus/times/dot/circle in text markers.
+
 1.3.1 (September 27, 2021)
 --------------------------
 * Fix missing export for `ErrorBox`.

package/README.md

@@ -10,7 +10,7 @@ and [PGN](https://en.wikipedia.org/wiki/Portable_Game_Notation) formats...).
 
 https://www.npmjs.com/package/kokopu-react
 
-[![Build Status](https://travis-ci.com/yo35/kokopu-react.svg?branch=master)](https://travis-ci.com/yo35/kokopu-react)
+[![Build Status](https://app.travis-ci.com/yo35/kokopu-react.svg?branch=master)](https://app.travis-ci.com/yo35/kokopu-react)
 [![Coverage Status](https://coveralls.io/repos/github/yo35/kokopu-react/badge.svg?branch=master)](https://coveralls.io/github/yo35/kokopu-react?branch=master)
 
 

package/dist/lib/ArrowMarkerIcon.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -23,9 +23,9 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
@@ -85,10 +85,8 @@ var ArrowMarkerIcon = /*#__PURE__*/function (_React$Component) {
         x2: size - halfThickness * 3,
         y2: size / 2,
         stroke: this.props.color,
-        style: {
-          'strokeWidth': halfThickness * 2,
-          'markerEnd': "url(#".concat(this.arrowTipId, ")")
-        }
+        strokeWidth: halfThickness * 2,
+        markerEnd: "url(#".concat(this.arrowTipId, ")")
       }));
     }
   }]);

package/dist/lib/Chessboard.js

@@ -21,6 +21,8 @@ var _piecesets2 = _interopRequireDefault(require("./impl/piecesets"));
 
 var _ArrowTip = _interopRequireDefault(require("./impl/ArrowTip"));
 
+var _TextSymbol = _interopRequireDefault(require("./impl/TextSymbol"));
+
 var _ErrorBox = _interopRequireDefault(require("./ErrorBox"));
 
 var _i18n = _interopRequireDefault(require("./i18n"));
@@ -33,11 +35,9 @@ require("./css/chessboard.css");
 
 require("./css/arrow.css");
 
-require("./css/label.css");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
@@ -55,9 +55,9 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
@@ -408,10 +408,8 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
         x2: xTo,
         y2: yTo,
         stroke: colorset[this.props.editedArrowColor],
-        style: {
-          'strokeWidth': strokeWidth,
-          'markerEnd': "url(#".concat(arrowTipId, ")")
-        }
+        strokeWidth: strokeWidth,
+        markerEnd: "url(#".concat(arrowTipId, ")")
       });
     }
   }, {
@@ -567,16 +565,16 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
 
         x += squareSize / 2;
         y += squareSize / 2;
-        result.push( /*#__PURE__*/_react["default"].createElement("text", {
+        result.push( /*#__PURE__*/_react["default"].createElement("g", {
           key: 'txtm-' + sq,
-          className: "kokopu-annotation kokopu-label",
+          className: "kokopu-annotation"
+        }, /*#__PURE__*/_react["default"].createElement(_TextSymbol["default"], {
           x: x,
           y: y,
-          fill: colorset[value.color],
-          style: {
-            'fontSize': squareSize
-          }
-        }, value.symbol));
+          size: squareSize,
+          symbol: value.symbol,
+          color: colorset[value.color]
+        })));
       });
       return result;
     }
@@ -624,10 +622,8 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
           x2: xTo,
           y2: yTo,
           stroke: colorset[color],
-          style: {
-            'strokeWidth': strokeWidth,
-            'markerEnd': "url(#".concat(arrowTipId, ")")
-          }
+          strokeWidth: strokeWidth,
+          markerEnd: "url(#".concat(arrowTipId, ")")
         }));
       });
       return result;
@@ -663,10 +659,8 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
         x2: x,
         y2: y,
         stroke: colorset['highlight'],
-        style: {
-          'strokeWidth': squareSize * STROKE_THICKNESS_FACTOR,
-          'markerEnd': "url(#".concat(this.getArrowTipId('highlight'), ")")
-        }
+        strokeWidth: squareSize * STROKE_THICKNESS_FACTOR,
+        markerEnd: "url(#".concat(this.getArrowTipId('highlight'), ")")
       });
     }
   }, {
@@ -699,12 +693,10 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
       var label = RANK_LABELS[rank];
       return /*#__PURE__*/_react["default"].createElement("text", {
         key: 'rank-' + label,
-        className: "kokopu-coordinate kokopu-label",
+        className: "kokopu-coordinate",
         x: x,
         y: y,
-        style: {
-          'fontSize': fontSize
-        }
+        fontSize: fontSize
       }, label);
     }
   }, {
@@ -715,12 +707,10 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
       var label = FILE_LABELS[file];
       return /*#__PURE__*/_react["default"].createElement("text", {
         key: 'file-' + label,
-        className: "kokopu-coordinate kokopu-label",
+        className: "kokopu-coordinate",
         x: x,
         y: y,
-        style: {
-          'fontSize': fontSize
-        }
+        fontSize: fontSize
       }, label);
     }
   }, {
@@ -925,7 +915,7 @@ var Chessboard = /*#__PURE__*/function (_React$Component) {
       };
     }
     /**
-     * Return information regarding the current displayed position and move, or parsing error message if something went wrong.
+     * Return information regarding the currently displayed position and move, or parsing error message if something went wrong.
      */
 
   }, {

package/dist/lib/ErrorBox.js

@@ -9,6 +9,8 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 
 var _react = _interopRequireDefault(require("react"));
 
+var _i18n = _interopRequireDefault(require("./i18n"));
+
 require("./css/error_box.css");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -16,7 +18,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 /******************************************************************************
  *                                                                            *
  *    This file is part of Kokopu-React, a JavaScript chess library.          *
- *    Copyright (C) 2021  Yoann Le Montagner <yo35 -at- melix.net>            *
+ *    Copyright (C) 2021-2022  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      *
@@ -33,18 +35,23 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  *    <http://www.gnu.org/licenses/>.                                         *
  *                                                                            *
  ******************************************************************************/
-
+var BACKWARD_CHARACTERS = 5;
+var FORWARD_CHARACTERS = 36;
 /**
  * Display an error message.
  */
+
 function ErrorBox(props) {
+  var excerpt = typeof props.text === 'string' && props.errorIndex >= 0 && props.errorIndex < props.text.length ? /*#__PURE__*/_react["default"].createElement("div", {
+    className: "kokopu-errorExcerpt"
+  }, ellipsisAt(props.text, props.errorIndex, BACKWARD_CHARACTERS, FORWARD_CHARACTERS, props.lineNumber)) : undefined;
   return /*#__PURE__*/_react["default"].createElement("div", {
     className: "kokopu-errorBox"
   }, /*#__PURE__*/_react["default"].createElement("div", {
     className: "kokopu-errorTitle"
   }, props.title), /*#__PURE__*/_react["default"].createElement("div", {
     className: "kokopu-errorMessage"
-  }, props.message));
+  }, props.message), excerpt);
 }
 
 ErrorBox.propTypes = {
@@ -56,5 +63,78 @@ ErrorBox.propTypes = {
   /**
    * Additional message providing details about the error.
    */
-  message: _propTypes["default"].string.isRequired
-};
+  message: _propTypes["default"].string.isRequired,
+
+  /**
+   * Raw text whose processing results in the error.
+   */
+  text: _propTypes["default"].string,
+
+  /**
+   * Index of the character within `text` that results in the error.
+   */
+  errorIndex: _propTypes["default"].number,
+
+  /**
+   * Index (1-based) of the line in which is the character that results in the error.
+   */
+  lineNumber: _propTypes["default"].number
+};
+/**
+ * Ellipsis function.
+ *
+ * Example: if `text` is `0123456789`, then `ellipsis(text, 5, 1, 3)` returns
+ * the following string:
+ *
+ * ```
+ * ...45678...
+ *     ^
+ * ```
+ *
+ * @param {string} text Text from a substring must be extracted.
+ * @param {number} pos Index of the character in `text` around which the substring must be extracted.
+ * @param {number} backwardCharacters Number of characters to keep before `pos`.
+ * @param {number} forwardCharacters Number of characters to keep after `pos`.
+ * @returns {string}
+ */
+
+function ellipsisAt(text, pos, backwardCharacters, forwardCharacters, lineNumber) {
+  // p1 => begin of the extracted sub-string
+  var p1 = pos;
+  var e1 = '... ';
+
+  while (p1 > pos - backwardCharacters) {
+    --p1;
+
+    if (p1 < 0 || text.charAt(p1) === '\n' || text.charAt(p1) === '\r') {
+      ++p1;
+      e1 = '';
+      break;
+    }
+  } // p2 => one character after the end of the extracted sub-string
+
+
+  var p2 = pos;
+  var e2 = ' ...';
+
+  while (p2 < pos + forwardCharacters) {
+    ++p2;
+
+    if (p2 >= text.length || text.charAt(p2) === '\n' || text.charAt(p2) === '\r') {
+      --p2;
+      e2 = '';
+      break;
+    }
+  } // Extract the sub-string around the requested position.
+
+
+  var excerpt = e1 + text.substring(p1, p2 + 1) + e2;
+  excerpt = excerpt.replace(/\n|\r|\t/g, ' ');
+  var secondLine = Array(1 + e1.length + pos - p1).join(' ') + '^';
+
+  if (lineNumber) {
+    secondLine += ' (' + _i18n["default"].LINE.replace(/\{0\}/g, lineNumber) + ')';
+  }
+
+  return excerpt + '\n' + secondLine;
+}