handsontable 0.0.0-next-7936038-20230411 → 0.0.0-next-931651e-20230412

package/plugins/formulas/formulas.mjs

@@ -19,6 +19,8 @@ import "core-js/modules/es.set.js";
 import "core-js/modules/es.string.iterator.js";
 import "core-js/modules/web.dom-collections.iterator.js";
 import "core-js/modules/es.array.map.js";
+import "core-js/modules/es.string.starts-with.js";
+import "core-js/modules/es.array.slice.js";
 import "core-js/modules/es.array.includes.js";
 import "core-js/modules/es.string.includes.js";
 import "core-js/modules/es.array.reverse.js";
@@ -35,7 +37,6 @@ import "core-js/modules/es.reflect.construct.js";
 import "core-js/modules/es.reflect.get.js";
 import "core-js/modules/es.object.get-own-property-descriptor.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.array.from.js";
 import "core-js/modules/es.regexp.exec.js";
@@ -70,7 +71,7 @@ import { error, warn } from "../../helpers/console.mjs";
 import { isNumeric } from "../../helpers/number.mjs";
 import { isDefined, isUndefined } from "../../helpers/mixed.mjs";
 import { setupEngine, setupSheet, unregisterEngine, getRegisteredHotInstances } from "./engine/register.mjs";
-import { isEscapedFormulaExpression, unescapeFormulaExpression } from "./utils.mjs";
+import { isEscapedFormulaExpression, unescapeFormulaExpression, isDate, isDateValid, getDateInHfFormat, getDateFromExcelDate, getDateInHotFormat, isFormula } from "./utils.mjs";
 import { getEngineSettingsWithOverrides } from "./engine/settings.mjs";
 import { isArrayOfArrays } from "../../helpers/data.mjs";
 import { toUpperCaseFirst } from "../../helpers/string.mjs";
@@ -291,6 +292,13 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
         return _this8.onAfterRemoveCol.apply(_this8, arguments);
       });
 
+      // TODO: Actions related to overwriting dates from HOT format to HF default format are done as callback to this
+      // hook, because some hooks, such as `afterLoadData` doesn't have information about composed cell properties.
+      // Another hooks are triggered to late for setting HF's engine data needed for some actions.
+      this.addHook('afterCellMetaReset', function () {
+        return _this8.onAfterCellMetaReset.apply(_this8, arguments);
+      });
+
       // Handling undo actions on data just using HyperFormula's UndoRedo mechanism
       this.addHook('beforeUndo', function (action) {
         // TODO: Move action isn't handled by HyperFormula.
@@ -659,6 +667,16 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
         warn("Not possible to set cell data at ".concat(JSON.stringify(address)));
         return;
       }
+      var cellMeta = this.hot.getCellMeta(row, column);
+      if (isDate(newValue, cellMeta.type)) {
+        if (isDateValid(newValue, cellMeta.dateFormat)) {
+          // Rewriting date in HOT format to HF format.
+          newValue = getDateInHfFormat(newValue, cellMeta.dateFormat);
+        } else if (isFormula(newValue) === false) {
+          // Escaping value from date parsing using "'" sign (HF feature).
+          newValue = "'".concat(newValue);
+        }
+      }
       return this.engine.setCellContents(address, newValue);
     }
 
@@ -682,7 +700,12 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
           col: this.hot.toPhysicalColumn(visualColumn),
           sheet: this.sheetId
         };
-        var cellValue = this.engine.getCellValue(address);
+        var cellMeta = this.hot.getCellMeta(visualRow, visualColumn);
+        var cellValue = this.engine.getCellValue(address); // Date as an integer (Excel-like date).
+
+        if (cellMeta.type === 'date' && isNumeric(cellValue)) {
+          cellValue = getDateFromExcelDate(cellValue, cellMeta.dateFormat);
+        }
 
         // If `cellValue` is an object it is expected to be an error
         return _typeof(cellValue) === 'object' && cellValue !== null ? cellValue.value : cellValue;
@@ -723,7 +746,33 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
       if (this.engine.isItPossibleToSetCellContents(engineTargetRange) === false) {
         return false;
       }
-      return this.engine.getFillRangeData(engineSourceRange, engineTargetRange);
+      var fillRangeData = this.engine.getFillRangeData(engineSourceRange, engineTargetRange);
+      var _engineSourceRange$st = engineSourceRange.start,
+        sourceStartRow = _engineSourceRange$st.row,
+        sourceStartColumn = _engineSourceRange$st.col;
+      var _engineSourceRange$en = engineSourceRange.end,
+        sourceEndRow = _engineSourceRange$en.row,
+        sourceEndColumn = _engineSourceRange$en.col;
+      var populationRowLength = sourceEndRow - sourceStartRow + 1;
+      var populationColumnLength = sourceEndColumn - sourceStartColumn + 1;
+      for (var populatedRowIndex = 0; populatedRowIndex < fillRangeData.length; populatedRowIndex += 1) {
+        for (var populatedColumnIndex = 0; populatedColumnIndex < fillRangeData[populatedRowIndex].length; populatedColumnIndex += 1) {
+          var populatedValue = fillRangeData[populatedRowIndex][populatedColumnIndex];
+          var sourceRow = populatedRowIndex % populationRowLength;
+          var sourceColumn = populatedColumnIndex % populationColumnLength;
+          var sourceCellMeta = this.hot.getCellMeta(sourceRow, sourceColumn);
+          if (isDate(populatedValue, sourceCellMeta.type)) {
+            if (populatedValue.startsWith('\'')) {
+              // Populating values on HOT side without apostrophe.
+              fillRangeData[populatedRowIndex][populatedColumnIndex] = populatedValue.slice(1);
+            } else if (this.isFormulaCellType(sourceRow, sourceColumn, this.sheetId) === false) {
+              // Populating date in proper format, coming from the source cell.
+              fillRangeData[populatedRowIndex][populatedColumnIndex] = getDateInHotFormat(populatedValue, sourceCellMeta.dateFormat);
+            }
+          }
+        }
+      }
+      return fillRangeData;
     }
 
     /**
@@ -747,6 +796,40 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
       _classPrivateFieldSet(this, _hotWasInitializedWithEmptyData, isUndefined(this.hot.getSettings().data));
     }
 
+    /**
+     * Callback to `afterCellMetaReset` hook which is triggered after setting cell meta.
+     *
+     * @private
+     */
+  }, {
+    key: "onAfterCellMetaReset",
+    value: function onAfterCellMetaReset() {
+      var _this14 = this;
+      var sourceDataArray = this.hot.getSourceDataArray();
+      var valueChanged = false;
+      sourceDataArray.forEach(function (rowData, rowIndex) {
+        rowData.forEach(function (cellValue, columnIndex) {
+          var cellMeta = _this14.hot.getCellMeta(rowIndex, columnIndex);
+          var dateFormat = cellMeta.dateFormat;
+          if (isDate(cellValue, cellMeta.type)) {
+            valueChanged = true;
+            if (isDateValid(cellValue, dateFormat)) {
+              // Rewriting date in HOT format to HF format.
+              sourceDataArray[rowIndex][columnIndex] = getDateInHfFormat(cellValue, dateFormat);
+            } else if (_this14.isFormulaCellType(rowIndex, columnIndex) === false) {
+              // Escaping value from date parsing using "'" sign (HF feature).
+              sourceDataArray[rowIndex][columnIndex] = "'".concat(cellValue);
+            }
+          }
+        });
+      });
+      if (valueChanged === true) {
+        _classPrivateFieldSet(this, _internalOperationPending, true);
+        this.engine.setSheetContent(this.sheetId, sourceDataArray);
+        _classPrivateFieldSet(this, _internalOperationPending, false);
+      }
+    }
+
     /**
      * `afterLoadData` hook callback.
      *
@@ -767,7 +850,7 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
         var sourceDataArray = this.hot.getSourceDataArray();
         if (this.engine.isItPossibleToReplaceSheetContent(this.sheetId, sourceDataArray)) {
           _classPrivateFieldSet(this, _internalOperationPending, true);
-          var dependentCells = this.engine.setSheetContent(this.sheetId, this.hot.getSourceDataArray());
+          var dependentCells = this.engine.setSheetContent(this.sheetId, sourceDataArray);
           this.renderDependentSheets(dependentCells);
           _classPrivateFieldSet(this, _internalOperationPending, false);
         }
@@ -812,7 +895,11 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
         col: this.toPhysicalColumnPosition(column),
         sheet: this.sheetId
       };
-      var cellValue = this.engine.getCellValue(address);
+      var cellValue = this.engine.getCellValue(address); // Date as an integer (Excel like date).
+      var cellMeta = this.hot.getCellMeta(row, column);
+      if (cellMeta.type === 'date' && isNumeric(cellValue)) {
+        cellValue = getDateFromExcelDate(cellValue, cellMeta.dateFormat);
+      }
 
       // If `cellValue` is an object it is expected to be an error
       var value = _typeof(cellValue) === 'object' && cellValue !== null ? cellValue.value : cellValue;
@@ -875,7 +962,7 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onAfterSetDataAtCell",
     value: function onAfterSetDataAtCell(changes, source) {
-      var _this14 = this;
+      var _this15 = this;
       if (isBlockedSource(source)) {
         return;
       }
@@ -887,16 +974,16 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
             row = _ref10[0],
             prop = _ref10[1],
             newValue = _ref10[3];
-          var column = _this14.hot.propToCol(prop);
-          var physicalRow = _this14.hot.toPhysicalRow(row);
-          var physicalColumn = _this14.hot.toPhysicalColumn(column);
+          var column = _this15.hot.propToCol(prop);
+          var physicalRow = _this15.hot.toPhysicalRow(row);
+          var physicalColumn = _this15.hot.toPhysicalColumn(column);
           var address = {
             row: physicalRow,
             col: physicalColumn,
-            sheet: _this14.sheetId
+            sheet: _this15.sheetId
           };
           if (physicalRow !== null && physicalColumn !== null) {
-            _this14.syncChangeWithEngine(row, column, newValue);
+            _this15.syncChangeWithEngine(row, column, newValue);
           } else {
             outOfBoundsChanges.push([row, column, newValue]);
           }
@@ -909,16 +996,16 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
         // Workaround for rows/columns being created two times (by HOT and the engine).
         // (unfortunately, this requires an extra re-render)
         this.hot.addHookOnce('afterChange', function () {
-          var outOfBoundsDependentCells = _this14.engine.batch(function () {
+          var outOfBoundsDependentCells = _this15.engine.batch(function () {
             outOfBoundsChanges.forEach(function (_ref11) {
               var _ref12 = _slicedToArray(_ref11, 3),
                 row = _ref12[0],
                 column = _ref12[1],
                 newValue = _ref12[2];
-              _this14.syncChangeWithEngine(row, column, newValue);
+              _this15.syncChangeWithEngine(row, column, newValue);
             });
           });
-          _this14.renderDependentSheets(outOfBoundsDependentCells, true);
+          _this15.renderDependentSheets(outOfBoundsDependentCells, true);
         });
       }
       this.renderDependentSheets(dependentCells);
@@ -936,7 +1023,7 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onAfterSetSourceDataAtCell",
     value: function onAfterSetSourceDataAtCell(changes, source) {
-      var _this15 = this;
+      var _this16 = this;
       if (isBlockedSource(source)) {
         return;
       }
@@ -947,23 +1034,23 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
           row = _ref14[0],
           prop = _ref14[1],
           newValue = _ref14[3];
-        var column = _this15.hot.propToCol(prop);
+        var column = _this16.hot.propToCol(prop);
         if (!isNumeric(column)) {
           return;
         }
         var address = {
           row: row,
-          col: _this15.toPhysicalColumnPosition(column),
-          sheet: _this15.sheetId
+          col: _this16.toPhysicalColumnPosition(column),
+          sheet: _this16.sheetId
         };
-        if (!_this15.engine.isItPossibleToSetCellContents(address)) {
+        if (!_this16.engine.isItPossibleToSetCellContents(address)) {
           warn("Not possible to set source cell data at ".concat(JSON.stringify(address)));
           return;
         }
         changedCells.push({
           address: address
         });
-        dependentCells.push.apply(dependentCells, _toConsumableArray(_this15.engine.setCellContents(address, newValue)));
+        dependentCells.push.apply(dependentCells, _toConsumableArray(_this16.engine.setCellContents(address, newValue)));
       });
       this.renderDependentSheets(dependentCells);
       this.validateDependentCells(dependentCells, changedCells);
@@ -1013,9 +1100,9 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onBeforeRemoveRow",
     value: function onBeforeRemoveRow(row, amount, physicalRows) {
-      var _this16 = this;
+      var _this17 = this;
       var possible = physicalRows.every(function (physicalRow) {
-        return _this16.engine.isItPossibleToRemoveRows(_this16.sheetId, [physicalRow, 1]);
+        return _this17.engine.isItPossibleToRemoveRows(_this17.sheetId, [physicalRow, 1]);
       });
       return possible === false ? false : void 0;
     }
@@ -1032,9 +1119,9 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onBeforeRemoveCol",
     value: function onBeforeRemoveCol(col, amount, physicalColumns) {
-      var _this17 = this;
+      var _this18 = this;
       var possible = physicalColumns.every(function (physicalColumn) {
-        return _this17.engine.isItPossibleToRemoveColumns(_this17.sheetId, [physicalColumn, 1]);
+        return _this18.engine.isItPossibleToRemoveColumns(_this18.sheetId, [physicalColumn, 1]);
       });
       return possible === false ? false : void 0;
     }
@@ -1090,14 +1177,14 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onAfterRemoveRow",
     value: function onAfterRemoveRow(row, amount, physicalRows, source) {
-      var _this18 = this;
+      var _this19 = this;
       if (isBlockedSource(source)) {
         return;
       }
       var descendingPhysicalRows = physicalRows.sort().reverse();
       var changes = this.engine.batch(function () {
         descendingPhysicalRows.forEach(function (physicalRow) {
-          _this18.engine.removeRows(_this18.sheetId, [physicalRow, 1]);
+          _this19.engine.removeRows(_this19.sheetId, [physicalRow, 1]);
         });
       });
       this.renderDependentSheets(changes);
@@ -1116,14 +1203,14 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
   }, {
     key: "onAfterRemoveCol",
     value: function onAfterRemoveCol(col, amount, physicalColumns, source) {
-      var _this19 = this;
+      var _this20 = this;
       if (isBlockedSource(source)) {
         return;
       }
       var descendingPhysicalColumns = physicalColumns.sort().reverse();
       var changes = this.engine.batch(function () {
         descendingPhysicalColumns.forEach(function (physicalColumn) {
-          _this19.engine.removeColumns(_this19.sheetId, [physicalColumn, 1]);
+          _this20.engine.removeColumns(_this20.sheetId, [physicalColumn, 1]);
         });
       });
       this.renderDependentSheets(changes);
@@ -1142,16 +1229,16 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
     key: "onAfterDetachChild",
     value: function onAfterDetachChild(parent, element, finalElementRowIndex) {
       var _element$__children,
-        _this20 = this;
+        _this21 = this;
       _classPrivateFieldSet(this, _internalOperationPending, true);
       var rowsData = this.hot.getSourceDataArray(finalElementRowIndex, 0, finalElementRowIndex + (((_element$__children = element.__children) === null || _element$__children === void 0 ? void 0 : _element$__children.length) || 0), this.hot.countSourceCols());
       _classPrivateFieldSet(this, _internalOperationPending, false);
       rowsData.forEach(function (row, relativeRowIndex) {
         row.forEach(function (value, colIndex) {
-          _this20.engine.setCellContents({
+          _this21.engine.setCellContents({
             col: colIndex,
             row: finalElementRowIndex + relativeRowIndex,
-            sheet: _this20.sheetId
+            sheet: _this21.sheetId
           }, [[value]]);
         });
       });

package/plugins/formulas/utils.js

@@ -1,8 +1,19 @@
 "use strict";
 
 exports.__esModule = true;
+exports.getDateFromExcelDate = getDateFromExcelDate;
+exports.getDateInHfFormat = getDateInHfFormat;
+exports.getDateInHotFormat = getDateInHotFormat;
+exports.isDate = isDate;
+exports.isDateValid = isDateValid;
 exports.isEscapedFormulaExpression = isEscapedFormulaExpression;
+exports.isFormula = isFormula;
 exports.unescapeFormulaExpression = unescapeFormulaExpression;
+require("core-js/modules/es.string.starts-with.js");
+var _moment = _interopRequireDefault(require("moment"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var DEFAULT_DATE_FORMAT_HYPERFORMULA = 'DD/MM/YYYY';
+
 /**
  * Checks if provided formula expression is escaped.
  *
@@ -21,4 +32,74 @@ function isEscapedFormulaExpression(expression) {
  */
 function unescapeFormulaExpression(expression) {
   return isEscapedFormulaExpression(expression) ? expression.substr(1) : expression;
+}
+
+/**
+ * Checks whether string looks like formula or not. Corresponds to {@link https://hyperformula.handsontable.com/api/globals.html#isformula|HyperFormula's implementation}.
+ *
+ * @param {string} value Checked value.
+ * @returns {boolean}
+ */
+function isFormula(value) {
+  return typeof value === 'string' && value.startsWith('=');
+}
+
+/**
+ * Checks if provided value is a date according to cell meta.
+ *
+ * @param {*} value Checked value.
+ * @param {string} cellType Type of a cell.
+ * @returns {boolean}
+ */
+function isDate(value, cellType) {
+  return typeof value === 'string' && cellType === 'date';
+}
+
+/**
+ * Checks if provided date is a valid date according to cell date format.
+ *
+ * @param {*} date Checked date.
+ * @param {object} dateFormat Handled format for a date.
+ * @returns {boolean}
+ */
+function isDateValid(date, dateFormat) {
+  return (0, _moment.default)(date, dateFormat, true).isValid();
+}
+
+/**
+ * Returns date formatted in HF's default format.
+ *
+ * @param {string} date Date formatted according to Handsontable cell date format.
+ * @param {string} dateFormat The format used for the date passed.
+ * @returns {string}
+ */
+function getDateInHfFormat(date, dateFormat) {
+  return (0, _moment.default)(date, dateFormat, true).format(DEFAULT_DATE_FORMAT_HYPERFORMULA);
+}
+
+/**
+ * Returns date formatted in HF's default format.
+ *
+ * @param {string} date Date formatted according to Handsontable cell date format.
+ * @param {string} dateFormat The format used for the date passed.
+ * @returns {string}
+ */
+function getDateInHotFormat(date, dateFormat) {
+  return (0, _moment.default)(date, DEFAULT_DATE_FORMAT_HYPERFORMULA, true).format(dateFormat);
+}
+
+/**
+ * Converts Excel-like dates into strings and formats them based on the handled date format.
+ *
+ * @param {number} numericDate An integer representing numbers of days from January 1, 1900.
+ * @param {string} dateFormat The format used for parsing an output.
+ * @returns {string}
+ */
+function getDateFromExcelDate(numericDate, dateFormat) {
+  // To replicate the behavior from the HyperFormula. UTC starts from 31/12/1899, while HF from 30/12/1899.
+  var dateOffset = -1;
+
+  // Based on solution from: https://stackoverflow.com/a/67130235.
+  var dateForFormatting = new Date(Date.UTC(0, 0, numericDate + dateOffset));
+  return (0, _moment.default)(dateForFormatting).format(dateFormat);
 }

package/plugins/formulas/utils.mjs

@@ -1,3 +1,7 @@
+import "core-js/modules/es.string.starts-with.js";
+import moment from 'moment';
+var DEFAULT_DATE_FORMAT_HYPERFORMULA = 'DD/MM/YYYY';
+
 /**
  * Checks if provided formula expression is escaped.
  *
@@ -16,4 +20,74 @@ export function isEscapedFormulaExpression(expression) {
  */
 export function unescapeFormulaExpression(expression) {
   return isEscapedFormulaExpression(expression) ? expression.substr(1) : expression;
+}
+
+/**
+ * Checks whether string looks like formula or not. Corresponds to {@link https://hyperformula.handsontable.com/api/globals.html#isformula|HyperFormula's implementation}.
+ *
+ * @param {string} value Checked value.
+ * @returns {boolean}
+ */
+export function isFormula(value) {
+  return typeof value === 'string' && value.startsWith('=');
+}
+
+/**
+ * Checks if provided value is a date according to cell meta.
+ *
+ * @param {*} value Checked value.
+ * @param {string} cellType Type of a cell.
+ * @returns {boolean}
+ */
+export function isDate(value, cellType) {
+  return typeof value === 'string' && cellType === 'date';
+}
+
+/**
+ * Checks if provided date is a valid date according to cell date format.
+ *
+ * @param {*} date Checked date.
+ * @param {object} dateFormat Handled format for a date.
+ * @returns {boolean}
+ */
+export function isDateValid(date, dateFormat) {
+  return moment(date, dateFormat, true).isValid();
+}
+
+/**
+ * Returns date formatted in HF's default format.
+ *
+ * @param {string} date Date formatted according to Handsontable cell date format.
+ * @param {string} dateFormat The format used for the date passed.
+ * @returns {string}
+ */
+export function getDateInHfFormat(date, dateFormat) {
+  return moment(date, dateFormat, true).format(DEFAULT_DATE_FORMAT_HYPERFORMULA);
+}
+
+/**
+ * Returns date formatted in HF's default format.
+ *
+ * @param {string} date Date formatted according to Handsontable cell date format.
+ * @param {string} dateFormat The format used for the date passed.
+ * @returns {string}
+ */
+export function getDateInHotFormat(date, dateFormat) {
+  return moment(date, DEFAULT_DATE_FORMAT_HYPERFORMULA, true).format(dateFormat);
+}
+
+/**
+ * Converts Excel-like dates into strings and formats them based on the handled date format.
+ *
+ * @param {number} numericDate An integer representing numbers of days from January 1, 1900.
+ * @param {string} dateFormat The format used for parsing an output.
+ * @returns {string}
+ */
+export function getDateFromExcelDate(numericDate, dateFormat) {
+  // To replicate the behavior from the HyperFormula. UTC starts from 31/12/1899, while HF from 30/12/1899.
+  var dateOffset = -1;
+
+  // Based on solution from: https://stackoverflow.com/a/67130235.
+  var dateForFormatting = new Date(Date.UTC(0, 0, numericDate + dateOffset));
+  return moment(dateForFormatting).format(dateFormat);
 }