handsontable 17.1.0 → 18.0.0-rc2

package/dataMap/dataMap.js

@@ -16,6 +16,44 @@ const _number = require("../helpers/number");
 const _mixed = require("../helpers/mixed");
 const _valueAccessors = require("../utils/valueAccessors");
 const _errors = require("../helpers/errors");
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return fn;
+}
+function _class_private_method_init(obj, privateSet) {
+    _check_private_redeclaration(obj, privateSet);
+    privateSet.add(obj);
+}
+var /**
+   * Builds the column property cache from the `columns` setting.
+   *
+   * @param {Function|Array} columns The columns setting value.
+   * @param {unknown} schema The current data schema.
+   */ _buildColumnCache = /*#__PURE__*/ new WeakSet(), /**
+   * Inserts a single null column into the data source at the given physical column index.
+   *
+   * @param {Array} dataSource The data source array.
+   * @param {number} col The physical column index at which to splice.
+   * @param {number|undefined} visualColumnIndex The visual column index being inserted.
+   * @param {number} currentVisualColCount The current visual column count including already-created columns.
+   * @param {number} numberOfSourceRows The number of source rows.
+   */ _insertColumnIntoDataSource = /*#__PURE__*/ new WeakSet(), /**
+   * Splices the removed physical columns from each row in the data source,
+   * updating the meta manager for the first row.
+   *
+   * @param {Array} data The data source array.
+   * @param {boolean} isTableUniform Whether the removed columns form a contiguous range.
+   * @param {number[]} removedPhysicalIndexes Physical indexes of removed columns in ascending order.
+   * @param {number[]} descendingPhysicalColumns Physical indexes of removed columns in descending order.
+   * @param {number} amount The number of columns to remove.
+   */ _spliceRemovedColumns = /*#__PURE__*/ new WeakSet();
 /*
 This class contains open-source contributions covered by the MIT license.
 
@@ -63,32 +101,10 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
             (0, _errors.throwWithCause)('trying to create `columns` definition but you didn\'t provide `schema` nor `data`');
         }
         const columns = this.tableMeta.columns;
-        let i;
         this.colToPropCache = [];
         this.propToColCache = new Map();
         if (columns) {
-            let columnsLen = 0;
-            let filteredIndex = 0;
-            let columnsAsFunc = false;
-            if (typeof columns === 'function') {
-                const schemaLen = (0, _object.deepObjectSize)(schema);
-                columnsLen = schemaLen > 0 ? schemaLen : this.countFirstRowKeys();
-                columnsAsFunc = true;
-            } else {
-                const maxCols = this.tableMeta.maxCols;
-                columnsLen = Math.min(maxCols, columns.length);
-            }
-            for(i = 0; i < columnsLen; i++){
-                const column = columnsAsFunc ? columns(i) : columns[i];
-                if ((0, _object.isObject)(column)) {
-                    if (typeof column.data !== 'undefined') {
-                        const index = columnsAsFunc ? filteredIndex : i;
-                        this.colToPropCache[index] = column.data;
-                        this.propToColCache.set(column.data, index);
-                    }
-                    filteredIndex += 1;
-                }
-            }
+            _class_private_method_get(this, _buildColumnCache, buildColumnCache).call(this, columns, schema);
         } else {
             this.recursiveDuckColumns(schema);
         }
@@ -98,7 +114,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    *
    * @returns {number} Amount of physical columns in the first data row.
    */ countFirstRowKeys() {
-        return (0, _data.countFirstRowKeys)(this.dataSource);
+        return (0, _data.countFirstRowKeys)(this.dataSource ?? []);
     }
     /**
    * Generates columns' translation cache.
@@ -108,21 +124,17 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    * @param {number} parent The property cache for recursive calls.
    * @returns {number}
    */ recursiveDuckColumns(schema, lastCol, parent) {
-        let lastColumn = lastCol;
-        let propertyParent = parent;
+        let lastColumn = lastCol ?? 0;
+        const propertyParent = parent ?? '';
         let prop;
-        if (typeof lastColumn === 'undefined') {
-            lastColumn = 0;
-            propertyParent = '';
-        }
-        if (typeof schema === 'object' && !Array.isArray(schema)) {
+        if (typeof schema === 'object' && schema !== null && !Array.isArray(schema)) {
             (0, _object.objectEach)(schema, (value, key)=>{
                 if (value === null) {
                     prop = propertyParent + key;
                     this.colToPropCache.push(prop);
                     this.propToColCache.set(prop, lastColumn);
                     lastColumn += 1;
-                } else {
+                } else if (typeof value === 'object' && value !== null) {
                     lastColumn = this.recursiveDuckColumns(value, lastColumn, `${key}.`);
                 }
             });
@@ -158,15 +170,17 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    * @returns {string|number} Visual column index or passed argument.
    */ propToCol(prop) {
         const cachedPhysicalIndex = this.propToColCache.get(prop);
-        if ((0, _mixed.isDefined)(cachedPhysicalIndex)) {
+        if (cachedPhysicalIndex !== undefined) {
             return this.hot.toVisualColumn(cachedPhysicalIndex);
         }
         // Property may be a physical column index.
-        const visualColumn = this.hot.toVisualColumn(prop);
-        if (visualColumn === null) {
+        if (typeof prop !== 'number') {
             return prop;
         }
-        return visualColumn;
+        const visualColumn = this.hot.toVisualColumn(prop);
+        // Fall back to the physical index when toVisualColumn returns null
+        // (e.g. column is trimmed/hidden and has no visual equivalent).
+        return visualColumn !== null ? visualColumn : prop;
     }
     /**
    * Returns data's schema.
@@ -224,7 +238,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         const maxRows = this.tableMeta.maxRows;
         const columnCount = this.getSchema().length;
         const rowsToAdd = [];
-        while(numberOfCreatedRows < amount && sourceRowsCount + numberOfCreatedRows < maxRows){
+        while(numberOfCreatedRows < amount && sourceRowsCount + numberOfCreatedRows < (maxRows ?? Infinity)){
             let row = null;
             if (this.hot.dataType === 'array') {
                 if (this.tableMeta.dataSchema) {
@@ -235,7 +249,11 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
                     /* eslint-disable no-loop-func */ (0, _number.rangeEach)(columnCount - 1, ()=>row.push(null));
                 }
             } else if (this.hot.dataType === 'function') {
-                row = this.tableMeta.dataSchema(rowIndex + numberOfCreatedRows);
+                const dataSchemaFn = this.tableMeta.dataSchema;
+                if (typeof dataSchemaFn !== 'function') {
+                    (0, _errors.throwWithCause)('`dataSchema` must be a function when `dataType` is `function`');
+                }
+                row = dataSchemaFn(rowIndex + numberOfCreatedRows);
             } else {
                 row = {};
                 (0, _object.deepExtend)(row, this.getSchema());
@@ -285,7 +303,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
             (0, _errors.throwWithCause)('Cannot create new column. When data source in an object, ' + // eslint-disable-next-line max-len
             'you can only have as much columns as defined in first data row, data schema or in the \'columns\' setting.' + 'If you want to be able to add new columns, you have to use array datasource.');
         }
-        const dataSource = this.dataSource;
+        const dataSource = this.dataSource ?? [];
         const maxCols = this.tableMeta.maxCols;
         const numberOfSourceCols = this.hot.countSourceCols();
         const numberOfVisualCols = this.hot.countCols();
@@ -299,26 +317,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         const physicalColumnIndex = visualColumnIndex < numberOfVisualCols ? this.hot.toPhysicalColumn(visualColumnIndex) : numberOfSourceCols;
         const firstNewPhysicalColumnIndex = mode === 'end' ? Math.min(physicalColumnIndex + 1, numberOfSourceCols) : physicalColumnIndex;
         let numberOfCreatedCols = 0;
-        for(let col = firstNewPhysicalColumnIndex; numberOfCreatedCols < amount && numberOfVisualCols + numberOfCreatedCols < maxCols; col++){
-            if (typeof visualColumnIndex !== 'number' || visualColumnIndex >= numberOfVisualCols + numberOfCreatedCols) {
-                if (numberOfSourceRows > 0) {
-                    for(let row = 0; row < numberOfSourceRows; row += 1){
-                        if (typeof dataSource[row] === 'undefined') {
-                            dataSource[row] = [];
-                        }
-                        dataSource[row].push(null);
-                    }
-                } else {
-                    dataSource.push([
-                        null
-                    ]);
-                }
-            } else {
-                for(let row = 0; row < numberOfSourceRows; row++){
-                    dataSource[row].splice(col, 0, null);
-                }
-            }
-            numberOfCreatedCols += 1;
+        for(let col = firstNewPhysicalColumnIndex; numberOfCreatedCols < amount && numberOfVisualCols + numberOfCreatedCols < (maxCols ?? Infinity); col++, numberOfCreatedCols++){
+            _class_private_method_get(this, _insertColumnIntoDataSource, insertColumnIntoDataSource).call(this, dataSource, col, visualColumnIndex, numberOfVisualCols + numberOfCreatedCols, numberOfSourceRows);
         }
         if (numberOfCreatedCols > 0) {
             if (index === undefined || index === null) {
@@ -349,8 +349,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    */ removeRow(index, amount = 1, source) {
         let rowIndex = Number.isInteger(index) ? index : -amount; // -amount = taking indexes from the end.
         const removedPhysicalIndexes = this.visualRowsToPhysical(rowIndex, amount);
-        const sourceRowsLength = this.hot.countSourceRows();
-        rowIndex = (sourceRowsLength + rowIndex) % sourceRowsLength;
+        const visualRowsLength = this.hot.countRows();
+        rowIndex = (visualRowsLength + rowIndex) % visualRowsLength;
         // It handle also callback from the `NestedRows` plugin. Removing parent node has effect in removing children nodes.
         const actionWasNotCancelled = this.hot.runHooks('beforeRemoveRow', rowIndex, removedPhysicalIndexes.length, removedPhysicalIndexes, source);
         if (actionWasNotCancelled === false) {
@@ -396,29 +396,13 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         }
         let isTableUniform = true;
         const removedColumnsCount = descendingPhysicalColumns.length;
-        const data = this.dataSource;
+        const data = this.dataSource ?? [];
         for(let c = 0; c < removedColumnsCount; c++){
             if (isTableUniform && removedPhysicalIndexes[0] !== removedPhysicalIndexes[c] - c) {
                 isTableUniform = false;
             }
         }
-        if (isTableUniform) {
-            for(let r = 0, rlen = this.hot.countSourceRows(); r < rlen; r++){
-                data[r].splice(removedPhysicalIndexes[0], amount);
-                if (r === 0) {
-                    this.metaManager.removeColumn(removedPhysicalIndexes[0], amount);
-                }
-            }
-        } else {
-            for(let r = 0, rlen = this.hot.countSourceRows(); r < rlen; r++){
-                for(let c = 0; c < removedColumnsCount; c++){
-                    data[r].splice(descendingPhysicalColumns[c], 1);
-                    if (r === 0) {
-                        this.metaManager.removeColumn(descendingPhysicalColumns[c], 1);
-                    }
-                }
-            }
-        }
+        _class_private_method_get(this, _spliceRemovedColumns, spliceRemovedColumns).call(this, data, isTableUniform, removedPhysicalIndexes, descendingPhysicalColumns, amount);
         if (columnIndex < this.hot.countCols()) {
             this.hot.columnIndexMapper.removeIndexes(removedPhysicalIndexes);
             if (!this.tableMeta.rowHeaders && this.hot.columnIndexMapper.getNotTrimmedIndexesLength() === 0) {
@@ -448,7 +432,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
             i += 1;
         }
         (0, _array.to2dArray)(elements);
-        this.hot.populateFromArray(index, col, elements, null, null, 'spliceCol');
+        this.hot.populateFromArray(index, col, elements, undefined, undefined, 'spliceCol');
         return removed;
     }
     /**
@@ -471,7 +455,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         }
         this.hot.populateFromArray(row, index, [
             elements
-        ], null, null, 'spliceRow');
+        ], undefined, undefined, 'spliceRow');
         return removed;
     }
     /**
@@ -506,7 +490,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         let data = this.hot.runHooks('filterData', index, amount, physicalRows);
         // Hooks by default returns first argument (when there is no callback changing execution result).
         if (Array.isArray(data) === false) {
-            data = this.dataSource.filter((row, rowIndex)=>physicalRows.indexOf(rowIndex) === -1);
+            data = this.dataSource.filter((_row, rowIndex)=>physicalRows.indexOf(rowIndex) === -1);
         }
         this.dataSource.length = 0;
         Array.prototype.push.apply(this.dataSource, data);
@@ -522,12 +506,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         let dataRow = this.dataSource[physicalRow];
         // TODO: To remove, use 'modifyData' hook instead (see below)
         const modifiedRowData = this.hot.runHooks('modifyRowData', physicalRow);
-        dataRow = isNaN(modifiedRowData) ? modifiedRowData : dataRow;
+        dataRow = typeof modifiedRowData !== 'number' ? modifiedRowData : dataRow;
         //
         const { dataDotNotation } = this.hot.getSettings();
         let value = null;
         // try to get value under property `prop` (includes dot)
-        if (dataRow && dataRow.hasOwnProperty && (0, _object.hasOwnProperty)(dataRow, prop)) {
+        if (dataRow && (0, _object.hasOwnProperty)(dataRow, prop)) {
             value = dataRow[prop];
         } else if (dataDotNotation && typeof prop === 'string' && prop.indexOf('.') > -1) {
             let out = dataRow;
@@ -546,7 +530,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
             value = prop(this.dataSource.slice(physicalRow, physicalRow + 1)[0]);
         }
         const visualColumnIndex = this.propToCol(prop);
-        const physicalColumn = this.hot.toPhysicalColumn(visualColumnIndex);
+        const physicalColumn = typeof visualColumnIndex === 'number' ? this.hot.toPhysicalColumn(visualColumnIndex) : null;
         if ((0, _number.isUnsignedNumber)(physicalRow) && (0, _number.isUnsignedNumber)(physicalColumn)) {
             value = (0, _valueAccessors.getValueGetterValue)(value, this.metaManager.getCellMeta(physicalRow, physicalColumn, {
                 visualRow: row,
@@ -570,7 +554,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    * @param {number} prop The column property.
    * @returns {string}
    */ getCopyable(row, prop) {
-        if (this.hot.getCellMeta(row, this.propToCol(prop)).copyable) {
+        const colIndex = this.propToCol(prop);
+        if (typeof colIndex === 'number' && this.hot.getCellMeta(row, colIndex).copyable) {
             return this.get(row, prop);
         }
         return '';
@@ -587,7 +572,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         let dataRow = this.dataSource[physicalRow];
         // TODO: To remove, use 'modifyData' hook instead (see below)
         const modifiedRowData = this.hot.runHooks('modifyRowData', physicalRow);
-        dataRow = isNaN(modifiedRowData) ? modifiedRowData : dataRow;
+        dataRow = typeof modifiedRowData !== 'number' ? modifiedRowData : dataRow;
         //
         if (this.hot.hasHook('modifyData')) {
             const valueHolder = (0, _object.createObjectPropListener)(newValue);
@@ -598,7 +583,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
         }
         const { dataDotNotation } = this.hot.getSettings();
         // try to set value under property `prop` (includes dot)
-        if (dataRow && dataRow.hasOwnProperty && (0, _object.hasOwnProperty)(dataRow, prop)) {
+        if (dataRow && (0, _object.hasOwnProperty)(dataRow, prop)) {
             dataRow[prop] = newValue;
         } else if (dataDotNotation && typeof prop === 'string' && prop.indexOf('.') > -1) {
             let out = dataRow;
@@ -635,16 +620,16 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    * @param {number} amount An amount of rows to translate.
    * @returns {number}
    */ visualRowsToPhysical(index, amount) {
-        const totalRows = this.hot.countSourceRows();
+        const totalRows = this.hot.countRows();
         const logicRows = [];
-        let physicRow = (totalRows + index) % totalRows;
+        let visualRow = (totalRows + index) % totalRows;
         let rowsToRemove = amount;
         let row;
-        while(physicRow < totalRows && rowsToRemove){
-            row = this.hot.toPhysicalRow(physicRow);
+        while(visualRow < totalRows && rowsToRemove){
+            row = this.hot.toPhysicalRow(visualRow);
             logicRows.push(row);
             rowsToRemove -= 1;
-            physicRow += 1;
+            visualRow += 1;
         }
         return logicRows;
     }
@@ -682,7 +667,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    */ getLength() {
         const maxRowsFromSettings = this.tableMeta.maxRows;
         let maxRows;
-        if (maxRowsFromSettings < 0 || maxRowsFromSettings === 0) {
+        if ((maxRowsFromSettings ?? 0) < 0 || maxRowsFromSettings === 0) {
             maxRows = 0;
         } else {
             maxRows = maxRowsFromSettings || Infinity;
@@ -733,8 +718,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
             return [];
         }
         const getFn = destination === DataMap.DESTINATION_CLIPBOARD_GENERATOR ? this.getCopyable : this.get;
-        const rlen = Math.min(Math.max(maxRows - 1, 0), Math.max(start.row, end.row));
-        const clen = Math.min(Math.max(maxCols - 1, 0), Math.max(start.col, end.col));
+        const rlen = Math.min(Math.max((maxRows ?? Infinity) - 1, 0), Math.max(start.row, end.row));
+        const clen = Math.min(Math.max((maxCols ?? Infinity) - 1, 0), Math.max(start.col, end.col));
         for(r = Math.min(start.row, end.row); r <= rlen; r++){
             row = [];
             // We just store indexes for rows without headers.
@@ -785,12 +770,81 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
    * @param {Array} data Array of arrays or array of objects containing data.
    * @param {MetaManager} metaManager The meta manager instance.
    */ constructor(hotInstance, data, metaManager){
+        _class_private_method_init(this, _buildColumnCache);
+        _class_private_method_init(this, _insertColumnIntoDataSource);
+        _class_private_method_init(this, _spliceRemovedColumns);
         this.hot = hotInstance;
         this.metaManager = metaManager;
         this.tableMeta = metaManager.getTableMeta();
         this.dataSource = data;
+        this.colToPropCache = [];
+        this.propToColCache = new Map();
         this.refreshDuckSchema();
         this.createMap();
     }
 }
+function buildColumnCache(columns, schema) {
+    let columnsLen = 0;
+    let filteredIndex = 0;
+    const isColumnsFn = typeof columns === 'function';
+    if (isColumnsFn) {
+        const schemaLen = (0, _object.deepObjectSize)(schema);
+        columnsLen = schemaLen > 0 ? schemaLen : this.countFirstRowKeys();
+    } else {
+        const maxCols = this.tableMeta.maxCols;
+        columnsLen = Math.min(maxCols ?? Infinity, columns.length);
+    }
+    for(let i = 0; i < columnsLen; i++){
+        const column = isColumnsFn ? columns(i) : columns[i];
+        if ((0, _object.isObject)(column)) {
+            if (typeof column.data !== 'undefined') {
+                const index = isColumnsFn ? filteredIndex : i;
+                const columnData = column.data;
+                this.colToPropCache[index] = columnData;
+                this.propToColCache.set(columnData, index);
+            }
+            filteredIndex += 1;
+        }
+    }
+}
+function insertColumnIntoDataSource(dataSource, col, visualColumnIndex, currentVisualColCount, numberOfSourceRows) {
+    if (typeof visualColumnIndex !== 'number' || visualColumnIndex >= currentVisualColCount) {
+        if (numberOfSourceRows > 0) {
+            for(let row = 0; row < numberOfSourceRows; row += 1){
+                if (typeof dataSource[row] === 'undefined') {
+                    dataSource[row] = [];
+                }
+                dataSource[row].push(null);
+            }
+        } else {
+            dataSource.push([
+                null
+            ]);
+        }
+    } else {
+        for(let row = 0; row < numberOfSourceRows; row++){
+            dataSource[row].splice(col, 0, null);
+        }
+    }
+}
+function spliceRemovedColumns(data, isTableUniform, removedPhysicalIndexes, descendingPhysicalColumns, amount) {
+    if (isTableUniform) {
+        for(let r = 0, rlen = this.hot.countSourceRows(); r < rlen; r++){
+            data[r].splice(removedPhysicalIndexes[0], amount);
+            if (r === 0) {
+                this.metaManager.removeColumn(removedPhysicalIndexes[0], amount);
+            }
+        }
+    } else {
+        const removedColumnsCount = descendingPhysicalColumns.length;
+        for(let r = 0, rlen = this.hot.countSourceRows(); r < rlen; r++){
+            for(let c = 0; c < removedColumnsCount; c++){
+                data[r].splice(descendingPhysicalColumns[c], 1);
+                if (r === 0) {
+                    this.metaManager.removeColumn(descendingPhysicalColumns[c], 1);
+                }
+            }
+        }
+    }
+}
 const _default = DataMap;