handsontable 0.0.0-next-50e428d-20231026 → 0.0.0-next-e54c3d6-20231026

package/helpers/mixed.js

@@ -134,7 +134,7 @@ const domMessages = {
 function _injectProductInfo(key, element) {
   const hasValidType = !isEmpty(key);
   const isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  const hotVersion = "0.0.0-next-50e428d-20231026";
+  const hotVersion = "0.0.0-next-e54c3d6-20231026";
   let keyValidityDate;
   let consoleMessageState = 'invalid';
   let domMessageState = 'invalid';

package/helpers/mixed.mjs

@@ -124,7 +124,7 @@ const domMessages = {
 export function _injectProductInfo(key, element) {
   const hasValidType = !isEmpty(key);
   const isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  const hotVersion = "0.0.0-next-50e428d-20231026";
+  const hotVersion = "0.0.0-next-e54c3d6-20231026";
   let keyValidityDate;
   let consoleMessageState = 'invalid';
   let domMessageState = 'invalid';

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/handsontable/handsontable/issues"
   },
   "author": "Handsoncode <hello@handsontable.com>",
-  "version": "0.0.0-next-50e428d-20231026",
+  "version": "0.0.0-next-e54c3d6-20231026",
   "main": "index",
   "module": "index.mjs",
   "jsnext:main": "index.mjs",

package/pluginHooks.d.ts

@@ -49,6 +49,7 @@ interface HookHighlightRowHeaderMeta {
   selectionHeight: number;
   classNames: string[];
 }
+
 interface HookHighlightColumnHeaderMeta {
   selectionType: string;
   columnCursor: number;
@@ -56,6 +57,27 @@ interface HookHighlightColumnHeaderMeta {
   classNames: string[];
 }
 
+interface ClipboardData {
+  removeRows: (rows: number[]) => void;
+  removeColumns: (columns: number[]) => void;
+  insertAtRow: (rowIndex: number, values: any[]) => void;
+  insertAtColumn: (columnIndex: number, values: any[]) => void;
+  getCellAt: (row: number, col: number) => string;
+  setCellAt: (row: number, column: number, value: any) => void;
+  getData: () => any[][];
+  getMetaInfo: () => GridSettings;
+  getType: () => 'handsontable' | 'table' | 'unrecognizable';
+}
+
+interface PasteClipboardData extends ClipboardData {
+  getType: () => 'handsontable' | 'table' | 'unrecognizable';
+}
+
+interface CopyClipboardData extends ClipboardData {
+  getRanges: () => RangeType[];
+  getType: () => 'handsontable';
+}
+
 export interface Events {
   afterAddChild?: (parent: RowObject, element: RowObject | undefined, index: number | undefined) => void;
   afterAutofill?: (fillData: CellValue[][], sourceRange: CellRange, targetRange: CellRange, direction: 'up' | 'down' | 'left' | 'right') => void;
@@ -74,11 +96,11 @@ export interface Events {
   afterContextMenuDefaultOptions?: (predefinedItems: Array<ContextMenuPredefinedMenuItemKey | ContextMenuMenuItemConfig>) => void;
   afterContextMenuHide?: (context: ContextMenu) => void;
   afterContextMenuShow?: (context: ContextMenu) => void;
-  afterCopy?: (data: CellValue[][], coords: RangeType[], copiedHeadersCount: { columnHeadersCount: number }) => void;
+  afterCopy?: (clipboardData: CopyClipboardData) => void;
   afterCopyLimit?: (selectedRows: number, selectedColumns: number, copyRowsLimit: number, copyColumnsLimit: number) => void;
   afterCreateCol?: (index: number, amount: number, source?: ChangeSource) => void;
   afterCreateRow?: (index: number, amount: number, source?: ChangeSource) => void;
-  afterCut?: (data: CellValue[][], coords: RangeType[]) => void;
+  afterCut?: (clipboardData: CopyClipboardData) => void;
   afterDeselect?: () => void;
   afterDestroy?: () => void;
   afterDetachChild?: (parent: RowObject, element: RowObject) => void;
@@ -113,7 +135,7 @@ export interface Events {
   afterOnCellMouseOut?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement) => void;
   afterOnCellMouseOver?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement) => void;
   afterOnCellMouseUp?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement) => void;
-  afterPaste?: (data: CellValue[][], coords: RangeType[]) => void;
+  afterPaste?: (clipboardData: PasteClipboardData) => void;
   afterPluginsInitialized?: () => void;
   afterRedo?: (action: UndoRedoAction) => void;
   afterRedoStackChange?: (undoneActionsBefore: UndoRedoAction[], undoneActionsAfter: UndoRedoAction[]) => void;
@@ -172,10 +194,10 @@ export interface Events {
   beforeColumnUnfreeze?: (columnIndex: number, isUnfreezingPerformed: boolean) => void | boolean;
   beforeContextMenuSetItems?: (menuItems: ContextMenuMenuItemConfig[]) => void;
   beforeContextMenuShow?: (context: ContextMenu) => void;
-  beforeCopy?: (data: CellValue[][], coords: RangeType[], copiedHeadersCount: { columnHeadersCount: number }) => void | boolean;
+  beforeCopy?: (clipboardData: CopyClipboardData) => void | boolean;
   beforeCreateCol?: (index: number, amount: number, source?: ChangeSource) => void | boolean;
   beforeCreateRow?: (index: number, amount: number, source?: ChangeSource) => void | boolean;
-  beforeCut?: (data: CellValue[][], coords: RangeType[]) => void | boolean;
+  beforeCut?: (clipboardData: CopyClipboardData) => void | boolean;
   beforeDetachChild?: (parent: RowObject, element: RowObject) => void;
   beforeDrawBorders?: (corners: number[], borderClassName: 'current' | 'area' | 'highlight' | undefined) => void;
   beforeDropdownMenuSetItems?: (menuItems: ContextMenuMenuItemConfig[]) => void;
@@ -197,7 +219,7 @@ export interface Events {
   beforeOnCellMouseOut?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement) => void;
   beforeOnCellMouseOver?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement, controller: SelectionController) => void;
   beforeOnCellMouseUp?: (event: MouseEvent, coords: CellCoords, TD: HTMLTableCellElement) => void;
-  beforePaste?: (data: CellValue[][], coords: RangeType[]) => void | boolean;
+  beforePaste?: (clipboardData: PasteClipboardData) => boolean | void;
   beforeRedo?: (action: UndoRedoAction) => void;
   beforeRedoStackChange?: (undoneActions: UndoRedoAction[]) => void;
   beforeRefreshDimensions?: (previousDimensions: object, currentDimensions: object, actionPossible: boolean) => boolean | void;

package/pluginHooks.js

@@ -1505,26 +1505,35 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin before copying the values to the clipboard and before clearing values of
  * the selected cells. This hook is fired when {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforeCut
- * @param {Array[]} data An array of arrays which contains data to cut.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       which will be cut out.
+ * @param {object} clipboardData Information about cut action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  * @returns {*} If returns `false` then operation of the cutting out is canceled.
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * new Handsontable(element, {
- *   beforeCut: function(data, coords) {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCut: function(clipboardData) {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * // To cancel a cutting action, just return `false`.
  * new Handsontable(element, {
- *   beforeCut: function(data, coords) {
+ *   beforeCut: function(clipboardData) {
  *     return false;
  *   }
  * });
@@ -1533,18 +1542,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * <HotTable
- *   beforeCut={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCut={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * // To cancel a cutting action, just return `false`.
  * <HotTable
- *   beforeCut={(data, coords) => {
+ *   beforeCut={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1556,33 +1565,50 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data was cut out from the table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterCut
- * @param {Array[]} data An array of arrays with the cut data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       which was cut out.
+ * @param {object} clipboardData Information about already performed cut action.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  */
 'afterCut',
 /**
  * Fired before values are copied to the clipboard.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforeCopy
- * @param {Array[]} data An array of arrays which contains data to copied.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                         which will copied.
- * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
+ * @param {object} clipboardData Information about copy action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  * @returns {*} If returns `false` then copying is canceled.
  *
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCopy: (clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * ...
@@ -1590,7 +1616,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (data, coords) => {
+ *   beforeCopy: (clipboardData) => {
  *     return false;
  *   }
  * });
@@ -1600,14 +1626,14 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * ...
  * <HotTable
- *   beforeCopy={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCopy={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * ...
@@ -1615,7 +1641,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * <HotTable
- *   beforeCopy={(data, coords) => {
+ *   beforeCopy={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1628,37 +1654,55 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data are pasted into table. This hook is fired when {@link Options#copyPaste}
  * option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterCopy
- * @param {Array[]} data An array of arrays which contains the copied data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                         which was copied.
- * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
+ * @param {object} clipboardData Information about already performed copy action.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  */
 'afterCopy',
 /**
  * Fired by {@link CopyPaste} plugin before values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforePaste
- * @param {Array[]} data An array of arrays which contains data to paste.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       that correspond to the previously selected area.
+ * @param {object} clipboardData Information about paste action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getSource Gets information about source of the copied data
+ * (Handsontable, table or string).
  * @returns {*} If returns `false` then pasting is canceled.
  * @example
  * ```js
  * ::: only-for javascript
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * new Handsontable(example, {
- *   beforePaste: (data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforePaste: (clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * // To cancel pasting, return false from the callback.
  * new Handsontable(example, {
- *   beforePaste: (data, coords) => {
+ *   beforePaste: (clipboardData) => {
  *     return false;
  *   }
  * });
@@ -1667,18 +1711,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * <HotTable
- *   beforePaste={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforePaste={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * // To cancel pasting, return false from the callback.
  * <HotTable
- *   beforePaste={(data, coords) => {
+ *   beforePaste={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1690,10 +1734,20 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterPaste
- * @param {Array[]} data An array of arrays with the pasted data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       that correspond to the previously selected area.
+ * @param {object} clipboardData Information about already performed paste action.
+ * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getSource Gets information about source of the copied data
+ * (Handsontable, table or string).
  */
 'afterPaste',
 /**