handsontable 12.1.3 → 12.3.0-next-bb1a7c2-20221208

package/3rdparty/walkontable/src/cell/coords.mjs

@@ -1,47 +1,56 @@
+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); }
 import "core-js/modules/es.array.iterator.js";
 import "core-js/modules/es.object.to-string.js";
 import "core-js/modules/es.string.iterator.js";
 import "core-js/modules/es.weak-map.js";
 import "core-js/modules/web.dom-collections.iterator.js";
-
+import "core-js/modules/es.symbol.to-primitive.js";
+import "core-js/modules/es.date.to-primitive.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.symbol.description.js";
+import "core-js/modules/es.number.constructor.js";
+import "core-js/modules/es.symbol.iterator.js";
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-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 _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, _toPropertyKey(descriptor.key), descriptor); } }
 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 _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
-
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
-
 function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-
 function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
-
 function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-
 function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
-
 var _isRtl = /*#__PURE__*/new WeakMap();
-
+/* eslint-disable jsdoc/require-description-complete-sentence */
 /**
- * CellCoords holds cell coordinates (row, column) and few method to validate them and retrieve as an array or an object.
+ * @description
+ *
+ * The `CellCoords` class holds the coordinates (`row`, `col`) of a single cell.
  *
- * @util
+ * It also contains methods for validating the coordinates
+ * and retrieving them as an object.
+ *
+ * To import the `CellCoords` class:
+ *
+ * ```js
+ * import Handsontable, { CellCoords } from '/handsontable';
+ *
+ * // or, using modules
+ * import Handsontable, { CellCoords } from '/handsontable/base';
+ * ```
  */
 var CellCoords = /*#__PURE__*/function () {
   /**
-   * Row index.
+   * A visual row index.
    *
    * @type {number}
    */
 
   /**
-   * Column index.
+   * A visual column index.
    *
    * @type {number}
    */
@@ -49,121 +58,127 @@ var CellCoords = /*#__PURE__*/function () {
   /**
    * @type {boolean}
    */
+
   function CellCoords(row, column) {
     var isRtl = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-
     _classCallCheck(this, CellCoords);
-
     _defineProperty(this, "row", null);
-
     _defineProperty(this, "col", null);
-
     _classPrivateFieldInitSpec(this, _isRtl, {
       writable: true,
       value: false
     });
-
     _classPrivateFieldSet(this, _isRtl, isRtl);
-
     if (typeof row !== 'undefined' && typeof column !== 'undefined') {
       this.row = row;
       this.col = column;
     }
   }
+
   /**
-   * Checks if given set of coordinates is valid in context of a given Walkontable instance.
+   * Checks if the coordinates in your `CellCoords` instance are valid
+   * in the context of a given Walkontable instance.
+   *
+   * The `row` index:
+   * - Can't be negative.
+   * - Can't be higher than the total number of rows in the Walkontable instance.
+   *
+   * The `col` index:
+   * - Can't be negative.
+   * - Can't be higher than the total number of columns in the Walkontable instance.
    *
    * @param {Walkontable} wot A Walkontable instance.
-   * @returns {boolean}
+   * @returns {boolean} `true`: The coordinates are valid.
    */
-
-
   _createClass(CellCoords, [{
     key: "isValid",
     value: function isValid(wot) {
-      // is it a valid cell index (0 or higher)
+      // check if the row and column indexes are valid (0 or higher)
       if (this.row < 0 || this.col < 0) {
         return false;
-      } // is selection within total rows and columns
-
-
+      }
+      // check if the selection fits in the total of rows and columns
       if (this.row >= wot.getSetting('totalRows') || this.col >= wot.getSetting('totalColumns')) {
         return false;
       }
-
       return true;
     }
+
     /**
-     * Checks if this cell coordinates are the same as cell coordinates given as an argument.
+     * Checks if another set of coordinates (`cellCoords`)
+     * is equal to the coordinates in your `CellCoords` instance.
      *
-     * @param {CellCoords} cellCoords Cell coordinates to equal.
+     * @param {CellCoords} cellCoords Coordinates to check.
      * @returns {boolean}
      */
-
   }, {
     key: "isEqual",
     value: function isEqual(cellCoords) {
       if (cellCoords === this) {
         return true;
       }
-
       return this.row === cellCoords.row && this.col === cellCoords.col;
     }
+
     /**
-     * Checks if tested coordinates are positioned in south-east from this cell coordinates.
+     * Checks if another set of coordinates (`testedCoords`)
+     * is south-east of the coordinates in your `CellCoords` instance.
      *
-     * @param {object} testedCoords Cell coordinates to check.
+     * @param {CellCoords} testedCoords Coordinates to check.
      * @returns {boolean}
      */
-
   }, {
     key: "isSouthEastOf",
     value: function isSouthEastOf(testedCoords) {
       return this.row >= testedCoords.row && (_classPrivateFieldGet(this, _isRtl) ? this.col <= testedCoords.col : this.col >= testedCoords.col);
     }
+
     /**
-     * Checks if tested coordinates are positioned in north-east from this cell coordinates.
+     * Checks if another set of coordinates (`testedCoords`)
+     * is north-west of the coordinates in your `CellCoords` instance.
      *
-     * @param {object} testedCoords Cell coordinates to check.
+     * @param {CellCoords} testedCoords Coordinates to check.
      * @returns {boolean}
      */
-
   }, {
     key: "isNorthWestOf",
     value: function isNorthWestOf(testedCoords) {
       return this.row <= testedCoords.row && (_classPrivateFieldGet(this, _isRtl) ? this.col >= testedCoords.col : this.col <= testedCoords.col);
     }
+
     /**
-     * Checks if tested coordinates are positioned in south-west from this cell coordinates.
+     * Checks if another set of coordinates (`testedCoords`)
+     * is south-west of the coordinates in your `CellCoords` instance.
      *
-     * @param {object} testedCoords Cell coordinates to check.
+     * @param {CellCoords} testedCoords Coordinates to check.
      * @returns {boolean}
      */
-
   }, {
     key: "isSouthWestOf",
     value: function isSouthWestOf(testedCoords) {
       return this.row >= testedCoords.row && (_classPrivateFieldGet(this, _isRtl) ? this.col >= testedCoords.col : this.col <= testedCoords.col);
     }
+
     /**
-     * Checks if tested coordinates are positioned in north-east from this cell coordinates.
+     * Checks if another set of coordinates (`testedCoords`)
+     * is north-east of the coordinates in your `CellCoords` instance.
      *
-     * @param {object} testedCoords Cell coordinates to check.
+     * @param {CellCoords} testedCoords Coordinates to check.
      * @returns {boolean}
      */
-
   }, {
     key: "isNorthEastOf",
     value: function isNorthEastOf(testedCoords) {
       return this.row <= testedCoords.row && (_classPrivateFieldGet(this, _isRtl) ? this.col <= testedCoords.col : this.col >= testedCoords.col);
     }
+
     /**
-     * Normalizes the coordinates to the nearest valid position. The coordinates that point
-     * to the headers (negative values) are normalized to 0.
+     * Normalizes the coordinates in your `CellCoords` instance to the nearest valid position.
+     *
+     * Coordinates that point to headers (negative values) are normalized to `0`.
      *
      * @returns {CellCoords}
      */
-
   }, {
     key: "normalize",
     value: function normalize() {
@@ -171,23 +186,23 @@ var CellCoords = /*#__PURE__*/function () {
       this.col = this.col === null ? this.col : Math.max(this.col, 0);
       return this;
     }
+
     /**
-     * Clones the coordinates.
+     * Clones your `CellCoords` instance.
      *
      * @returns {CellCoords}
      */
-
   }, {
     key: "clone",
     value: function clone() {
       return new CellCoords(this.row, this.col, _classPrivateFieldGet(this, _isRtl));
     }
+
     /**
-     * Converts CellCoords to literal object with `row` and `col` properties.
+     * Converts your `CellCoords` instance into an object literal with `row` and `col` properties.
      *
-     * @returns {object} Returns a literal object with `row` and `col` properties.
+     * @returns {{row: number, col: number}} An object literal with `row` and `col` properties.
      */
-
   }, {
     key: "toObject",
     value: function toObject() {
@@ -197,8 +212,6 @@ var CellCoords = /*#__PURE__*/function () {
       };
     }
   }]);
-
   return CellCoords;
 }();
-
 export default CellCoords;

package/3rdparty/walkontable/src/cell/range.d.ts

@@ -1,7 +1,9 @@
 import CellCoords from './coords';
 
+type DirectionType = 'NW-SE' | 'NE-SW' | 'SE-NW' | 'SW-NE';
+
 export default class CellRange {
-  constructor(highlight: CellCoords, from?: CellCoords, to?: CellCoords);
+  constructor(highlight: CellCoords, from?: CellCoords, to?: CellCoords, isRtl?: boolean);
 
   highlight: CellCoords;
   from: CellCoords;
@@ -16,6 +18,7 @@ export default class CellRange {
   getOuterWidth(): number;
   getHeight(): number;
   getWidth(): number;
+  getCellsCount(): number;
   includes(cellCoords: CellCoords): boolean;
   includesRange(cellRange: CellRange): boolean;
   isEqual(cellRange: CellRange): boolean;
@@ -26,34 +29,34 @@ export default class CellRange {
   isOverlappingVertically(cellRange: CellRange): boolean;
   expand(cellCoords: CellCoords): boolean;
   expandByRange(expandingRange: CellRange): boolean;
-  getDirection(): string;
-  setDirection(direction: string): void;
-  getVerticalDirection(): string;
-  getHorizontalDirection(): string;
+  getDirection(): DirectionType;
+  setDirection(direction: DirectionType): void;
+  getVerticalDirection(): 'N-S' | 'S-N';
+  getHorizontalDirection(): 'W-E' | 'E-W';
   flipDirectionVertically(): void;
   flipDirectionHorizontally(): void;
   getTopStartCorner(): CellCoords;
-  getTopEndCorner(): CellCoords;
-  getBottomStartCorner(): CellCoords;
-  getBottomEndCorner(): CellCoords;
   getTopLeftCorner(): CellCoords;
+  getBottomEndCorner(): CellCoords;
+  getBottomRightCorner(): CellCoords;
+  getTopEndCorner(): CellCoords;
   getTopRightCorner(): CellCoords;
+  getBottomStartCorner(): CellCoords;
   getBottomLeftCorner(): CellCoords;
-  getBottomRightCorner(): CellCoords;
   getOuterTopStartCorner(): CellCoords;
-  getOuterTopEndCorner(): CellCoords;
   getOuterTopLeftCorner(): CellCoords;
+  getOuterBottomEndCorner(): CellCoords;
+  getOuterBottomRightCorner(): CellCoords;
+  getOuterTopEndCorner(): CellCoords;
   getOuterTopRightCorner(): CellCoords;
   getOuterBottomStartCorner(): CellCoords;
-  getOuterBottomEndCorner(): CellCoords;
   getOuterBottomLeftCorner(): CellCoords;
-  getOuterBottomRightCorner(): CellCoords;
   isCorner(coords: CellCoords, expandedRange?: CellRange): boolean;
   getOppositeCorner(coords: CellCoords, expandedRange?: CellRange): CellCoords;
-  getBordersSharedWith(range: CellRange): any[];
-  getInner(): any[];
-  getAll(): any[];
+  getBordersSharedWith(range: CellRange): Array<'top' | 'right' | 'bottom' | 'left'>;
+  getInner(): CellCoords[];
+  getAll(): CellCoords[];
   forAll(callback: (row: number, column: number) => boolean): void;
   clone(): CellRange;
-  toObject(): any;
+  toObject(): { from: { row: number, col: number}, to: { row: number, col: number} };
 }