handsontable 9.0.1 → 11.0.1

package/{dataMap.mjs → dataMap/dataMap.mjs}

@@ -25,20 +25,41 @@ function _defineProperties(target, props) { for (var i = 0; i < props.length; i+
 
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
 
-import { stringify } from "./3rdparty/SheetClip/index.mjs";
-import { cellMethodLookupFactory, countFirstRowKeys as _countFirstRowKeys } from "./helpers/data.mjs";
-import { createObjectPropListener, deepClone, deepExtend, deepObjectSize, duckSchema, hasOwnProperty, isObject, objectEach } from "./helpers/object.mjs";
-import { extendArray, to2dArray } from "./helpers/array.mjs";
-import { rangeEach } from "./helpers/number.mjs";
-import { isDefined } from "./helpers/mixed.mjs";
+import { stringify } from "../3rdparty/SheetClip/index.mjs";
+import { cellMethodLookupFactory, countFirstRowKeys as _countFirstRowKeys } from "../helpers/data.mjs";
+import { createObjectPropListener, deepClone, deepExtend, deepObjectSize, duckSchema, hasOwnProperty, isObject, objectEach } from "../helpers/object.mjs";
+import { extendArray, to2dArray } from "../helpers/array.mjs";
+import { rangeEach } from "../helpers/number.mjs";
+import { isDefined } from "../helpers/mixed.mjs";
 var copyableLookup = cellMethodLookupFactory('copyable', false);
+/*
+This class contains open-source contributions covered by the MIT license.
+
+1) In the `createRow` method: Row creation using functional `dataSchema` value
+2) In the `set` method: Data setting using functional `prop` value
+3) in the `get` method: Data getting using functional `prop` value
+
+The remaining part of this code comment contains the full license text of these contributions.
+
+======
+
+The MIT License
+
+Copyright 2013 Nicholas Bollweg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
 /**
  * Utility class that gets and saves data from/to the data source using mapping of columns numbers to object property names.
  *
  * @todo Refactor arguments of methods getRange, getText to be numbers (not objects).
  * @todo Remove priv, GridSettings from object constructor.
  *
- * @util
  * @class DataMap
  * @private
  */
@@ -452,18 +473,11 @@ var DataMap = /*#__PURE__*/function () {
 
       if (actionWasNotCancelled === false) {
         return false;
-      }
+      } // List of removed indexes might be changed in the `beforeRemoveRow` hook. There may be new values.
 
-      var data = this.dataSource; // List of removed indexes might be changed in the `beforeRemoveRow` hook. There may be new values.
 
       var numberOfRemovedIndexes = removedPhysicalIndexes.length;
-      var newData = this.filterData(rowIndex, numberOfRemovedIndexes, removedPhysicalIndexes);
-
-      if (newData) {
-        data.length = 0;
-        Array.prototype.push.apply(data, newData);
-      } // TODO: Function `removeRow` should validate fully, probably above.
-
+      this.filterData(rowIndex, numberOfRemovedIndexes, removedPhysicalIndexes); // TODO: Function `removeRow` should validate fully, probably above.
 
       if (rowIndex < this.instance.countRows()) {
         this.instance.rowIndexMapper.removeIndexes(removedPhysicalIndexes);
@@ -644,20 +658,22 @@ var DataMap = /*#__PURE__*/function () {
      * @param {number} index Visual index of the element to remove.
      * @param {number} amount Number of rows to add/remove.
      * @param {number} physicalRows Physical row indexes.
-     * @returns {Array}
      */
 
   }, {
     key: "filterData",
     value: function filterData(index, amount, physicalRows) {
-      var continueSplicing = this.instance.runHooks('beforeDataFilter', index, amount, physicalRows);
+      // Custom data filtering (run as a consequence of calling the below hook) provide an array containing new data.
+      var data = this.instance.runHooks('filterData', index, amount, physicalRows); // Hooks by default returns first argument (when there is no callback changing execution result).
 
-      if (continueSplicing !== false) {
-        var newData = this.dataSource.filter(function (row, rowIndex) {
+      if (Array.isArray(data) === false) {
+        data = this.dataSource.filter(function (row, rowIndex) {
           return physicalRows.indexOf(rowIndex) === -1;
         });
-        return newData;
       }
+
+      this.dataSource.length = 0;
+      Array.prototype.push.apply(this.dataSource, data);
     }
     /**
      * Returns single value from the data array.
@@ -698,19 +714,6 @@ var DataMap = /*#__PURE__*/function () {
 
         value = out;
       } else if (typeof prop === 'function') {
-        /**
-         *  Allows for interacting with complex structures, for example
-         *  d3/jQuery getter/setter properties:
-         *
-         *    {columns: [{
-         *      data: function(row, value){
-         *        if(arguments.length === 1){
-         *          return row.property();
-         *        }
-         *        row.property(value);
-         *      }
-         *    }]}.
-         */
         value = prop(this.dataSource.slice(physicalRow, physicalRow + 1)[0]);
       }
 
@@ -788,7 +791,6 @@ var DataMap = /*#__PURE__*/function () {
 
         out[sliced[i]] = newValue;
       } else if (typeof prop === 'function') {
-        /* see the `function` handler in `get` */
         prop(this.dataSource.slice(physicalRow, physicalRow + 1)[0], newValue);
       } else {
         dataRow[prop] = newValue;

package/dataMap/index.js

@@ -2,7 +2,7 @@
 
 exports.__esModule = true;
 
-var _dataMap = _interopRequireDefault(require("../dataMap"));
+var _dataMap = _interopRequireDefault(require("./dataMap"));
 
 exports.DataMap = _dataMap.default;
 
@@ -14,4 +14,8 @@ var _metaSchema = _interopRequireDefault(require("./metaManager/metaSchema"));
 
 exports.metaSchemaFactory = _metaSchema.default;
 
+var _dynamicCellMeta = require("./metaManager/mods/dynamicCellMeta");
+
+exports.DynamicCellMetaMod = _dynamicCellMeta.DynamicCellMetaMod;
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dataMap/index.mjs

@@ -1,4 +1,5 @@
-import DataMap from "../dataMap.mjs";
+import DataMap from "./dataMap.mjs";
 import MetaManager from "./metaManager/index.mjs";
 import metaSchemaFactory from "./metaManager/metaSchema.mjs";
-export { DataMap, MetaManager, metaSchemaFactory };
+import { DynamicCellMetaMod } from "./metaManager/mods/dynamicCellMeta.mjs";
+export { DataMap, MetaManager, DynamicCellMetaMod, metaSchemaFactory };

package/dataMap/metaManager/index.js

@@ -3,6 +3,10 @@
 exports.__esModule = true;
 exports.default = void 0;
 
+require("core-js/modules/es.object.to-string.js");
+
+require("core-js/modules/web.dom-collections.for-each.js");
+
 var _globalMeta = _interopRequireDefault(require("./metaLayers/globalMeta"));
 
 var _tableMeta = _interopRequireDefault(require("./metaLayers/tableMeta"));
@@ -11,6 +15,10 @@ var _columnMeta = _interopRequireDefault(require("./metaLayers/columnMeta"));
 
 var _cellMeta = _interopRequireDefault(require("./metaLayers/cellMeta"));
 
+var _localHooks = _interopRequireDefault(require("../../mixins/localHooks"));
+
+var _object = require("../../helpers/object");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -47,15 +55,23 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
  * A more detailed description of the specific layers can be found in the "metaLayers/" modules description.
  */
 var MetaManager = /*#__PURE__*/function () {
-  function MetaManager() {
-    var customSettings = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  function MetaManager(hot) {
+    var _this = this;
+
+    var customSettings = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var metaMods = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
 
     _classCallCheck(this, MetaManager);
 
+    /**
+     * @type {Handsontable}
+     */
+    this.hot = hot;
     /**
      * @type {GlobalMeta}
      */
-    this.globalMeta = new _globalMeta.default();
+
+    this.globalMeta = new _globalMeta.default(hot);
     this.globalMeta.updateMeta(customSettings);
     /**
      * @type {TableMeta}
@@ -72,6 +88,9 @@ var MetaManager = /*#__PURE__*/function () {
      */
 
     this.cellMeta = new _cellMeta.default(this.columnMeta);
+    metaMods.forEach(function (ModifierClass) {
+      return new ModifierClass(_this);
+    });
   }
   /**
    * Gets the global meta object that is a root of all default settings, which are recognizable by Handsontable.
@@ -159,13 +178,41 @@ var MetaManager = /*#__PURE__*/function () {
      *
      * @param {number} physicalRow The physical row index.
      * @param {number} physicalColumn The physical column index.
-     * @param {string} [key] If the key exists its value will be returned, otherwise the whole cell meta object.
+     * @param {object} options Additional options that are used to extend the cell meta object.
+     * @param {number} options.visualRow The visual row index of the currently requested cell meta object.
+     * @param {number} options.visualColumn The visual column index of the currently requested cell meta object.
      * @returns {object}
      */
 
   }, {
     key: "getCellMeta",
-    value: function getCellMeta(physicalRow, physicalColumn, key) {
+    value: function getCellMeta(physicalRow, physicalColumn, _ref) {
+      var visualRow = _ref.visualRow,
+          visualColumn = _ref.visualColumn;
+      var cellMeta = this.cellMeta.getMeta(physicalRow, physicalColumn);
+      cellMeta.visualRow = visualRow;
+      cellMeta.visualCol = visualColumn;
+      cellMeta.row = physicalRow;
+      cellMeta.col = physicalColumn;
+      this.runLocalHooks('afterGetCellMeta', cellMeta);
+      return cellMeta;
+    }
+    /**
+     * Gets a value (defined by the `key` property) from the cell meta object.
+     *
+     * @param {number} physicalRow The physical row index.
+     * @param {number} physicalColumn The physical column index.
+     * @param {string} key Defines the value that will be returned from the cell meta object.
+     * @returns {*}
+     */
+
+  }, {
+    key: "getCellMetaKeyValue",
+    value: function getCellMetaKeyValue(physicalRow, physicalColumn, key) {
+      if (typeof key !== 'string') {
+        throw new Error('The passed cell meta object key is not a string');
+      }
+
       return this.cellMeta.getMeta(physicalRow, physicalColumn, key);
     }
     /**
@@ -312,4 +359,5 @@ var MetaManager = /*#__PURE__*/function () {
   return MetaManager;
 }();
 
-exports.default = MetaManager;
+exports.default = MetaManager;
+(0, _object.mixin)(MetaManager, _localHooks.default);

package/dataMap/metaManager/index.mjs

@@ -1,3 +1,6 @@
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/web.dom-collections.for-each.js";
+
 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); } }
@@ -8,6 +11,8 @@ import GlobalMeta from "./metaLayers/globalMeta.mjs";
 import TableMeta from "./metaLayers/tableMeta.mjs";
 import ColumnMeta from "./metaLayers/columnMeta.mjs";
 import CellMeta from "./metaLayers/cellMeta.mjs";
+import localHooks from "../../mixins/localHooks.mjs";
+import { mixin } from "../../helpers/object.mjs";
 /**
  * With the Meta Manager class, it can be possible to manage with meta objects for different layers in
  * one place. All coordinates used to fetch, updating, removing, or creating rows or columns have to
@@ -37,15 +42,23 @@ import CellMeta from "./metaLayers/cellMeta.mjs";
  */
 
 var MetaManager = /*#__PURE__*/function () {
-  function MetaManager() {
-    var customSettings = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  function MetaManager(hot) {
+    var _this = this;
+
+    var customSettings = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var metaMods = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
 
     _classCallCheck(this, MetaManager);
 
+    /**
+     * @type {Handsontable}
+     */
+    this.hot = hot;
     /**
      * @type {GlobalMeta}
      */
-    this.globalMeta = new GlobalMeta();
+
+    this.globalMeta = new GlobalMeta(hot);
     this.globalMeta.updateMeta(customSettings);
     /**
      * @type {TableMeta}
@@ -62,6 +75,9 @@ var MetaManager = /*#__PURE__*/function () {
      */
 
     this.cellMeta = new CellMeta(this.columnMeta);
+    metaMods.forEach(function (ModifierClass) {
+      return new ModifierClass(_this);
+    });
   }
   /**
    * Gets the global meta object that is a root of all default settings, which are recognizable by Handsontable.
@@ -149,13 +165,41 @@ var MetaManager = /*#__PURE__*/function () {
      *
      * @param {number} physicalRow The physical row index.
      * @param {number} physicalColumn The physical column index.
-     * @param {string} [key] If the key exists its value will be returned, otherwise the whole cell meta object.
+     * @param {object} options Additional options that are used to extend the cell meta object.
+     * @param {number} options.visualRow The visual row index of the currently requested cell meta object.
+     * @param {number} options.visualColumn The visual column index of the currently requested cell meta object.
      * @returns {object}
      */
 
   }, {
     key: "getCellMeta",
-    value: function getCellMeta(physicalRow, physicalColumn, key) {
+    value: function getCellMeta(physicalRow, physicalColumn, _ref) {
+      var visualRow = _ref.visualRow,
+          visualColumn = _ref.visualColumn;
+      var cellMeta = this.cellMeta.getMeta(physicalRow, physicalColumn);
+      cellMeta.visualRow = visualRow;
+      cellMeta.visualCol = visualColumn;
+      cellMeta.row = physicalRow;
+      cellMeta.col = physicalColumn;
+      this.runLocalHooks('afterGetCellMeta', cellMeta);
+      return cellMeta;
+    }
+    /**
+     * Gets a value (defined by the `key` property) from the cell meta object.
+     *
+     * @param {number} physicalRow The physical row index.
+     * @param {number} physicalColumn The physical column index.
+     * @param {string} key Defines the value that will be returned from the cell meta object.
+     * @returns {*}
+     */
+
+  }, {
+    key: "getCellMetaKeyValue",
+    value: function getCellMetaKeyValue(physicalRow, physicalColumn, key) {
+      if (typeof key !== 'string') {
+        throw new Error('The passed cell meta object key is not a string');
+      }
+
       return this.cellMeta.getMeta(physicalRow, physicalColumn, key);
     }
     /**
@@ -302,4 +346,5 @@ var MetaManager = /*#__PURE__*/function () {
   return MetaManager;
 }();
 
-export { MetaManager as default };
+export { MetaManager as default };
+mixin(MetaManager, localHooks);

package/dataMap/metaManager/lazyFactoryMap.js

@@ -159,7 +159,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
  */
 
 /* eslint-enable jsdoc/require-description-complete-sentence */
-var LazyFactoryMap = /*#__PURE__*/function () {
+var LazyFactoryMap = /*#__PURE__*/function (_Symbol$iterator) {
   function LazyFactoryMap(valueFactory) {
     _classCallCheck(this, LazyFactoryMap);
 
@@ -390,13 +390,13 @@ var LazyFactoryMap = /*#__PURE__*/function () {
      */
 
   }, {
-    key: Symbol.iterator,
+    key: _Symbol$iterator,
     value: function value() {
       return this.entries();
     }
   }]);
 
   return LazyFactoryMap;
-}();
+}(Symbol.iterator);
 
 exports.default = LazyFactoryMap;

package/dataMap/metaManager/lazyFactoryMap.mjs

@@ -143,7 +143,7 @@ import { assert, isUnsignedNumber, isNullish } from "./utils.mjs";
 
 /* eslint-enable jsdoc/require-description-complete-sentence */
 
-var LazyFactoryMap = /*#__PURE__*/function () {
+var LazyFactoryMap = /*#__PURE__*/function (_Symbol$iterator) {
   function LazyFactoryMap(valueFactory) {
     _classCallCheck(this, LazyFactoryMap);
 
@@ -374,13 +374,13 @@ var LazyFactoryMap = /*#__PURE__*/function () {
      */
 
   }, {
-    key: Symbol.iterator,
+    key: _Symbol$iterator,
     value: function value() {
       return this.entries();
     }
   }]);
 
   return LazyFactoryMap;
-}();
+}(Symbol.iterator);
 
 export { LazyFactoryMap as default };

package/dataMap/metaManager/metaLayers/cellMeta.js

@@ -10,6 +10,8 @@ require("core-js/modules/es.array.slice.js");
 
 require("core-js/modules/es.function.name.js");
 
+require("core-js/modules/es.regexp.exec.js");
+
 exports.__esModule = true;
 exports.default = void 0;
 

package/dataMap/metaManager/metaLayers/cellMeta.mjs

@@ -21,6 +21,7 @@ import "core-js/modules/es.symbol.description.js";
 import "core-js/modules/es.symbol.iterator.js";
 import "core-js/modules/es.array.slice.js";
 import "core-js/modules/es.function.name.js";
+import "core-js/modules/es.regexp.exec.js";
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 

package/dataMap/metaManager/metaLayers/globalMeta.js

@@ -52,7 +52,7 @@ function createTableMetaEmptyClass() {
 
 
 var GlobalMeta = /*#__PURE__*/function () {
-  function GlobalMeta() {
+  function GlobalMeta(hot) {
     _classCallCheck(this, GlobalMeta);
 
     /**
@@ -69,6 +69,7 @@ var GlobalMeta = /*#__PURE__*/function () {
 
     this.meta = this.metaCtor.prototype;
     (0, _object.extend)(this.meta, (0, _metaSchema.default)());
+    this.meta.instance = hot;
   }
   /**
    * Gets constructor of the global meta object. Necessary for inheritance for creating the next meta layers.

package/dataMap/metaManager/metaLayers/globalMeta.mjs

@@ -43,7 +43,7 @@ function createTableMetaEmptyClass() {
 
 
 var GlobalMeta = /*#__PURE__*/function () {
-  function GlobalMeta() {
+  function GlobalMeta(hot) {
     _classCallCheck(this, GlobalMeta);
 
     /**
@@ -60,6 +60,7 @@ var GlobalMeta = /*#__PURE__*/function () {
 
     this.meta = this.metaCtor.prototype;
     extend(this.meta, metaSchemaFactory());
+    this.meta.instance = hot;
   }
   /**
    * Gets constructor of the global meta object. Necessary for inheritance for creating the next meta layers.