handsontable 14.3.0 → 14.4.0-next-f62dd73-20240521

package/base.js

@@ -45,8 +45,8 @@ Handsontable.hooks = _pluginHooks.default.getSingleton();
 Handsontable.CellCoords = _src.CellCoords;
 Handsontable.CellRange = _src.CellRange;
 Handsontable.packageName = 'handsontable';
-Handsontable.buildDate = "16/04/2024 10:23:11";
-Handsontable.version = "14.3.0";
+Handsontable.buildDate = "21/05/2024 10:09:58";
+Handsontable.version = "14.4.0-next-f62dd73-20240521";
 Handsontable.languages = {
   dictionaryKeys: _registry.dictionaryKeys,
   getLanguageDictionary: _registry.getLanguageDictionary,

package/base.mjs

@@ -35,8 +35,8 @@ Handsontable.hooks = Hooks.getSingleton();
 Handsontable.CellCoords = CellCoords;
 Handsontable.CellRange = CellRange;
 Handsontable.packageName = 'handsontable';
-Handsontable.buildDate = "16/04/2024 10:23:22";
-Handsontable.version = "14.3.0";
+Handsontable.buildDate = "21/05/2024 10:10:04";
+Handsontable.version = "14.4.0-next-f62dd73-20240521";
 Handsontable.languages = {
   dictionaryKeys,
   getLanguageDictionary,

package/core.d.ts

@@ -25,8 +25,8 @@ type AlterActions = 'insert_row_above' | 'insert_row_below' |
                     'remove_row' | 'remove_col';
 
 export default class Core {
-  addHook<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>): void;
-  addHookOnce<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>): void;
+  addHook<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>, orderIndex?: number): void;
+  addHookOnce<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>, orderIndex?: number): void;
   alter(action: AlterActions, index?: number | Array<[number, number]>, amount?: number, source?: string, keepEmptyRows?: boolean): void;
   batch<R>(wrappedOperations: () => R): R;
   batchExecution<R>(wrappedOperations: () => R, forceFlushChanges: boolean): R;

package/core.js

@@ -4,6 +4,13 @@ exports.__esModule = true;
 exports.default = Core;
 require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.set.difference.v2.js");
+require("core-js/modules/esnext.set.intersection.v2.js");
+require("core-js/modules/esnext.set.is-disjoint-from.v2.js");
+require("core-js/modules/esnext.set.is-subset-of.v2.js");
+require("core-js/modules/esnext.set.is-superset-of.v2.js");
+require("core-js/modules/esnext.set.symmetric-difference.v2.js");
+require("core-js/modules/esnext.set.union.v2.js");
 require("core-js/modules/web.immediate.js");
 var _element = require("./helpers/dom/element");
 var _function = require("./helpers/function");
@@ -330,7 +337,7 @@ function Core(rootElement, userSettings) {
       hiddenIndexesChanged
     } = _ref;
     if (hiddenIndexesChanged) {
-      this.selection.refresh();
+      this.selection.commit();
     }
   };
   this.columnIndexMapper.addLocalHook('cacheUpdated', onIndexMapperCacheUpdate);
@@ -365,7 +372,11 @@ function Core(rootElement, userSettings) {
     } else {
       (0, _element.removeClass)(this.rootElement, ['ht__selection--rows', 'ht__selection--columns']);
     }
-    this._refreshBorders(null);
+    if (selection.getSelectionSource() !== 'shift') {
+      editorManager.closeEditor(null);
+    }
+    instance.view.render();
+    editorManager.prepareEditor();
   });
   this.selection.addLocalHook('beforeSetFocus', cellCoords => {
     this.runHooks('beforeSelectionFocusSet', cellCoords.row, cellCoords.col);
@@ -376,7 +387,9 @@ function Core(rootElement, userSettings) {
     if (!preventScrolling.isTouched() || preventScrolling.isTouched() && !preventScrolling.value) {
       viewportScroller.scrollTo(cellCoords);
     }
-    this._refreshBorders(null);
+    editorManager.closeEditor();
+    instance.view.render();
+    editorManager.prepareEditor();
   });
   this.selection.addLocalHook('afterSelectionFinished', cellRanges => {
     const selectionLayerLevel = cellRanges.length - 1;
@@ -394,8 +407,8 @@ function Core(rootElement, userSettings) {
     }
   });
   this.selection.addLocalHook('afterDeselect', () => {
-    editorManager.destroyEditor();
-    this._refreshBorders();
+    editorManager.closeEditor();
+    instance.view.render();
     (0, _element.removeClass)(this.rootElement, ['ht__selection--rows', 'ht__selection--columns']);
     this.runHooks('afterDeselect');
   });
@@ -550,39 +563,7 @@ function Core(rootElement, userSettings) {
             source,
             mode: insertRowMode
           });
-          if (rowDelta) {
-            const currentSelectedRange = selection.selectedRange.current();
-            const currentFromRange = currentSelectedRange === null || currentSelectedRange === void 0 ? void 0 : currentSelectedRange.from;
-            const currentFromRow = currentFromRange === null || currentFromRange === void 0 ? void 0 : currentFromRange.row;
-            const startVisualRowIndex = instance.toVisualRow(startRowPhysicalIndex);
-            if (selection.isSelectedByCorner()) {
-              selection.selectAll(true, true, {
-                disableHeadersHighlight: true
-              });
-            } else if ((0, _mixed.isDefined)(currentFromRow) && currentFromRow >= startVisualRowIndex) {
-              // Moving the selection (if it exists) downward – it should be applied to the "old" row.
-              // TODO: The logic here should be handled by selection module.
-              const {
-                row: currentToRow,
-                col: currentToColumn
-              } = currentSelectedRange.to;
-              let currentFromColumn = currentFromRange.col;
-
-              // Workaround: headers are not stored inside selection.
-              if (selection.isSelectedByRowHeader()) {
-                currentFromColumn = -1;
-              }
-
-              // Remove from the stack the last added selection as that selection below will be
-              // replaced by new transformed selection.
-              selection.getSelectedRange().pop();
-              // I can't use transforms as they don't work in negative indexes.
-              selection.setRangeStartOnly(instance._createCellCoords(currentFromRow + rowDelta, currentFromColumn), true);
-              selection.setRangeEnd(instance._createCellCoords(currentToRow + rowDelta, currentToColumn)); // will call render() internally
-            } else {
-              instance._refreshBorders(); // it will call render and prepare methods
-            }
-          }
+          selection.shiftRows(instance.toVisualRow(startRowPhysicalIndex), rowDelta);
           break;
         case 'insert_col_start':
         case 'insert_col_end':
@@ -605,38 +586,7 @@ function Core(rootElement, userSettings) {
               spliceArray.length += colDelta; // inserts empty (undefined) elements at the end of an array
               Array.prototype.splice.apply(tableMeta.colHeaders, spliceArray); // inserts empty (undefined) elements into the colHeader array
             }
-            const currentSelectedRange = selection.selectedRange.current();
-            const currentFromRange = currentSelectedRange === null || currentSelectedRange === void 0 ? void 0 : currentSelectedRange.from;
-            const currentFromColumn = currentFromRange === null || currentFromRange === void 0 ? void 0 : currentFromRange.col;
-            const startVisualColumnIndex = instance.toVisualColumn(startColumnPhysicalIndex);
-            if (selection.isSelectedByCorner()) {
-              selection.selectAll(true, true, {
-                disableHeadersHighlight: true
-              });
-            } else if ((0, _mixed.isDefined)(currentFromColumn) && currentFromColumn >= startVisualColumnIndex) {
-              // Moving the selection (if it exists) rightward – it should be applied to the "old" column.
-              // TODO: The logic here should be handled by selection module.
-              const {
-                row: currentToRow,
-                col: currentToColumn
-              } = currentSelectedRange.to;
-              let currentFromRow = currentFromRange.row;
-
-              // Workaround: headers are not stored inside selection.
-              if (selection.isSelectedByColumnHeader()) {
-                currentFromRow = -1;
-              }
-
-              // Remove from the stack the last added selection as that selection below will be
-              // replaced by new transformed selection.
-              selection.getSelectedRange().pop();
-
-              // I can't use transforms as they don't work in negative indexes.
-              selection.setRangeStartOnly(instance._createCellCoords(currentFromRow, currentFromColumn + colDelta), true);
-              selection.setRangeEnd(instance._createCellCoords(currentToRow, currentToColumn + colDelta)); // will call render() internally
-            } else {
-              instance._refreshBorders(); // it will call render and prepare methods
-            }
+            selection.shiftColumns(instance.toVisualColumn(startColumnPhysicalIndex), colDelta);
           }
           break;
         case 'remove_row':
@@ -661,7 +611,22 @@ function Core(rootElement, userSettings) {
               if (!wasRemoved) {
                 return;
               }
+              if (selection.isSelected()) {
+                const {
+                  row
+                } = instance.getSelectedRangeLast().highlight;
+                if (row >= groupIndex && row <= groupIndex + groupAmount - 1) {
+                  editorManager.closeEditor(true);
+                }
+              }
               const totalRows = instance.countRows();
+              if (totalRows === 0) {
+                selection.deselect();
+              } else if (source === 'ContextMenu.removeRow') {
+                selection.refresh();
+              } else {
+                selection.shiftRows(groupIndex, -groupAmount);
+              }
               const fixedRowsTop = tableMeta.fixedRowsTop;
               if (fixedRowsTop >= calcIndex + 1) {
                 tableMeta.fixedRowsTop -= Math.min(groupAmount, fixedRowsTop - calcIndex);
@@ -678,8 +643,6 @@ function Core(rootElement, userSettings) {
           } else {
             removeRow([[index, amount]]);
           }
-          grid.adjustRowsAndCols();
-          instance._refreshBorders(); // it will call render and prepare methods
           break;
         case 'remove_col':
           const removeCol = indexes => {
@@ -704,6 +667,22 @@ function Core(rootElement, userSettings) {
               if (!wasRemoved) {
                 return;
               }
+              if (selection.isSelected()) {
+                const {
+                  col
+                } = instance.getSelectedRangeLast().highlight;
+                if (col >= groupIndex && col <= groupIndex + groupAmount - 1) {
+                  editorManager.closeEditor(true);
+                }
+              }
+              const totalColumns = instance.countCols();
+              if (totalColumns === 0) {
+                selection.deselect();
+              } else if (source === 'ContextMenu.removeColumn') {
+                selection.refresh();
+              } else {
+                selection.shiftColumns(groupIndex, -groupAmount);
+              }
               const fixedColumnsStart = tableMeta.fixedColumnsStart;
               if (fixedColumnsStart >= calcIndex + 1) {
                 tableMeta.fixedColumnsStart -= Math.min(groupAmount, fixedColumnsStart - calcIndex);
@@ -722,13 +701,11 @@ function Core(rootElement, userSettings) {
           } else {
             removeCol([[index, amount]]);
           }
-          grid.adjustRowsAndCols();
-          instance._refreshBorders(); // it will call render and prepare methods
-
           break;
         default:
           throw new Error(`There is no such action "${action}"`);
       }
+      instance.view.render();
       if (!keepEmptyRows) {
         grid.adjustRowsAndCols(); // makes sure that we did not add rows that will be removed in next refresh
       }
@@ -743,9 +720,6 @@ function Core(rootElement, userSettings) {
       const minSpareRows = tableMeta.minSpareRows;
       const minCols = tableMeta.minCols;
       const minSpareCols = tableMeta.minSpareCols;
-      if (instance.countRows() === 0 && instance.countCols() === 0) {
-        selection.deselect();
-      }
       if (minRows) {
         // should I add empty rows to data source to meet minRows?
         const nrOfRows = instance.countRows();
@@ -804,55 +778,6 @@ function Core(rootElement, userSettings) {
           });
         }
       }
-      if (selection.isSelected()) {
-        const rowCount = instance.countRows();
-        const colCount = instance.countCols();
-        (0, _array.arrayEach)(selection.selectedRange, range => {
-          let selectionChanged = false;
-          let fromRow = range.from.row;
-          let fromCol = range.from.col;
-          let toRow = range.to.row;
-          let toCol = range.to.col;
-
-          // if selection is outside, move selection to last row
-          if (fromRow > rowCount - 1) {
-            fromRow = rowCount - 1;
-            selectionChanged = true;
-            if (toRow > fromRow) {
-              toRow = fromRow;
-            }
-          } else if (toRow > rowCount - 1) {
-            toRow = rowCount - 1;
-            selectionChanged = true;
-            if (fromRow > toRow) {
-              fromRow = toRow;
-            }
-          }
-          // if selection is outside, move selection to last row
-          if (fromCol > colCount - 1) {
-            fromCol = colCount - 1;
-            selectionChanged = true;
-            if (toCol > fromCol) {
-              toCol = fromCol;
-            }
-          } else if (toCol > colCount - 1) {
-            toCol = colCount - 1;
-            selectionChanged = true;
-            if (fromCol > toCol) {
-              fromCol = toCol;
-            }
-          }
-          if (selectionChanged) {
-            if (fromCol < 0) {
-              instance.selectRows(fromRow, toRow, fromCol);
-            } else if (fromRow < 0) {
-              instance.selectColumns(fromCol, toCol, fromRow);
-            } else {
-              instance.selectCell(fromRow, fromCol, toRow, toCol);
-            }
-          }
-        });
-      }
       if (instance.view) {
         instance.view.adjustElementsSize();
       }
@@ -1197,8 +1122,18 @@ function Core(rootElement, userSettings) {
     };
     for (let i = changes.length - 1; i >= 0; i--) {
       const [row, prop,, newValue] = changes[i];
-      const col = datamap.propToCol(prop);
-      const cellProperties = instance.getCellMeta(row, col);
+      const visualCol = datamap.propToCol(prop);
+      let cellProperties;
+      if (Number.isInteger(visualCol)) {
+        cellProperties = instance.getCellMeta(row, visualCol);
+      } else {
+        // If there's no requested visual column, we can use the table meta as the cell properties when retrieving
+        // the cell validator.
+        cellProperties = {
+          ...Object.getPrototypeOf(tableMeta),
+          ...tableMeta
+        };
+      }
       if (cellProperties.type === 'numeric' && typeof newValue === 'string' && (0, _number.isNumericLike)(newValue)) {
         changes[i][3] = getParsedNumber(newValue);
       }
@@ -1289,9 +1224,9 @@ function Core(rootElement, userSettings) {
     instance.forceFullRender = true; // used when data was changed
     grid.adjustRowsAndCols();
     instance.runHooks('beforeChangeRender', changes, source);
-    editorManager.lockEditor();
-    instance._refreshBorders(null);
-    editorManager.unlockEditor();
+    editorManager.closeEditor();
+    instance.view.render();
+    editorManager.prepareEditor();
     instance.view.adjustElementsSize();
     instance.runHooks('afterChange', changes, source || 'edit');
     const activeEditor = instance.getActiveEditor();
@@ -1502,6 +1437,9 @@ function Core(rootElement, userSettings) {
     for (i = 0, ilen = input.length; i < ilen; i++) {
       changes.push([input[i][0], input[i][1], dataSource.getAtCell(this.toPhysicalRow(input[i][0]), input[i][1]), input[i][2]]);
     }
+
+    // TODO: I don't think `prop` should be used as `changeSource` here, but removing it would be a breaking change.
+    // We should remove it with the next major release.
     if (!changeSource && typeof row === 'object') {
       changeSource = prop;
     }
@@ -1568,7 +1506,11 @@ function Core(rootElement, userSettings) {
   this.destroyEditor = function () {
     let revertOriginal = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     let prepareEditorIfNeeded = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-    instance._refreshBorders(revertOriginal, prepareEditorIfNeeded);
+    editorManager.closeEditor(revertOriginal);
+    instance.view.render();
+    if (prepareEditorIfNeeded && selection.isSelected()) {
+      editorManager.prepareEditor();
+    }
   };
 
   /**
@@ -1831,7 +1773,7 @@ function Core(rootElement, userSettings) {
       if (this.renderCall) {
         this.render();
       } else {
-        this._refreshBorders(null);
+        instance.view.render();
       }
     }
   };
@@ -1852,9 +1794,7 @@ function Core(rootElement, userSettings) {
       this.forceFullRender = true; // used when data was changed
 
       if (!this.isRenderSuspended()) {
-        editorManager.lockEditor();
-        this._refreshBorders(null);
-        editorManager.unlockEditor();
+        instance.view.render();
       }
     }
   };
@@ -2121,6 +2061,7 @@ function Core(rootElement, userSettings) {
       instance.columnIndexMapper.fitToLength(this.getInitialColumnCount());
       instance.rowIndexMapper.fitToLength(this.countSourceRows());
       grid.adjustRowsAndCols();
+      selection.refresh();
     }, {
       hotInstance: instance,
       dataMap: datamap,
@@ -2161,6 +2102,7 @@ function Core(rootElement, userSettings) {
       metaManager.clearCellsCache();
       instance.initIndexMappers();
       grid.adjustRowsAndCols();
+      selection.refresh();
       if (firstRun) {
         firstRun = [null, 'loadData'];
       }
@@ -2448,10 +2390,8 @@ function Core(rootElement, userSettings) {
     grid.adjustRowsAndCols();
     if (instance.view && !firstRun) {
       instance.forceFullRender = true; // used when data was changed
-      editorManager.lockEditor();
-      instance._refreshBorders(null);
+      instance.view.render();
       instance.view._wt.wtOverlays.adjustElementsSize();
-      editorManager.unlockEditor();
     }
     if (!init && instance.view && (currentHeight === '' || height === '' || height === undefined) && currentHeight !== height) {
       instance.view._wt.wtOverlays.updateMainScrollableElements();
@@ -2603,7 +2543,7 @@ function Core(rootElement, userSettings) {
       }
       renderableRowIndex = this.rowIndexMapper.getRenderableFromVisualIndex(row);
     }
-    if (renderableRowIndex === null || renderableColumnIndex === null) {
+    if (renderableRowIndex === null || renderableColumnIndex === null || renderableRowIndex === undefined || renderableColumnIndex === undefined) {
       return null;
     }
     return instance.view.getCellAtCoords(instance._createCellCoords(renderableRowIndex, renderableColumnIndex), topmost);
@@ -4349,13 +4289,17 @@ function Core(rootElement, userSettings) {
    * @see Hooks#add
    * @param {string} key Hook name (see {@link Hooks}).
    * @param {Function|Array} callback Function or array of functions.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    * @example
    * ```js
    * hot.addHook('beforeInit', myCallback);
    * ```
    */
-  this.addHook = function (key, callback) {
-    _pluginHooks.default.getSingleton().add(key, callback, instance);
+  this.addHook = function (key, callback, orderIndex) {
+    _pluginHooks.default.getSingleton().add(key, callback, instance, orderIndex);
   };
 
   /**
@@ -4386,13 +4330,17 @@ function Core(rootElement, userSettings) {
    * @see Hooks#once
    * @param {string} key Hook name (see {@link Hooks}).
    * @param {Function|Array} callback Function or array of functions.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    * @example
    * ```js
    * hot.addHookOnce('beforeInit', myCallback);
    * ```
    */
-  this.addHookOnce = function (key, callback) {
-    _pluginHooks.default.getSingleton().once(key, callback, instance);
+  this.addHookOnce = function (key, callback, orderIndex) {
+    _pluginHooks.default.getSingleton().once(key, callback, instance, orderIndex);
   };
 
   /**
@@ -4529,23 +4477,6 @@ function Core(rootElement, userSettings) {
     });
   };
 
-  /**
-   * Refresh selection borders. This is temporary method relic after selection rewrite.
-   *
-   * @private
-   * @param {boolean} [revertOriginal=false] If `true`, the previous value will be restored. Otherwise, the edited value will be saved.
-   * @param {boolean} [prepareEditorIfNeeded=true] If `true` the editor under the selected cell will be prepared to open.
-   */
-  this._refreshBorders = function () {
-    let revertOriginal = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-    let prepareEditorIfNeeded = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-    editorManager.destroyEditor(revertOriginal);
-    instance.view.render();
-    if (prepareEditorIfNeeded && selection.isSelected()) {
-      editorManager.prepareEditor();
-    }
-  };
-
   /**
    * Gets the instance of the EditorManager.
    *