handsontable 0.0.0-next-3e92a2d-20221130 → 0.0.0-next-4a99ab8-20221201

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

@@ -1,5 +1,5 @@
 export default class CellCoords {
-  constructor(row: number, column: number);
+  constructor(row: number, column: number, isRtl?: boolean);
 
   row: number;
   col: number;

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

@@ -19,20 +19,33 @@ function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _
 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
  *
- * @util
+ * The `CellCoords` class holds the coordinates (`row`, `col`) of a single cell.
+ *
+ * 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}
    */
@@ -58,19 +71,28 @@ var CellCoords = /*#__PURE__*/function () {
   }
 
   /**
-   * 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;
       }
@@ -78,9 +100,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -93,9 +116,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -105,9 +129,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -117,9 +142,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -129,9 +155,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -141,8 +168,9 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
@@ -155,7 +183,7 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * Clones the coordinates.
+     * Clones your `CellCoords` instance.
      *
      * @returns {CellCoords}
      */
@@ -166,9 +194,9 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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",

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

@@ -15,20 +15,33 @@ function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _
 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
  *
- * @util
+ * The `CellCoords` class holds the coordinates (`row`, `col`) of a single cell.
+ *
+ * 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}
    */
@@ -54,19 +67,28 @@ var CellCoords = /*#__PURE__*/function () {
   }
 
   /**
-   * 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;
       }
@@ -74,9 +96,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -89,9 +112,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -101,9 +125,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -113,9 +138,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -125,9 +151,10 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
   }, {
@@ -137,8 +164,9 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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}
      */
@@ -151,7 +179,7 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * Clones the coordinates.
+     * Clones your `CellCoords` instance.
      *
      * @returns {CellCoords}
      */
@@ -162,9 +190,9 @@ var CellCoords = /*#__PURE__*/function () {
     }
 
     /**
-     * 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",

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} };
 }