handsontable 0.0.0-next-3d099da-20231208 → 0.0.0-next-51d3397-20231211

package/plugins/copyPaste/clipboardData.mjs

@@ -0,0 +1,14 @@
+/**
+ * @private
+ */
+export default class ClipboardData {
+  constructor() {
+    this.data = {};
+  }
+  setData(type, value) {
+    this.data[type] = value;
+  }
+  getData(type) {
+    return this.data[type] || void 0;
+  }
+}

package/plugins/copyPaste/copyPaste.js

@@ -6,6 +6,7 @@ require("core-js/modules/es.error.cause.js");
 var _base = require("../base");
 var _pluginHooks = _interopRequireDefault(require("../../pluginHooks"));
 var _SheetClip = require("../../3rdparty/SheetClip");
+var _array = require("../../helpers/array");
 var _string = require("../../helpers/string");
 var _element = require("../../helpers/dom/element");
 var _browser = require("../../helpers/browser");
@@ -14,11 +15,9 @@ var _copyColumnHeadersOnly = _interopRequireDefault(require("./contextMenuItem/c
 var _copyWithColumnGroupHeaders = _interopRequireDefault(require("./contextMenuItem/copyWithColumnGroupHeaders"));
 var _copyWithColumnHeaders = _interopRequireDefault(require("./contextMenuItem/copyWithColumnHeaders"));
 var _cut = _interopRequireDefault(require("./contextMenuItem/cut"));
+var _pasteEvent = _interopRequireDefault(require("./pasteEvent"));
 var _copyableRanges = require("./copyableRanges");
-var _selection = require("../../selection");
 var _parseTable = require("../../utils/parseTable");
-var _eventManager = _interopRequireDefault(require("../../eventManager"));
-var _clipboardData = require("./clipboardData");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
@@ -43,6 +42,7 @@ _pluginHooks.default.getSingleton().register('afterCopy');
 const PLUGIN_KEY = exports.PLUGIN_KEY = 'copyPaste';
 const PLUGIN_PRIORITY = exports.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 */
 /**
@@ -86,10 +86,13 @@ var _copyMode = /*#__PURE__*/new WeakMap();
 var _isTriggeredByCopy = /*#__PURE__*/new WeakMap();
 var _isTriggeredByCut = /*#__PURE__*/new WeakMap();
 var _copyableRangesFactory = /*#__PURE__*/new WeakMap();
+var _preventViewportScrollOnPaste = /*#__PURE__*/new WeakMap();
 var _ensureClipboardEventsGetTriggered = /*#__PURE__*/new WeakSet();
+var _countCopiedHeaders = /*#__PURE__*/new WeakSet();
 var _addContentEditableToHighlightedCell = /*#__PURE__*/new WeakSet();
 var _removeContentEditableFromHighlightedCell = /*#__PURE__*/new WeakSet();
 var _onAfterContextMenuDefaultOptions = /*#__PURE__*/new WeakSet();
+var _onAfterSelection = /*#__PURE__*/new WeakSet();
 var _onAfterSelectionEnd = /*#__PURE__*/new WeakSet();
 var _onSafariMouseEnter = /*#__PURE__*/new WeakSet();
 var _onSafariMouseLeave = /*#__PURE__*/new WeakSet();
@@ -99,32 +102,35 @@ class CopyPaste extends _base.BasePlugin {
     super(...arguments);
     /**
      * `afterSelection` hook callback triggered only on Safari.
-     *
-     * @private
      */
     _classPrivateMethodInitSpec(this, _onSafariAfterSelection);
     /**
      * `document.body` `mouseleave` callback used to work around a Safari's problem with copying/cutting from the
      * browser's menu.
-     *
-     * @private
      */
     _classPrivateMethodInitSpec(this, _onSafariMouseLeave);
     /**
      * `document.body` `mouseenter` callback used to work around a Safari's problem with copying/cutting from the
      * browser's menu.
-     *
-     * @private
      */
     _classPrivateMethodInitSpec(this, _onSafariMouseEnter);
     /**
      * Force focus on focusableElement after end of the selection.
      */
     _classPrivateMethodInitSpec(this, _onAfterSelectionEnd);
+    /**
+     * Disables the viewport scroll after pasting the data.
+     *
+     * @param {number} fromRow Selection start row visual index.
+     * @param {number} fromColumn Selection start column visual index.
+     * @param {number} toRow Selection end row visual index.
+     * @param {number} toColumn Selection end column visual index.
+     * @param {object} preventScrolling Object with `value` property. If `true`, the viewport scroll will be prevented.
+     */
+    _classPrivateMethodInitSpec(this, _onAfterSelection);
     /**
      * Add copy and cut options to the Context Menu.
      *
-     * @private
      * @param {object} options Contains default added options of the Context Menu.
      */
     _classPrivateMethodInitSpec(this, _onAfterContextMenuDefaultOptions);
@@ -136,6 +142,15 @@ class CopyPaste extends _base.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.
      *
@@ -252,6 +267,15 @@ class CopyPaste extends _base.BasePlugin {
         countColumnHeaders: () => this.hot.view.getColumnHeadersCount()
       })
     });
+    /**
+     * Flag that indicates if the viewport scroll should be prevented after pasting the data.
+     *
+     * @type {boolean}
+     */
+    _classPrivateFieldInitSpec(this, _preventViewportScrollOnPaste, {
+      writable: true,
+      value: false
+    });
     /**
      * Ranges of the cells coordinates, which should be used to copy/cut/paste actions.
      *
@@ -303,8 +327,13 @@ class CopyPaste extends _base.BasePlugin {
       this.uiContainer = (_settings$uiContainer = settings.uiContainer) !== null && _settings$uiContainer !== void 0 ? _settings$uiContainer : this.uiContainer;
     }
     this.addHook('afterContextMenuDefaultOptions', options => _classPrivateMethodGet(this, _onAfterContextMenuDefaultOptions, _onAfterContextMenuDefaultOptions2).call(this, options));
+    this.addHook('afterSelection', function () {
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
+      return _classPrivateMethodGet(_this, _onAfterSelection, _onAfterSelection2).call(_this, ...args);
+    });
     this.addHook('afterSelectionEnd', () => _classPrivateMethodGet(this, _onAfterSelectionEnd, _onAfterSelectionEnd2).call(this));
-    this.eventManager = new _eventManager.default(this);
     this.eventManager.addEventListener(this.hot.rootDocument, 'copy', function () {
       return _this.onCopy(...arguments);
     });
@@ -318,14 +347,14 @@ class CopyPaste extends _base.BasePlugin {
     // Without this workaround Safari (tested on Safari@16.5.2) does allow copying/cutting from the browser menu.
     if ((0, _browser.isSafari)()) {
       this.eventManager.addEventListener(this.hot.rootDocument.body, 'mouseenter', function () {
-        for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-          args[_key] = arguments[_key];
+        for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+          args[_key2] = arguments[_key2];
         }
         return _classPrivateMethodGet(_this, _onSafariMouseEnter, _onSafariMouseEnter2).call(_this, ...args);
       });
       this.eventManager.addEventListener(this.hot.rootDocument.body, 'mouseleave', function () {
-        for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-          args[_key2] = arguments[_key2];
+        for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+          args[_key3] = arguments[_key3];
         }
         return _classPrivateMethodGet(_this, _onSafariMouseLeave, _onSafariMouseLeave2).call(_this, ...args);
       });
@@ -426,14 +455,26 @@ class CopyPaste extends _base.BasePlugin {
    * @returns {Array[]} An array of arrays that will be copied to the clipboard.
    */
   getRangedData(ranges) {
+    const data = [];
     const {
       rows,
       columns
-    } = (0, _selection.transformRangeLikeToIndexes)(ranges);
-    return (0, _parseTable.getDataByCoords)(this.hot, {
-      rows,
-      columns
+    } = (0, _copyableRanges.normalizeRanges)(ranges);
+
+    // concatenate all rows and columns data defined in ranges into one copyable string
+    (0, _array.arrayEach)(rows, row => {
+      const rowSet = [];
+      (0, _array.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;
   }
 
   /**
@@ -450,17 +491,7 @@ class CopyPaste extends _base.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.default();
     if (pastableText) {
       pasteData.clipboardData.setData('text/plain', pastableText);
     }
@@ -593,6 +624,7 @@ class CopyPaste extends _base.BasePlugin {
       }
       newRows.push(newRow);
     }
+    _classPrivateFieldSet(this, _preventViewportScrollOnPaste, true);
     this.hot.populateFromArray(startRow, startColumn, newRows, undefined, undefined, 'CopyPaste.paste', this.pasteMode);
     return [startRow, startColumn, lastVisualRow, lastVisualColumn];
   }
@@ -608,12 +640,19 @@ class CopyPaste extends _base.BasePlugin {
     }
     this.setCopyableText();
     _classPrivateFieldSet(this, _isTriggeredByCopy, false);
-    const copyClipboardData = new _clipboardData.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', (0, _SheetClip.stringify)(copyClipboardData.getData()));
-      event.clipboardData.setData('text/html', [copyClipboardData.getType() === 'handsontable' ? _clipboardData.META_HEAD : '', (0, _parseTable.getHTMLFromConfig)(copyClipboardData.getMetaInfo())].join(''));
-      this.hot.runHooks('afterCopy', copyClipboardData);
+      const textPlain = (0, _SheetClip.stringify)(data);
+      if (event && event.clipboardData) {
+        const textHTML = (0, _parseTable._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();
@@ -631,13 +670,19 @@ class CopyPaste extends _base.BasePlugin {
     }
     this.setCopyableText();
     _classPrivateFieldSet(this, _isTriggeredByCut, false);
-    const copyClipboardData = new _clipboardData.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', (0, _SheetClip.stringify)(copyClipboardData.getData()));
-      event.clipboardData.setData('text/html', [copyClipboardData.getType() === 'handsontable' ? _clipboardData.META_HEAD : '', (0, _parseTable.getHTMLFromConfig)(copyClipboardData.getMetaInfo())].join(''));
+      const textPlain = (0, _SheetClip.stringify)(rangedData);
+      if (event && event.clipboardData) {
+        const textHTML = (0, _parseTable._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();
   }
@@ -655,22 +700,34 @@ class CopyPaste extends _base.BasePlugin {
     if (event && event.preventDefault) {
       event.preventDefault();
     }
-    const html = (0, _string.sanitize)(event.clipboardData.getData('text/html'), {
-      ADD_TAGS: ['meta'],
-      ADD_ATTR: ['content'],
-      FORCE_BODY: true
-    });
-    const pasteClipboardData = new _clipboardData.PasteClipboardData(event.clipboardData.getData('text/plain'), html);
-    if (this.hot.runHooks('beforePaste', pasteClipboardData) === false) {
+    let pastedData;
+    if (event && typeof event.clipboardData !== 'undefined') {
+      const textHTML = (0, _string.sanitize)(event.clipboardData.getData('text/html'), {
+        ADD_TAGS: ['meta'],
+        ADD_ATTR: ['content'],
+        FORCE_BODY: true
+      });
+      if (textHTML && /(<table)|(<TABLE)/g.test(textHTML)) {
+        const parsedConfig = (0, _parseTable.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 = (0, _SheetClip.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);
   }
   /**
    * Destroys the `CopyPaste` plugin instance.
@@ -700,6 +757,21 @@ function _ensureClipboardEventsGetTriggered2(eventName) {
     this.hot.rootDocument.execCommand(eventName);
   }
 }
+function _countCopiedHeaders2(ranges) {
+  const {
+    rows
+  } = (0, _copyableRanges.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();
@@ -746,6 +818,12 @@ function _onAfterContextMenuDefaultOptions2(options) {
   }
   options.items.push((0, _cut.default)(this));
 }
+function _onAfterSelection2(fromRow, fromColumn, toRow, toColumn, preventScrolling) {
+  if (_classPrivateFieldGet(this, _preventViewportScrollOnPaste)) {
+    preventScrolling.value = true;
+  }
+  _classPrivateFieldSet(this, _preventViewportScrollOnPaste, false);
+}
 function _onAfterSelectionEnd2() {
   if (this.isEditorOpened()) {
     return;