handsontable 14.0.0-next-c22ab6f-20231030 → 14.0.0-next-f88c253-20231106

package/plugins/copyPaste/copyPaste.mjs

@@ -14,7 +14,8 @@ function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!priva
 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; } }
 import { BasePlugin } from "../base/index.mjs";
 import Hooks from "../../pluginHooks.mjs";
-import { stringify } from "../../3rdparty/SheetClip/index.mjs";
+import { stringify, parse } from "../../3rdparty/SheetClip/index.mjs";
+import { arrayEach } from "../../helpers/array.mjs";
 import { sanitize } from "../../helpers/string.mjs";
 import { removeContentEditableFromElementAndDeselect, runWithSelectedContendEditableElement, makeElementContentEditableAndSelectItsContent } from "../../helpers/dom/element.mjs";
 import { isSafari } from "../../helpers/browser.mjs";
@@ -23,10 +24,10 @@ import copyColumnHeadersOnlyItem from "./contextMenuItem/copyColumnHeadersOnly.m
 import copyWithColumnGroupHeadersItem from "./contextMenuItem/copyWithColumnGroupHeaders.mjs";
 import copyWithColumnHeadersItem from "./contextMenuItem/copyWithColumnHeaders.mjs";
 import cutItem from "./contextMenuItem/cut.mjs";
+import PasteEvent from "./pasteEvent.mjs";
 import { CopyableRangesFactory, normalizeRanges } from "./copyableRanges.mjs";
-import { getDataByCoords, getHTMLFromConfig } from "../../utils/parseTable.mjs";
+import { _dataToHTML, htmlToGridSettings } from "../../utils/parseTable.mjs";
 import EventManager from "../../eventManager.mjs";
-import { CopyClipboardData, PasteClipboardData, META_HEAD } from "./clipboardData/index.mjs";
 Hooks.getSingleton().register('afterCopyLimit');
 Hooks.getSingleton().register('modifyCopyableRange');
 Hooks.getSingleton().register('beforeCut');
@@ -38,6 +39,7 @@ Hooks.getSingleton().register('afterCopy');
 export const PLUGIN_KEY = 'copyPaste';
 export const PLUGIN_PRIORITY = 80;
 const SETTING_KEYS = ['fragmentSelection'];
+const META_HEAD = ['<meta name="generator" content="Handsontable"/>', '<style type="text/css">td{white-space:normal}br{mso-data-placement:same-cell}</style>'].join('');
 
 /* eslint-disable jsdoc/require-description-complete-sentence */
 /**
@@ -82,6 +84,7 @@ var _isTriggeredByCopy = /*#__PURE__*/new WeakMap();
 var _isTriggeredByCut = /*#__PURE__*/new WeakMap();
 var _copyableRangesFactory = /*#__PURE__*/new WeakMap();
 var _ensureClipboardEventsGetTriggered = /*#__PURE__*/new WeakSet();
+var _countCopiedHeaders = /*#__PURE__*/new WeakSet();
 var _addContentEditableToHighlightedCell = /*#__PURE__*/new WeakSet();
 var _removeContentEditableFromHighlightedCell = /*#__PURE__*/new WeakSet();
 export class CopyPaste extends BasePlugin {
@@ -95,6 +98,15 @@ export class CopyPaste extends BasePlugin {
      * Add the `contenteditable` attribute to the highlighted cell and select its content.
      */
     _classPrivateMethodInitSpec(this, _addContentEditableToHighlightedCell);
+    /**
+     * Counts how many column headers will be copied based on the passed range.
+     *
+     * @private
+     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
+     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
+     *                                           information with the number of copied headers.
+     */
+    _classPrivateMethodInitSpec(this, _countCopiedHeaders);
     /**
      * Ensure that the `copy`/`cut` events get triggered properly in Safari.
      *
@@ -379,14 +391,26 @@ export class CopyPaste extends BasePlugin {
    * @returns {Array[]} An array of arrays that will be copied to the clipboard.
    */
   getRangedData(ranges) {
+    const data = [];
     const {
       rows,
       columns
     } = normalizeRanges(ranges);
-    return getDataByCoords(this.hot, {
-      rows,
-      columns
+
+    // concatenate all rows and columns data defined in ranges into one copyable string
+    arrayEach(rows, row => {
+      const rowSet = [];
+      arrayEach(columns, column => {
+        if (row < 0) {
+          // `row` as the second argument acts here as the `headerLevel` argument
+          rowSet.push(this.hot.getColHeader(column, row));
+        } else {
+          rowSet.push(this.hot.getCopyableData(row, column));
+        }
+      });
+      data.push(rowSet);
     });
+    return data;
   }
 
   /**
@@ -403,17 +427,7 @@ export class CopyPaste extends BasePlugin {
     if (!pastableText && !pastableHtml) {
       return;
     }
-    const pasteData = {
-      clipboardData: {
-        data: {},
-        setData(type, value) {
-          this.data[type] = value;
-        },
-        getData(type) {
-          return this.data[type];
-        }
-      }
-    };
+    const pasteData = new PasteEvent();
     if (pastableText) {
       pasteData.clipboardData.setData('text/plain', pastableText);
     }
@@ -552,7 +566,7 @@ export class CopyPaste extends BasePlugin {
   /**
    * `copy` event callback on textarea element.
    *
-   * @param {ClipboardEvent} event ClipboardEvent.
+   * @param {Event} event ClipboardEvent.
    * @private
    */
   onCopy(event) {
@@ -561,12 +575,19 @@ export class CopyPaste extends BasePlugin {
     }
     this.setCopyableText();
     _classPrivateFieldSet(this, _isTriggeredByCopy, false);
-    const copyClipboardData = new CopyClipboardData(this.hot, this.copyableRanges);
-    const allowCopying = !!this.hot.runHooks('beforeCopy', copyClipboardData);
+    const data = this.getRangedData(this.copyableRanges);
+    const copiedHeadersCount = _classPrivateMethodGet(this, _countCopiedHeaders, _countCopiedHeaders2).call(this, this.copyableRanges);
+    const allowCopying = !!this.hot.runHooks('beforeCopy', data, this.copyableRanges, copiedHeadersCount);
     if (allowCopying) {
-      event.clipboardData.setData('text/plain', stringify(copyClipboardData.getData()));
-      event.clipboardData.setData('text/html', [copyClipboardData.getType() === 'handsontable' ? META_HEAD : '', getHTMLFromConfig(copyClipboardData.getMetaInfo())].join(''));
-      this.hot.runHooks('afterCopy', copyClipboardData);
+      const textPlain = stringify(data);
+      if (event && event.clipboardData) {
+        const textHTML = _dataToHTML(data, this.hot.rootDocument);
+        event.clipboardData.setData('text/plain', textPlain);
+        event.clipboardData.setData('text/html', [META_HEAD, textHTML].join(''));
+      } else if (typeof ClipboardEvent === 'undefined') {
+        this.hot.rootWindow.clipboardData.setData('Text', textPlain);
+      }
+      this.hot.runHooks('afterCopy', data, this.copyableRanges, copiedHeadersCount);
     }
     _classPrivateFieldSet(this, _copyMode, 'cells-only');
     event.preventDefault();
@@ -575,7 +596,7 @@ export class CopyPaste extends BasePlugin {
   /**
    * `cut` event callback on textarea element.
    *
-   * @param {ClipboardEvent} event ClipboardEvent.
+   * @param {Event} event ClipboardEvent.
    * @private
    */
   onCut(event) {
@@ -584,13 +605,19 @@ export class CopyPaste extends BasePlugin {
     }
     this.setCopyableText();
     _classPrivateFieldSet(this, _isTriggeredByCut, false);
-    const copyClipboardData = new CopyClipboardData(this.hot, this.copyableRanges);
-    const allowCuttingOut = !!this.hot.runHooks('beforeCut', copyClipboardData);
+    const rangedData = this.getRangedData(this.copyableRanges);
+    const allowCuttingOut = !!this.hot.runHooks('beforeCut', rangedData, this.copyableRanges);
     if (allowCuttingOut) {
-      event.clipboardData.setData('text/plain', stringify(copyClipboardData.getData()));
-      event.clipboardData.setData('text/html', [copyClipboardData.getType() === 'handsontable' ? META_HEAD : '', getHTMLFromConfig(copyClipboardData.getMetaInfo())].join(''));
+      const textPlain = stringify(rangedData);
+      if (event && event.clipboardData) {
+        const textHTML = _dataToHTML(rangedData, this.hot.rootDocument);
+        event.clipboardData.setData('text/plain', textPlain);
+        event.clipboardData.setData('text/html', [META_HEAD, textHTML].join(''));
+      } else if (typeof ClipboardEvent === 'undefined') {
+        this.hot.rootWindow.clipboardData.setData('Text', textPlain);
+      }
       this.hot.emptySelectedCells('CopyPaste.cut');
-      this.hot.runHooks('afterCut', copyClipboardData);
+      this.hot.runHooks('afterCut', rangedData, this.copyableRanges);
     }
     event.preventDefault();
   }
@@ -608,22 +635,34 @@ export class CopyPaste extends BasePlugin {
     if (event && event.preventDefault) {
       event.preventDefault();
     }
-    const html = sanitize(event.clipboardData.getData('text/html'), {
-      ADD_TAGS: ['meta'],
-      ADD_ATTR: ['content'],
-      FORCE_BODY: true
-    });
-    const pasteClipboardData = new PasteClipboardData(event.clipboardData.getData('text/plain'), html);
-    if (this.hot.runHooks('beforePaste', pasteClipboardData) === false) {
+    let pastedData;
+    if (event && typeof event.clipboardData !== 'undefined') {
+      const textHTML = sanitize(event.clipboardData.getData('text/html'), {
+        ADD_TAGS: ['meta'],
+        ADD_ATTR: ['content'],
+        FORCE_BODY: true
+      });
+      if (textHTML && /(<table)|(<TABLE)/g.test(textHTML)) {
+        const parsedConfig = htmlToGridSettings(textHTML, this.hot.rootDocument);
+        pastedData = parsedConfig.data;
+      } else {
+        pastedData = event.clipboardData.getData('text/plain');
+      }
+    } else if (typeof ClipboardEvent === 'undefined' && typeof this.hot.rootWindow.clipboardData !== 'undefined') {
+      pastedData = this.hot.rootWindow.clipboardData.getData('Text');
+    }
+    if (typeof pastedData === 'string') {
+      pastedData = parse(pastedData);
+    }
+    if (pastedData === void 0 || pastedData && pastedData.length === 0) {
       return;
     }
-    const pastedTable = pasteClipboardData.getData();
-    if (pastedTable.length === 0) {
+    if (this.hot.runHooks('beforePaste', pastedData, this.copyableRanges) === false) {
       return;
     }
-    const [startRow, startColumn, endRow, endColumn] = this.populateValues(pastedTable);
+    const [startRow, startColumn, endRow, endColumn] = this.populateValues(pastedData);
     this.hot.selectCell(startRow, startColumn, Math.min(this.hot.countRows() - 1, endRow), Math.min(this.hot.countCols() - 1, endColumn));
-    this.hot.runHooks('afterPaste', pasteClipboardData);
+    this.hot.runHooks('afterPaste', pastedData, this.copyableRanges);
   }
 
   /**
@@ -719,6 +758,21 @@ function _ensureClipboardEventsGetTriggered2(eventName) {
     this.hot.rootDocument.execCommand(eventName);
   }
 }
+function _countCopiedHeaders2(ranges) {
+  const {
+    rows
+  } = normalizeRanges(ranges);
+  let columnHeadersCount = 0;
+  for (let row = 0; row < rows.length; row++) {
+    if (rows[row] >= 0) {
+      break;
+    }
+    columnHeadersCount += 1;
+  }
+  return {
+    columnHeadersCount
+  };
+}
 function _addContentEditableToHighlightedCell2() {
   if (this.hot.isListening()) {
     const lastSelectedRange = this.hot.getSelectedRangeLast();

package/plugins/copyPaste/pasteEvent.js

@@ -0,0 +1,14 @@
+"use strict";
+
+exports.__esModule = true;
+var _clipboardData = _interopRequireDefault(require("./clipboardData"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * @private
+ */
+class PasteEvent {
+  constructor() {
+    this.clipboardData = new _clipboardData.default();
+  }
+}
+exports.default = PasteEvent;

package/plugins/copyPaste/pasteEvent.mjs

@@ -0,0 +1,9 @@
+import ClipboardData from "./clipboardData.mjs";
+/**
+ * @private
+ */
+export default class PasteEvent {
+  constructor() {
+    this.clipboardData = new ClipboardData();
+  }
+}

package/plugins/mergeCells/mergeCells.js

@@ -186,6 +186,9 @@ class MergeCells extends _base.BasePlugin {
     this.addHook('afterDrawSelection', function () {
       return _this.onAfterDrawSelection(...arguments);
     });
+    this.addHook('beforeRemoveCellClassNames', function () {
+      return _this.onBeforeRemoveCellClassNames(...arguments);
+    });
     this.addHook('beforeUndoStackChange', (action, source) => {
       if (source === 'MergeCells') {
         return false;
@@ -1197,5 +1200,16 @@ class MergeCells extends _base.BasePlugin {
     }
     return this.selectionCalculations.getSelectedMergedCellClassName(currentRow, currentColumn, cornersOfSelection, layerLevel);
   }
+
+  /**
+   * `beforeRemoveCellClassNames` hook callback. Used to remove additional class name from all cells in the table.
+   *
+   * @private
+   * @returns {string[]} An `Array` of `String`s. Each of these strings will act like class names to be removed from
+   *   all the cells in the table.
+   */
+  onBeforeRemoveCellClassNames() {
+    return this.selectionCalculations.getSelectedMergedCellClassNameToRemove();
+  }
 }
 exports.MergeCells = MergeCells;

package/plugins/mergeCells/mergeCells.mjs

@@ -182,6 +182,9 @@ export class MergeCells extends BasePlugin {
     this.addHook('afterDrawSelection', function () {
       return _this.onAfterDrawSelection(...arguments);
     });
+    this.addHook('beforeRemoveCellClassNames', function () {
+      return _this.onBeforeRemoveCellClassNames(...arguments);
+    });
     this.addHook('beforeUndoStackChange', (action, source) => {
       if (source === 'MergeCells') {
         return false;
@@ -1193,4 +1196,15 @@ export class MergeCells extends BasePlugin {
     }
     return this.selectionCalculations.getSelectedMergedCellClassName(currentRow, currentColumn, cornersOfSelection, layerLevel);
   }
+
+  /**
+   * `beforeRemoveCellClassNames` hook callback. Used to remove additional class name from all cells in the table.
+   *
+   * @private
+   * @returns {string[]} An `Array` of `String`s. Each of these strings will act like class names to be removed from
+   *   all the cells in the table.
+   */
+  onBeforeRemoveCellClassNames() {
+    return this.selectionCalculations.getSelectedMergedCellClassNameToRemove();
+  }
 }

package/plugins/nestedHeaders/nestedHeaders.js

@@ -529,44 +529,45 @@ class NestedHeaders extends _base.BasePlugin {
    * of the column.
    *
    * @private
-   * @param {object} clipboardData Information about already performed copy action.
-   * @param {Function} clipboardData.removeRow Remove row from the copied/pasted dataset.
-   * @param {Function} clipboardData.removeColumn Remove column from the copied/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 copied/pasted dataset.
-   * @param {Function} clipboardData.getCellAt Get headers or cells from the copied/pasted dataset.
-   * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
-   * @param {Function} clipboardData.getMetaInfo Gets grid settings for copied data.
-   * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+   * @param {Array[]} data An array of arrays which contains data to copied.
+   * @param {object[]} copyableRanges An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+   *                                  which will copied.
+   * @param {{ columnHeadersCount: number }} copiedHeadersCount An object with keys that holds information with
+   *                                                            the number of copied headers.
    */
-  onBeforeCopy(clipboardData) {
-    const copyableRanges = clipboardData.getRanges();
-    for (let rangeIndex = 0; rangeIndex < copyableRanges.length; rangeIndex += 1) {
+  onBeforeCopy(data, copyableRanges, _ref2) {
+    let {
+      columnHeadersCount
+    } = _ref2;
+    if (columnHeadersCount === 0) {
+      return;
+    }
+    for (let rangeIndex = 0; rangeIndex < copyableRanges.length; rangeIndex++) {
       const {
         startRow,
         startCol,
         endRow,
         endCol
       } = copyableRanges[rangeIndex];
+      const rowsCount = endRow - startRow + 1;
       const columnsCount = startCol - endCol + 1;
 
       // do not process dataset ranges and column headers where only one column is copied
       if (startRow >= 0 || columnsCount === 1) {
         break;
       }
-      for (let column = startCol; column <= endCol; column += 1) {
-        for (let row = startRow; row <= endRow; row += 1) {
-          var _classPrivateFieldGet4, _classPrivateFieldGet5;
+      for (let column = startCol; column <= endCol; column++) {
+        for (let row = startRow; row <= endRow; row++) {
+          var _classPrivateFieldGet4;
+          const zeroBasedColumnHeaderLevel = rowsCount + row;
           const zeroBasedColumnIndex = column - startCol;
           if (zeroBasedColumnIndex === 0) {
             continue; // eslint-disable-line no-continue
           }
 
           const isRoot = (_classPrivateFieldGet4 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(row, column)) === null || _classPrivateFieldGet4 === void 0 ? void 0 : _classPrivateFieldGet4.isRoot;
-          const collapsible = (_classPrivateFieldGet5 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(row, column)) === null || _classPrivateFieldGet5 === void 0 ? void 0 : _classPrivateFieldGet5.collapsible;
-          if (collapsible === true && isRoot === false) {
-            clipboardData.setCellAt(row, zeroBasedColumnIndex, '');
+          if (isRoot === false) {
+            data[zeroBasedColumnHeaderLevel][zeroBasedColumnIndex] = '';
           }
         }
       }
@@ -869,10 +870,10 @@ class NestedHeaders extends _base.BasePlugin {
    * @returns {string} Returns the column header value to update.
    */
   onModifyColumnHeaderValue(value, visualColumnIndex, headerLevel) {
-    var _classPrivateFieldGet6;
+    var _classPrivateFieldGet5;
     const {
       label
-    } = (_classPrivateFieldGet6 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(headerLevel, visualColumnIndex)) !== null && _classPrivateFieldGet6 !== void 0 ? _classPrivateFieldGet6 : {
+    } = (_classPrivateFieldGet5 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(headerLevel, visualColumnIndex)) !== null && _classPrivateFieldGet5 !== void 0 ? _classPrivateFieldGet5 : {
       label: ''
     };
     return label;

package/plugins/nestedHeaders/nestedHeaders.mjs

@@ -525,44 +525,45 @@ export class NestedHeaders extends BasePlugin {
    * of the column.
    *
    * @private
-   * @param {object} clipboardData Information about already performed copy action.
-   * @param {Function} clipboardData.removeRow Remove row from the copied/pasted dataset.
-   * @param {Function} clipboardData.removeColumn Remove column from the copied/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 copied/pasted dataset.
-   * @param {Function} clipboardData.getCellAt Get headers or cells from the copied/pasted dataset.
-   * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
-   * @param {Function} clipboardData.getMetaInfo Gets grid settings for copied data.
-   * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+   * @param {Array[]} data An array of arrays which contains data to copied.
+   * @param {object[]} copyableRanges An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+   *                                  which will copied.
+   * @param {{ columnHeadersCount: number }} copiedHeadersCount An object with keys that holds information with
+   *                                                            the number of copied headers.
    */
-  onBeforeCopy(clipboardData) {
-    const copyableRanges = clipboardData.getRanges();
-    for (let rangeIndex = 0; rangeIndex < copyableRanges.length; rangeIndex += 1) {
+  onBeforeCopy(data, copyableRanges, _ref2) {
+    let {
+      columnHeadersCount
+    } = _ref2;
+    if (columnHeadersCount === 0) {
+      return;
+    }
+    for (let rangeIndex = 0; rangeIndex < copyableRanges.length; rangeIndex++) {
       const {
         startRow,
         startCol,
         endRow,
         endCol
       } = copyableRanges[rangeIndex];
+      const rowsCount = endRow - startRow + 1;
       const columnsCount = startCol - endCol + 1;
 
       // do not process dataset ranges and column headers where only one column is copied
       if (startRow >= 0 || columnsCount === 1) {
         break;
       }
-      for (let column = startCol; column <= endCol; column += 1) {
-        for (let row = startRow; row <= endRow; row += 1) {
-          var _classPrivateFieldGet4, _classPrivateFieldGet5;
+      for (let column = startCol; column <= endCol; column++) {
+        for (let row = startRow; row <= endRow; row++) {
+          var _classPrivateFieldGet4;
+          const zeroBasedColumnHeaderLevel = rowsCount + row;
           const zeroBasedColumnIndex = column - startCol;
           if (zeroBasedColumnIndex === 0) {
             continue; // eslint-disable-line no-continue
           }
 
           const isRoot = (_classPrivateFieldGet4 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(row, column)) === null || _classPrivateFieldGet4 === void 0 ? void 0 : _classPrivateFieldGet4.isRoot;
-          const collapsible = (_classPrivateFieldGet5 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(row, column)) === null || _classPrivateFieldGet5 === void 0 ? void 0 : _classPrivateFieldGet5.collapsible;
-          if (collapsible === true && isRoot === false) {
-            clipboardData.setCellAt(row, zeroBasedColumnIndex, '');
+          if (isRoot === false) {
+            data[zeroBasedColumnHeaderLevel][zeroBasedColumnIndex] = '';
           }
         }
       }
@@ -865,10 +866,10 @@ export class NestedHeaders extends BasePlugin {
    * @returns {string} Returns the column header value to update.
    */
   onModifyColumnHeaderValue(value, visualColumnIndex, headerLevel) {
-    var _classPrivateFieldGet6;
+    var _classPrivateFieldGet5;
     const {
       label
-    } = (_classPrivateFieldGet6 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(headerLevel, visualColumnIndex)) !== null && _classPrivateFieldGet6 !== void 0 ? _classPrivateFieldGet6 : {
+    } = (_classPrivateFieldGet5 = _classPrivateFieldGet(this, _stateManager).getHeaderTreeNodeData(headerLevel, visualColumnIndex)) !== null && _classPrivateFieldGet5 !== void 0 ? _classPrivateFieldGet5 : {
       label: ''
     };
     return label;