handsontable 12.1.3 → 12.2.0

package/plugins/nestedHeaders/stateManager/index.mjs

@@ -12,97 +12,72 @@ import "core-js/modules/es.object.to-string.js";
 import "core-js/modules/es.string.iterator.js";
 import "core-js/modules/es.weak-map.js";
 import "core-js/modules/web.dom-collections.iterator.js";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-
 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; }
-
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
-
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-
 function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
-
 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; } }
-
 function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
-
 function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-
 function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-
 import { arrayMap, arrayReduce } from "../../../helpers/array.mjs";
 import SourceSettings from "./sourceSettings.mjs";
 import HeadersTree from "./headersTree.mjs";
 import { triggerNodeModification as _triggerNodeModification } from "./nodeModifiers/index.mjs";
-import { generateMatrix } from "./matrixGenerator.mjs";
-/**
- * The state manager is a source of truth for nested headers configuration.
- * The state generation process is divided into three stages.
- *
- *   +---------------------+  1. User-defined configuration normalization;
- *   │                     │  The source settings class normalizes and shares API for
- *   │   SourceSettings    │  raw settings passed by the developer. It is only consumed by
- *   │                     │  the header tree module.
- *   +---------------------+
- *             │
- *            \│/
- *   +---------------------+  2. Building a tree structure for validation and easier node manipulation;
- *   │                     │  The header tree generates a tree based on source settings for future
- *   │     HeadersTree     │  node manipulation (such as collapsible columns feature). While generating a tree
- *   │                     │  the source settings is checked to see if the configuration has overlapping headers.
- *   +---------------------+  If `true` the colspan matrix generation is skipped, overlapped headers are not supported.
- *             │
- *            \│/
- *   +---------------------+  3. Matrix generation;
- *   │                     │  Based on built trees the matrix generation is performed. That part of code
- *   │  matrix generation  │  generates an array structure similar to normalized data from the SourceSettings
- *   │                     │  but with the difference that this structure contains column settings which changed
- *   +---------------------+  during runtime (after the tree manipulation) e.q after collapse or expand column.
- *                            That settings describes how the TH element should be modified (colspan attribute,
- *                            CSS classes, etc) for a specific column and layer level.
- *
- * @class StateManager
- */
-
+import { generateMatrix } from "./matrixGenerator.mjs"; /**
+                                                         * The state manager is a source of truth for nested headers configuration.
+                                                         * The state generation process is divided into three stages.
+                                                         *
+                                                         *   +---------------------+  1. User-defined configuration normalization;
+                                                         *   │                     │  The source settings class normalizes and shares API for
+                                                         *   │   SourceSettings    │  raw settings passed by the developer. It is only consumed by
+                                                         *   │                     │  the header tree module.
+                                                         *   +---------------------+
+                                                         *             │
+                                                         *            \│/
+                                                         *   +---------------------+  2. Building a tree structure for validation and easier node manipulation;
+                                                         *   │                     │  The header tree generates a tree based on source settings for future
+                                                         *   │     HeadersTree     │  node manipulation (such as collapsible columns feature). While generating a tree
+                                                         *   │                     │  the source settings is checked to see if the configuration has overlapping headers.
+                                                         *   +---------------------+  If `true` the colspan matrix generation is skipped, overlapped headers are not supported.
+                                                         *             │
+                                                         *            \│/
+                                                         *   +---------------------+  3. Matrix generation;
+                                                         *   │                     │  Based on built trees the matrix generation is performed. That part of code
+                                                         *   │  matrix generation  │  generates an array structure similar to normalized data from the SourceSettings
+                                                         *   │                     │  but with the difference that this structure contains column settings which changed
+                                                         *   +---------------------+  during runtime (after the tree manipulation) e.q after collapse or expand column.
+                                                         *                            That settings describes how the TH element should be modified (colspan attribute,
+                                                         *                            CSS classes, etc) for a specific column and layer level.
+                                                         *
+                                                         * @class StateManager
+                                                         */
 var _sourceSettings = /*#__PURE__*/new WeakMap();
-
 var _headersTree = /*#__PURE__*/new WeakMap();
-
 var _stateMatrix = /*#__PURE__*/new WeakMap();
-
 var StateManager = /*#__PURE__*/function () {
   function StateManager() {
     _classCallCheck(this, StateManager);
-
     _classPrivateFieldInitSpec(this, _sourceSettings, {
       writable: true,
       value: new SourceSettings()
     });
-
     _classPrivateFieldInitSpec(this, _headersTree, {
       writable: true,
       value: new HeadersTree(_classPrivateFieldGet(this, _sourceSettings))
     });
-
     _classPrivateFieldInitSpec(this, _stateMatrix, {
       writable: true,
       value: [[]]
     });
   }
-
   _createClass(StateManager, [{
     key: "setState",
     value:
@@ -115,35 +90,30 @@ var StateManager = /*#__PURE__*/function () {
      */
     function setState(nestedHeadersSettings) {
       _classPrivateFieldGet(this, _sourceSettings).setData(nestedHeadersSettings);
-
       var hasError = false;
-
       try {
         _classPrivateFieldGet(this, _headersTree).buildTree();
       } catch (ex) {
         _classPrivateFieldGet(this, _headersTree).clear();
-
         _classPrivateFieldGet(this, _sourceSettings).clear();
-
         hasError = true;
       }
-
       _classPrivateFieldSet(this, _stateMatrix, generateMatrix(_classPrivateFieldGet(this, _headersTree).getRoots()));
-
       return hasError;
     }
+
     /**
      * Sets columns limit to the state will be trimmed. All headers (colspans) which
      * overlap the column limit will be reduced to keep the structure solid.
      *
      * @param {number} columnsCount The number of columns to limit to.
      */
-
   }, {
     key: "setColumnsLimit",
     value: function setColumnsLimit(columnsCount) {
       _classPrivateFieldGet(this, _sourceSettings).setColumnsLimit(columnsCount);
     }
+
     /**
      * Merges settings with current plugin state.
      *
@@ -154,27 +124,22 @@ var StateManager = /*#__PURE__*/function () {
      *                            It is a requirement that every object has `row` and `col` properties
      *                            which points to the specific header settings object.
      */
-
   }, {
     key: "mergeStateWith",
     value: function mergeStateWith(settings) {
       var _this = this;
-
       var transformedSettings = arrayMap(settings, function (_ref) {
         var row = _ref.row,
-            rest = _objectWithoutProperties(_ref, _excluded);
-
+          rest = _objectWithoutProperties(_ref, _excluded);
         return _objectSpread({
           row: row < 0 ? _this.rowCoordsToLevel(row) : row
         }, rest);
       });
-
       _classPrivateFieldGet(this, _sourceSettings).mergeWith(transformedSettings);
-
       _classPrivateFieldGet(this, _headersTree).buildTree();
-
       _classPrivateFieldSet(this, _stateMatrix, generateMatrix(_classPrivateFieldGet(this, _headersTree).getRoots()));
     }
+
     /**
      * Maps the current state with a callback. For each header settings the callback function
      * is called. If the function returns value that value is merged with the state.
@@ -186,16 +151,14 @@ var StateManager = /*#__PURE__*/function () {
      *                            Each time the callback is called, the returned value extends
      *                            header settings.
      */
-
   }, {
     key: "mapState",
     value: function mapState(callback) {
       _classPrivateFieldGet(this, _sourceSettings).map(callback);
-
       _classPrivateFieldGet(this, _headersTree).buildTree();
-
       _classPrivateFieldSet(this, _stateMatrix, generateMatrix(_classPrivateFieldGet(this, _headersTree).getRoots()));
     }
+
     /**
      * Maps the current tree nodes with a callback. For each node the callback function
      * is called. If the function returns value that value is added to returned array.
@@ -205,14 +168,12 @@ var StateManager = /*#__PURE__*/function () {
      *                            added to returned array.
      * @returns {Array}
      */
-
   }, {
     key: "mapNodes",
     value: function mapNodes(callback) {
       return arrayReduce(_classPrivateFieldGet(this, _headersTree).getRoots(), function (acc, rootNode) {
         rootNode.walkDown(function (node) {
           var result = callback(node.data);
-
           if (result !== void 0) {
             acc.push(result);
           }
@@ -220,6 +181,7 @@ var StateManager = /*#__PURE__*/function () {
         return acc;
       }, []);
     }
+
     /**
      * Triggers an action (e.g. "collapse") from the NodeModifiers module. The module
      * modifies a tree structure in such a way as to obtain the correct structure consistent with the
@@ -230,26 +192,23 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} columnIndex A visual column index.
      * @returns {object|undefined}
      */
-
   }, {
     key: "triggerNodeModification",
     value: function triggerNodeModification(action, headerLevel, columnIndex) {
       if (headerLevel < 0) {
         headerLevel = this.rowCoordsToLevel(headerLevel);
       }
-
       var nodeToProcess = _classPrivateFieldGet(this, _headersTree).getNode(headerLevel, columnIndex);
-
       var actionResult;
-
       if (nodeToProcess) {
-        actionResult = _triggerNodeModification(action, nodeToProcess, columnIndex); // TODO (perf-tip): Trigger matrix generation once after multiple node modifications.
+        actionResult = _triggerNodeModification(action, nodeToProcess, columnIndex);
 
+        // TODO (perf-tip): Trigger matrix generation once after multiple node modifications.
         _classPrivateFieldSet(this, _stateMatrix, generateMatrix(_classPrivateFieldGet(this, _headersTree).getRoots()));
       }
-
       return actionResult;
     }
+
     /**
      * Triggers an action (e.g. "hide-column") from the NodeModifiers module. The action is
      * triggered starting from the lowest header. The module modifies a tree structure in
@@ -259,14 +218,13 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} columnIndex A visual column index.
      * @returns {object|undefined}
      */
-
   }, {
     key: "triggerColumnModification",
     value: function triggerColumnModification(action, columnIndex) {
       return this.triggerNodeModification(action, -1, columnIndex);
     }
-    /* eslint-disable jsdoc/require-description-complete-sentence */
 
+    /* eslint-disable jsdoc/require-description-complete-sentence */
     /**
      * @memberof StateManager#
      * @function rowCoordsToLevel
@@ -291,9 +249,7 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} rowIndex A visual row index.
      * @returns {number} Returns unsigned number.
      */
-
     /* eslint-enable jsdoc/require-description-complete-sentence */
-
   }, {
     key: "rowCoordsToLevel",
     value: function rowCoordsToLevel(rowIndex) {
@@ -302,8 +258,8 @@ var StateManager = /*#__PURE__*/function () {
       var lowestPossibleLevel = 0;
       return Math.min(Math.max(rowIndex + layersCount, lowestPossibleLevel), highestPossibleLevel);
     }
-    /* eslint-disable jsdoc/require-description-complete-sentence */
 
+    /* eslint-disable jsdoc/require-description-complete-sentence */
     /**
      * @memberof StateManager#
      * @function levelToRowCoords
@@ -328,9 +284,7 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} headerLevel Header level index.
      * @returns {number} Returns negative number.
      */
-
     /* eslint-enable jsdoc/require-description-complete-sentence */
-
   }, {
     key: "levelToRowCoords",
     value: function levelToRowCoords(headerLevel) {
@@ -339,6 +293,7 @@ var StateManager = /*#__PURE__*/function () {
       var lowestPossibleRow = -layersCount;
       return Math.min(Math.max(headerLevel - layersCount, lowestPossibleRow), highestPossibleRow);
     }
+
     /**
      * Gets column header settings for a specified column and header index. The returned object contains
      * all information necessary for header renderers. It contains header label, colspan length, or hidden
@@ -348,22 +303,19 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} columnIndex A visual column index.
      * @returns {object|null}
      */
-
   }, {
     key: "getHeaderSettings",
     value: function getHeaderSettings(headerLevel, columnIndex) {
       var _classPrivateFieldGet2, _classPrivateFieldGet3;
-
       if (headerLevel < 0) {
         headerLevel = this.rowCoordsToLevel(headerLevel);
       }
-
       if (headerLevel >= this.getLayersCount()) {
         return null;
       }
-
       return (_classPrivateFieldGet2 = (_classPrivateFieldGet3 = _classPrivateFieldGet(this, _stateMatrix)[headerLevel]) === null || _classPrivateFieldGet3 === void 0 ? void 0 : _classPrivateFieldGet3[columnIndex]) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : null;
     }
+
     /**
      * Gets tree data that is connected to the column header. The returned object contains all information
      * necessary for modifying tree structure (column collapsing, hiding, etc.). It contains a header
@@ -373,22 +325,19 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} columnIndex A visual column index.
      * @returns {object|null}
      */
-
   }, {
     key: "getHeaderTreeNodeData",
     value: function getHeaderTreeNodeData(headerLevel, columnIndex) {
       if (headerLevel < 0) {
         headerLevel = this.rowCoordsToLevel(headerLevel);
       }
-
       var node = _classPrivateFieldGet(this, _headersTree).getNode(headerLevel, columnIndex);
-
       if (!node) {
         return null;
       }
-
       return _objectSpread({}, node.data);
     }
+
     /**
      * The method is helpful in cases where the column index targets in-between currently
      * collapsed column. In that case, the method returns the left-most column index
@@ -398,78 +347,65 @@ var StateManager = /*#__PURE__*/function () {
      * @param {number} columnIndex A visual column index.
      * @returns {number}
      */
-
   }, {
     key: "findLeftMostColumnIndex",
     value: function findLeftMostColumnIndex(headerLevel, columnIndex) {
       var _this$getHeaderSettin;
-
       var _ref2 = (_this$getHeaderSettin = this.getHeaderSettings(headerLevel, columnIndex)) !== null && _this$getHeaderSettin !== void 0 ? _this$getHeaderSettin : {
-        isRoot: true
-      },
-          isRoot = _ref2.isRoot;
-
+          isRoot: true
+        },
+        isRoot = _ref2.isRoot;
       if (isRoot) {
         return columnIndex;
       }
-
       var stepBackColumn = columnIndex - 1;
-
       while (stepBackColumn >= 0) {
         var _this$getHeaderSettin2;
-
         var _ref3 = (_this$getHeaderSettin2 = this.getHeaderSettings(headerLevel, stepBackColumn)) !== null && _this$getHeaderSettin2 !== void 0 ? _this$getHeaderSettin2 : {
-          isRoot: true
-        },
-            isRootNode = _ref3.isRoot;
-
+            isRoot: true
+          },
+          isRootNode = _ref3.isRoot;
         if (isRootNode) {
           break;
         }
-
         stepBackColumn -= 1;
       }
-
       return stepBackColumn;
     }
+
     /**
      * Gets a total number of headers levels.
      *
      * @returns {number}
      */
-
   }, {
     key: "getLayersCount",
     value: function getLayersCount() {
       return _classPrivateFieldGet(this, _sourceSettings).getLayersCount();
     }
+
     /**
      * Gets a total number of columns count.
      *
      * @returns {number}
      */
-
   }, {
     key: "getColumnsCount",
     value: function getColumnsCount() {
       return _classPrivateFieldGet(this, _sourceSettings).getColumnsCount();
     }
+
     /**
      * Clears the column state manager to the initial state.
      */
-
   }, {
     key: "clear",
     value: function clear() {
       _classPrivateFieldSet(this, _stateMatrix, []);
-
       _classPrivateFieldGet(this, _sourceSettings).clear();
-
       _classPrivateFieldGet(this, _headersTree).clear();
     }
   }]);
-
   return StateManager;
 }();
-
 export { StateManager as default };

package/plugins/nestedHeaders/stateManager/matrixGenerator.js

@@ -1,28 +1,17 @@
 "use strict";
 
 require("core-js/modules/es.object.keys.js");
-
 require("core-js/modules/es.array.index-of.js");
-
 require("core-js/modules/es.symbol.js");
-
 exports.__esModule = true;
 exports.generateMatrix = generateMatrix;
-
 require("core-js/modules/es.array.includes.js");
-
 require("core-js/modules/es.string.includes.js");
-
 var _array = require("../../../helpers/array");
-
 var _utils = require("./utils");
-
 var _excluded = ["crossHiddenColumns"];
-
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-
 /**
  * A function that dump a tree structure into multidimensional array. That structure is
  * later processed by header renderers to modify TH elements to achieve a proper
@@ -59,15 +48,13 @@ function generateMatrix(headerRoots) {
     rootNode.walkDown(function (node) {
       var nodeData = node.data;
       var origColspan = nodeData.origColspan,
-          columnIndex = nodeData.columnIndex,
-          headerLevel = nodeData.headerLevel,
-          crossHiddenColumns = nodeData.crossHiddenColumns;
+        columnIndex = nodeData.columnIndex,
+        headerLevel = nodeData.headerLevel,
+        crossHiddenColumns = nodeData.crossHiddenColumns;
       var colspanHeaderLayer = createNestedArrayIfNecessary(matrix, headerLevel);
       var isRootSettingsFound = false;
-
       for (var i = columnIndex; i < columnIndex + origColspan; i++) {
         var isColumnHidden = crossHiddenColumns.includes(i);
-
         if (isColumnHidden || isRootSettingsFound) {
           colspanHeaderLayer.push((0, _utils.createPlaceholderHeaderSettings)(nodeData));
         } else {
@@ -81,22 +68,21 @@ function generateMatrix(headerRoots) {
   });
   return matrix;
 }
+
 /**
  * Creates header settings object.
  *
  * @param {object} nodeData The tree data object.
  * @returns {object}
  */
-
-
 function createHeaderSettings(nodeData) {
   // For the matrix module we do not need to export "crossHiddenColumns" key. It's redundant here.
   var _createDefaultHeaderS = (0, _utils.createDefaultHeaderSettings)(nodeData),
-      crossHiddenColumns = _createDefaultHeaderS.crossHiddenColumns,
-      headerRootSettings = _objectWithoutProperties(_createDefaultHeaderS, _excluded);
-
+    crossHiddenColumns = _createDefaultHeaderS.crossHiddenColumns,
+    headerRootSettings = _objectWithoutProperties(_createDefaultHeaderS, _excluded);
   return headerRootSettings;
 }
+
 /**
  * Internal helper which ensures that subarray exists under specified index.
  *
@@ -104,17 +90,13 @@ function createHeaderSettings(nodeData) {
  * @param {number} index An array index under the subarray should be checked.
  * @returns {Array}
  */
-
-
 function createNestedArrayIfNecessary(array, index) {
   var subArray;
-
   if (Array.isArray(array[index])) {
     subArray = array[index];
   } else {
     subArray = [];
     array[index] = subArray;
   }
-
   return subArray;
 }