handsontable 0.0.0-next-9ec04ce-20221121

package/plugins/contextMenu/utils.js

@@ -0,0 +1,278 @@
+"use strict";
+
+exports.__esModule = true;
+exports.align = align;
+exports.checkSelectionConsistency = checkSelectionConsistency;
+exports.filterSeparators = filterSeparators;
+exports.getAlignmentClasses = getAlignmentClasses;
+exports.getValidSelection = getValidSelection;
+exports.hasSubMenu = hasSubMenu;
+exports.isDisabled = isDisabled;
+exports.isItemHidden = isItemHidden;
+exports.isSelectionDisabled = isSelectionDisabled;
+exports.isSeparator = isSeparator;
+exports.markLabelAsSelected = markLabelAsSelected;
+exports.normalizeSelection = normalizeSelection;
+exports.prepareHorizontalAlignClass = prepareHorizontalAlignClass;
+exports.prepareVerticalAlignClass = prepareVerticalAlignClass;
+require("core-js/modules/es.array.index-of.js");
+require("core-js/modules/es.regexp.exec.js");
+require("core-js/modules/es.string.replace.js");
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.slice.js");
+require("core-js/modules/es.function.name.js");
+require("core-js/modules/es.array.reverse.js");
+var _array = require("../../helpers/array");
+var _element = require("../../helpers/dom/element");
+var _separator = require("./predefinedItems/separator");
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+function normalizeSelection(selRanges) {
+  return (0, _array.arrayMap)(selRanges, function (range) {
+    return {
+      start: range.getTopStartCorner(),
+      end: range.getBottomEndCorner()
+    };
+  });
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSeparator(cell) {
+  return (0, _element.hasClass)(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function hasSubMenu(cell) {
+  return (0, _element.hasClass)(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSelectionDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {Core} hot The Handsontable instance.
+ * @returns {Array[]|null}
+ */
+function getValidSelection(hot) {
+  var selected = hot.getSelected();
+  if (!selected) {
+    return null;
+  }
+  if (selected[0] < 0) {
+    return null;
+  }
+  return selected;
+}
+
+/**
+ * @param {string} className The full element class name to process.
+ * @param {string} alignment The slignment class name to compare with.
+ * @returns {string}
+ */
+function prepareVerticalAlignClass(className, alignment) {
+  if (className.indexOf(alignment) !== -1) {
+    return className;
+  }
+  var replacedClassName = className.replace('htTop', '').replace('htMiddle', '').replace('htBottom', '').replace('  ', '');
+  return "".concat(replacedClassName, " ").concat(alignment);
+}
+
+/**
+ * @param {string} className The full element class name to process.
+ * @param {string} alignment The slignment class name to compare with.
+ * @returns {string}
+ */
+function prepareHorizontalAlignClass(className, alignment) {
+  if (className.indexOf(alignment) !== -1) {
+    return className;
+  }
+  var replacedClassName = className.replace('htLeft', '').replace('htCenter', '').replace('htRight', '').replace('htJustify', '').replace('  ', '');
+  return "".concat(replacedClassName, " ").concat(alignment);
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {Function} callback The callback function.
+ * @returns {object}
+ */
+function getAlignmentClasses(ranges, callback) {
+  var classes = {};
+  (0, _array.arrayEach)(ranges, function (range) {
+    range.forAll(function (row, col) {
+      // Alignment classes should only collected within cell ranges. We skip header coordinates.
+      if (row >= 0 && col >= 0) {
+        if (!classes[row]) {
+          classes[row] = [];
+        }
+        classes[row][col] = callback(row, col);
+      }
+    });
+  });
+  return classes;
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {string} type The type of the alignment axis ('horizontal' or 'vertical').
+ * @param {string} alignment CSS class name to add.
+ * @param {Function} cellDescriptor The function which fetches the cell meta object based in passed coordinates.
+ * @param {Function} propertySetter The function which contains logic for added/removed alignment.
+ */
+function align(ranges, type, alignment, cellDescriptor, propertySetter) {
+  (0, _array.arrayEach)(ranges, function (range) {
+    range.forAll(function (row, col) {
+      // Alignment classes should only collected within cell ranges. We skip header coordinates.
+      if (row >= 0 && col >= 0) {
+        applyAlignClassName(row, col, type, alignment, cellDescriptor, propertySetter);
+      }
+    });
+  });
+}
+
+/**
+ * @param {number} row The visual row index.
+ * @param {number} col The visual column index.
+ * @param {string} type The type of the alignment axis ('horizontal' or 'vertical').
+ * @param {string} alignment CSS class name to add.
+ * @param {Function} cellDescriptor The function which fetches the cell meta object based in passed coordinates.
+ * @param {Function} propertySetter The function which contains logic for added/removed alignment.
+ */
+function applyAlignClassName(row, col, type, alignment, cellDescriptor, propertySetter) {
+  var cellMeta = cellDescriptor(row, col);
+  var className = alignment;
+  if (cellMeta.className) {
+    if (type === 'vertical') {
+      className = prepareVerticalAlignClass(cellMeta.className, alignment);
+    } else {
+      className = prepareHorizontalAlignClass(cellMeta.className, alignment);
+    }
+  }
+  propertySetter(row, col, 'className', className);
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {Function} comparator The comparator function.
+ * @returns {boolean}
+ */
+function checkSelectionConsistency(ranges, comparator) {
+  var result = false;
+  if (Array.isArray(ranges)) {
+    (0, _array.arrayEach)(ranges, function (range) {
+      range.forAll(function (row, col) {
+        // Selection consistency should only check within cell ranges. We skip header coordinates.
+        if (row >= 0 && col >= 0 && comparator(row, col)) {
+          result = true;
+          return false;
+        }
+      });
+      return result;
+    });
+  }
+  return result;
+}
+
+/**
+ * @param {string} label The label text.
+ * @returns {string}
+ */
+function markLabelAsSelected(label) {
+  // workaround for https://github.com/handsontable/handsontable/issues/1946
+  return "<span class=\"selected\">".concat(String.fromCharCode(10003), "</span>").concat(label);
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  var result = items.slice(0);
+  for (var i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
+  }
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  var result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  var result = [];
+  (0, _array.arrayEach)(items, function (value, index) {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function filterSeparators(items) {
+  var separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _separator.KEY;
+  var result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
+}

package/plugins/contextMenu/utils.mjs

@@ -0,0 +1,261 @@
+import "core-js/modules/es.array.index-of.js";
+import "core-js/modules/es.regexp.exec.js";
+import "core-js/modules/es.string.replace.js";
+import "core-js/modules/es.array.concat.js";
+import "core-js/modules/es.array.slice.js";
+import "core-js/modules/es.function.name.js";
+import "core-js/modules/es.array.reverse.js";
+import { arrayEach, arrayMap } from "../../helpers/array.mjs";
+import { hasClass } from "../../helpers/dom/element.mjs";
+import { KEY as SEPARATOR } from "./predefinedItems/separator.mjs";
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+export function normalizeSelection(selRanges) {
+  return arrayMap(selRanges, function (range) {
+    return {
+      start: range.getTopStartCorner(),
+      end: range.getBottomEndCorner()
+    };
+  });
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSeparator(cell) {
+  return hasClass(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function hasSubMenu(cell) {
+  return hasClass(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isDisabled(cell) {
+  return hasClass(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSelectionDisabled(cell) {
+  return hasClass(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {Core} hot The Handsontable instance.
+ * @returns {Array[]|null}
+ */
+export function getValidSelection(hot) {
+  var selected = hot.getSelected();
+  if (!selected) {
+    return null;
+  }
+  if (selected[0] < 0) {
+    return null;
+  }
+  return selected;
+}
+
+/**
+ * @param {string} className The full element class name to process.
+ * @param {string} alignment The slignment class name to compare with.
+ * @returns {string}
+ */
+export function prepareVerticalAlignClass(className, alignment) {
+  if (className.indexOf(alignment) !== -1) {
+    return className;
+  }
+  var replacedClassName = className.replace('htTop', '').replace('htMiddle', '').replace('htBottom', '').replace('  ', '');
+  return "".concat(replacedClassName, " ").concat(alignment);
+}
+
+/**
+ * @param {string} className The full element class name to process.
+ * @param {string} alignment The slignment class name to compare with.
+ * @returns {string}
+ */
+export function prepareHorizontalAlignClass(className, alignment) {
+  if (className.indexOf(alignment) !== -1) {
+    return className;
+  }
+  var replacedClassName = className.replace('htLeft', '').replace('htCenter', '').replace('htRight', '').replace('htJustify', '').replace('  ', '');
+  return "".concat(replacedClassName, " ").concat(alignment);
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {Function} callback The callback function.
+ * @returns {object}
+ */
+export function getAlignmentClasses(ranges, callback) {
+  var classes = {};
+  arrayEach(ranges, function (range) {
+    range.forAll(function (row, col) {
+      // Alignment classes should only collected within cell ranges. We skip header coordinates.
+      if (row >= 0 && col >= 0) {
+        if (!classes[row]) {
+          classes[row] = [];
+        }
+        classes[row][col] = callback(row, col);
+      }
+    });
+  });
+  return classes;
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {string} type The type of the alignment axis ('horizontal' or 'vertical').
+ * @param {string} alignment CSS class name to add.
+ * @param {Function} cellDescriptor The function which fetches the cell meta object based in passed coordinates.
+ * @param {Function} propertySetter The function which contains logic for added/removed alignment.
+ */
+export function align(ranges, type, alignment, cellDescriptor, propertySetter) {
+  arrayEach(ranges, function (range) {
+    range.forAll(function (row, col) {
+      // Alignment classes should only collected within cell ranges. We skip header coordinates.
+      if (row >= 0 && col >= 0) {
+        applyAlignClassName(row, col, type, alignment, cellDescriptor, propertySetter);
+      }
+    });
+  });
+}
+
+/**
+ * @param {number} row The visual row index.
+ * @param {number} col The visual column index.
+ * @param {string} type The type of the alignment axis ('horizontal' or 'vertical').
+ * @param {string} alignment CSS class name to add.
+ * @param {Function} cellDescriptor The function which fetches the cell meta object based in passed coordinates.
+ * @param {Function} propertySetter The function which contains logic for added/removed alignment.
+ */
+function applyAlignClassName(row, col, type, alignment, cellDescriptor, propertySetter) {
+  var cellMeta = cellDescriptor(row, col);
+  var className = alignment;
+  if (cellMeta.className) {
+    if (type === 'vertical') {
+      className = prepareVerticalAlignClass(cellMeta.className, alignment);
+    } else {
+      className = prepareHorizontalAlignClass(cellMeta.className, alignment);
+    }
+  }
+  propertySetter(row, col, 'className', className);
+}
+
+/**
+ * @param {CellRange[]} ranges An array of the cell ranges.
+ * @param {Function} comparator The comparator function.
+ * @returns {boolean}
+ */
+export function checkSelectionConsistency(ranges, comparator) {
+  var result = false;
+  if (Array.isArray(ranges)) {
+    arrayEach(ranges, function (range) {
+      range.forAll(function (row, col) {
+        // Selection consistency should only check within cell ranges. We skip header coordinates.
+        if (row >= 0 && col >= 0 && comparator(row, col)) {
+          result = true;
+          return false;
+        }
+      });
+      return result;
+    });
+  }
+  return result;
+}
+
+/**
+ * @param {string} label The label text.
+ * @returns {string}
+ */
+export function markLabelAsSelected(label) {
+  // workaround for https://github.com/handsontable/handsontable/issues/1946
+  return "<span class=\"selected\">".concat(String.fromCharCode(10003), "</span>").concat(label);
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+export function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  var result = items.slice(0);
+  for (var i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
+  }
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  var result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  var result = [];
+  arrayEach(items, function (value, index) {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+export function filterSeparators(items) {
+  var separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SEPARATOR;
+  var result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
+}

package/plugins/copyPaste/clipboardData.js

@@ -0,0 +1,29 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+/**
+ * @private
+ */
+var ClipboardData = /*#__PURE__*/function () {
+  function ClipboardData() {
+    _classCallCheck(this, ClipboardData);
+    this.data = {};
+  }
+  _createClass(ClipboardData, [{
+    key: "setData",
+    value: function setData(type, value) {
+      this.data[type] = value;
+    }
+  }, {
+    key: "getData",
+    value: function getData(type) {
+      return this.data[type] || void 0;
+    }
+  }]);
+  return ClipboardData;
+}();
+exports.default = ClipboardData;

package/plugins/copyPaste/clipboardData.mjs

@@ -0,0 +1,25 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+/**
+ * @private
+ */
+var ClipboardData = /*#__PURE__*/function () {
+  function ClipboardData() {
+    _classCallCheck(this, ClipboardData);
+    this.data = {};
+  }
+  _createClass(ClipboardData, [{
+    key: "setData",
+    value: function setData(type, value) {
+      this.data[type] = value;
+    }
+  }, {
+    key: "getData",
+    value: function getData(type) {
+      return this.data[type] || void 0;
+    }
+  }]);
+  return ClipboardData;
+}();
+export { ClipboardData as default };

package/plugins/copyPaste/contextMenuItem/copy.js

@@ -0,0 +1,45 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/es.weak-map.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.symbol.iterator.js");
+exports.__esModule = true;
+exports.default = copyItem;
+var C = _interopRequireWildcard(require("../../../i18n/constants"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+/**
+ * @param {CopyPaste} copyPastePlugin The plugin instance.
+ * @returns {object}
+ */
+function copyItem(copyPastePlugin) {
+  return {
+    key: 'copy',
+    name: function name() {
+      return this.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_COPY);
+    },
+    callback: function callback() {
+      copyPastePlugin.copy();
+    },
+    disabled: function disabled() {
+      if (this.countRows() === 0 || this.countCols() === 0) {
+        return true;
+      }
+      var selected = this.getSelected();
+
+      // Disable for no selection or for non-contiquous selection.
+      if (!selected || selected.length > 1) {
+        return true;
+      }
+      return false;
+    },
+    hidden: false
+  };
+}

package/plugins/copyPaste/contextMenuItem/copy.mjs

@@ -0,0 +1,29 @@
+import * as C from "../../../i18n/constants.mjs";
+/**
+ * @param {CopyPaste} copyPastePlugin The plugin instance.
+ * @returns {object}
+ */
+export default function copyItem(copyPastePlugin) {
+  return {
+    key: 'copy',
+    name: function name() {
+      return this.getTranslatedPhrase(C.CONTEXTMENU_ITEMS_COPY);
+    },
+    callback: function callback() {
+      copyPastePlugin.copy();
+    },
+    disabled: function disabled() {
+      if (this.countRows() === 0 || this.countCols() === 0) {
+        return true;
+      }
+      var selected = this.getSelected();
+
+      // Disable for no selection or for non-contiquous selection.
+      if (!selected || selected.length > 1) {
+        return true;
+      }
+      return false;
+    },
+    hidden: false
+  };
+}