handsontable 16.2.0 → 17.0.0-rc3

package/validators/intlDateValidator/intlDateValidator.mjs

@@ -0,0 +1,34 @@
+import { isValidISODate } from "../../helpers/dateTime.mjs";
+import { isEmpty } from "../../helpers/mixed.mjs";
+export const VALIDATOR_TYPE = 'intl-date';
+export const SOURCE_DATA_WARNING_MESSAGE = 'Source data warning ([itemsCount]). ' + 'Invalid value for "intl-date" cell type.\n\n' + '[affectedCells]\n\n' + 'Expected a value compatible with the ISO 8601 date format ("YYYY-MM-DD").';
+
+/**
+ * Source data validator.
+ *
+ * @param {*} value Value of the source data of the cell.
+ * @param {CellMeta} cellMeta Cell meta object.
+ * @returns {boolean} True if valid, false otherwise.
+ */
+export function sourceDataValidator(value, cellMeta) {
+  if (cellMeta.allowEmpty && isEmpty(value)) {
+    return true;
+  }
+  return isValidISODate(value);
+}
+
+/**
+ * The Date cell validator.
+ *
+ * @private
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ */
+export function intlDateValidator(value, callback) {
+  if (this.allowEmpty && isEmpty(value)) {
+    callback(true);
+    return;
+  }
+  callback(isValidISODate(value));
+}
+intlDateValidator.VALIDATOR_TYPE = VALIDATOR_TYPE;

package/validators/intlTimeValidator/index.d.ts

@@ -0,0 +1 @@
+export { VALIDATOR_TYPE, intlTimeValidator, sourceDataValidator } from './intlTimeValidator';

package/validators/intlTimeValidator/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+exports.__esModule = true;
+var _intlTimeValidator = require("./intlTimeValidator");
+exports.VALIDATOR_TYPE = _intlTimeValidator.VALIDATOR_TYPE;
+exports.SOURCE_DATA_WARNING_MESSAGE = _intlTimeValidator.SOURCE_DATA_WARNING_MESSAGE;
+exports.intlTimeValidator = _intlTimeValidator.intlTimeValidator;
+exports.sourceDataValidator = _intlTimeValidator.sourceDataValidator;

package/validators/intlTimeValidator/index.mjs

@@ -0,0 +1 @@
+export { VALIDATOR_TYPE, SOURCE_DATA_WARNING_MESSAGE, intlTimeValidator, sourceDataValidator } from "./intlTimeValidator.mjs";

package/validators/intlTimeValidator/intlTimeValidator.d.ts

@@ -0,0 +1,6 @@
+import { CellProperties } from '../../settings';
+import { CellValue } from '../../common';
+
+export const VALIDATOR_TYPE: 'intl-time';
+export function sourceDataValidator(value: CellValue, cellProperties: CellProperties): boolean;
+export function intlTimeValidator(this: CellProperties, value: CellValue, callback: (valid: boolean) => void): void;

package/validators/intlTimeValidator/intlTimeValidator.js

@@ -0,0 +1,39 @@
+"use strict";
+
+exports.__esModule = true;
+exports.intlTimeValidator = intlTimeValidator;
+exports.sourceDataValidator = sourceDataValidator;
+var _dateTime = require("../../helpers/dateTime");
+var _mixed = require("../../helpers/mixed");
+const VALIDATOR_TYPE = exports.VALIDATOR_TYPE = 'intl-time';
+const SOURCE_DATA_WARNING_MESSAGE = exports.SOURCE_DATA_WARNING_MESSAGE = 'Source data warning ([itemsCount]). ' + 'Invalid value for "intl-time" cell type.\n\n' + '[affectedCells]\n\n' + 'Expected a value compatible with the 24-hour time format ("HH:mm", "HH:mm:ss" or "HH:mm:ss.SSS").';
+
+/**
+ * Source data validator.
+ *
+ * @param {*} value Value of the source data of the cell.
+ * @param {CellMeta} cellMeta Cell meta object.
+ * @returns {boolean} True if valid, false otherwise.
+ */
+function sourceDataValidator(value, cellMeta) {
+  if (cellMeta.allowEmpty && (0, _mixed.isEmpty)(value)) {
+    return true;
+  }
+  return (0, _dateTime.isValidTime)(value);
+}
+
+/**
+ * The IntlTime cell validator.
+ *
+ * @private
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ */
+function intlTimeValidator(value, callback) {
+  if (this.allowEmpty && (0, _mixed.isEmpty)(value)) {
+    callback(true);
+    return;
+  }
+  callback((0, _dateTime.isValidTime)(value));
+}
+intlTimeValidator.VALIDATOR_TYPE = VALIDATOR_TYPE;

package/validators/intlTimeValidator/intlTimeValidator.mjs

@@ -0,0 +1,34 @@
+import { isValidTime } from "../../helpers/dateTime.mjs";
+import { isEmpty } from "../../helpers/mixed.mjs";
+export const VALIDATOR_TYPE = 'intl-time';
+export const SOURCE_DATA_WARNING_MESSAGE = 'Source data warning ([itemsCount]). ' + 'Invalid value for "intl-time" cell type.\n\n' + '[affectedCells]\n\n' + 'Expected a value compatible with the 24-hour time format ("HH:mm", "HH:mm:ss" or "HH:mm:ss.SSS").';
+
+/**
+ * Source data validator.
+ *
+ * @param {*} value Value of the source data of the cell.
+ * @param {CellMeta} cellMeta Cell meta object.
+ * @returns {boolean} True if valid, false otherwise.
+ */
+export function sourceDataValidator(value, cellMeta) {
+  if (cellMeta.allowEmpty && isEmpty(value)) {
+    return true;
+  }
+  return isValidTime(value);
+}
+
+/**
+ * The IntlTime cell validator.
+ *
+ * @private
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ */
+export function intlTimeValidator(value, callback) {
+  if (this.allowEmpty && isEmpty(value)) {
+    callback(true);
+    return;
+  }
+  callback(isValidTime(value));
+}
+intlTimeValidator.VALIDATOR_TYPE = VALIDATOR_TYPE;

package/validators/multiSelectValidator/index.js

@@ -0,0 +1,6 @@
+"use strict";
+
+exports.__esModule = true;
+var _multiSelectValidator = require("./multiSelectValidator");
+exports.VALIDATOR_TYPE = _multiSelectValidator.VALIDATOR_TYPE;
+exports.multiSelectValidator = _multiSelectValidator.multiSelectValidator;

package/validators/multiSelectValidator/index.mjs

@@ -0,0 +1 @@
+export { VALIDATOR_TYPE, multiSelectValidator } from "./multiSelectValidator.mjs";

package/validators/multiSelectValidator/multiSelectValidator.js

@@ -0,0 +1,84 @@
+"use strict";
+
+exports.__esModule = true;
+exports.multiSelectValidator = multiSelectValidator;
+var _object = require("../../helpers/object");
+const VALIDATOR_TYPE = exports.VALIDATOR_TYPE = 'multiselect';
+
+/**
+ * The MultiSelect cell validator.
+ *
+ * @private
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ */
+function multiSelectValidator(value, callback) {
+  let valueToValidate = value;
+  if (valueToValidate === null || valueToValidate === undefined) {
+    valueToValidate = '';
+  }
+
+  // Handle allowEmpty option
+  if (this.allowEmpty && valueToValidate === '') {
+    callback(true);
+    return;
+  } else if (!this.allowEmpty && valueToValidate === '') {
+    callback(false);
+    return;
+  }
+
+  // Fail if value is not an array
+  if (!Array.isArray(valueToValidate)) {
+    callback(false);
+    return;
+  }
+
+  // Empty array is valid
+  if (Array.isArray(valueToValidate) && valueToValidate.length === 0) {
+    callback(true);
+    return;
+  }
+  if (this.source) {
+    if (typeof this.source === 'function') {
+      this.source(valueToValidate, process(valueToValidate, callback));
+    } else {
+      process(valueToValidate, callback)(this.source);
+    }
+  } else {
+    callback(true);
+  }
+}
+multiSelectValidator.VALIDATOR_TYPE = VALIDATOR_TYPE;
+
+/**
+ * Function responsible for validation of multiSelect value.
+ *
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ * @returns {Function}
+ */
+function process(value, callback) {
+  const originalVal = value;
+  return function (source) {
+    let allValid = true;
+    for (let i = 0, len = originalVal.length; i < len; i++) {
+      let found = false;
+      for (let s = 0, slen = source.length; s < slen; s++) {
+        if ((0, _object.isKeyValueObject)(originalVal[i]) && !(0, _object.isKeyValueObject)(source[s]) || !(0, _object.isKeyValueObject)(originalVal[i]) && (0, _object.isKeyValueObject)(source[s])) {
+          // Type mismatch - fail validation.
+          found = false;
+          break;
+        } else if ((0, _object.isKeyValueObject)(originalVal[i]) && (0, _object.isKeyValueObject)(source[s]) && (0, _object.isObjectEqual)(originalVal[i], source[s])) {
+          found = true;
+        } else if (typeof originalVal[i] === 'string' && typeof source[s] === 'string' && originalVal[i] === source[s]) {
+          found = true;
+        }
+      }
+      if (!found) {
+        allValid = false;
+        break;
+      }
+    }
+    callback(allValid);
+  };
+}

package/validators/multiSelectValidator/multiSelectValidator.mjs

@@ -0,0 +1,80 @@
+import { isObjectEqual, isKeyValueObject } from "../../helpers/object.mjs";
+export const VALIDATOR_TYPE = 'multiselect';
+
+/**
+ * The MultiSelect cell validator.
+ *
+ * @private
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ */
+export function multiSelectValidator(value, callback) {
+  let valueToValidate = value;
+  if (valueToValidate === null || valueToValidate === undefined) {
+    valueToValidate = '';
+  }
+
+  // Handle allowEmpty option
+  if (this.allowEmpty && valueToValidate === '') {
+    callback(true);
+    return;
+  } else if (!this.allowEmpty && valueToValidate === '') {
+    callback(false);
+    return;
+  }
+
+  // Fail if value is not an array
+  if (!Array.isArray(valueToValidate)) {
+    callback(false);
+    return;
+  }
+
+  // Empty array is valid
+  if (Array.isArray(valueToValidate) && valueToValidate.length === 0) {
+    callback(true);
+    return;
+  }
+  if (this.source) {
+    if (typeof this.source === 'function') {
+      this.source(valueToValidate, process(valueToValidate, callback));
+    } else {
+      process(valueToValidate, callback)(this.source);
+    }
+  } else {
+    callback(true);
+  }
+}
+multiSelectValidator.VALIDATOR_TYPE = VALIDATOR_TYPE;
+
+/**
+ * Function responsible for validation of multiSelect value.
+ *
+ * @param {*} value Value of edited cell.
+ * @param {Function} callback Callback called with validation result.
+ * @returns {Function}
+ */
+function process(value, callback) {
+  const originalVal = value;
+  return function (source) {
+    let allValid = true;
+    for (let i = 0, len = originalVal.length; i < len; i++) {
+      let found = false;
+      for (let s = 0, slen = source.length; s < slen; s++) {
+        if (isKeyValueObject(originalVal[i]) && !isKeyValueObject(source[s]) || !isKeyValueObject(originalVal[i]) && isKeyValueObject(source[s])) {
+          // Type mismatch - fail validation.
+          found = false;
+          break;
+        } else if (isKeyValueObject(originalVal[i]) && isKeyValueObject(source[s]) && isObjectEqual(originalVal[i], source[s])) {
+          found = true;
+        } else if (typeof originalVal[i] === 'string' && typeof source[s] === 'string' && originalVal[i] === source[s]) {
+          found = true;
+        }
+      }
+      if (!found) {
+        allValid = false;
+        break;
+      }
+    }
+    callback(allValid);
+  };
+}

package/validators/registry.js

@@ -3,8 +3,8 @@
 exports.__esModule = true;
 exports.getValidator = _getItem;
 exports.registerValidator = _register;
-require("core-js/modules/es.error.cause.js");
 var _staticRegister = require("../utils/staticRegister");
+var _errors = require("../helpers/errors");
 const {
   register,
   getItem,
@@ -27,7 +27,7 @@ function _getItem(name) {
     return name;
   }
   if (!hasItem(name)) {
-    throw Error(`No registered validator found under "${name}" name`);
+    (0, _errors.throwWithCause)(`No registered validator found under "${name}" name`);
   }
   return getItem(name);
 }

package/validators/registry.mjs

@@ -1,5 +1,5 @@
-import "core-js/modules/es.error.cause.js";
 import { staticRegister } from "../utils/staticRegister.mjs";
+import { throwWithCause } from "../helpers/errors.mjs";
 const {
   register,
   getItem,
@@ -19,7 +19,7 @@ function _getItem(name) {
     return name;
   }
   if (!hasItem(name)) {
-    throw Error(`No registered validator found under "${name}" name`);
+    throwWithCause(`No registered validator found under "${name}" name`);
   }
   return getItem(name);
 }

package/dist/README.md

@@ -1,54 +0,0 @@
-# Handsontable distributions
-
-## Full distribution (recommended)
-
-The full distribution allows you to use Handsontable by including just 2 files:
-```html
-<script src="dist/handsontable.full.js"></script>
-<link href="dist/handsontable.full.css" rel="stylesheet">
-```
-You can also use minified files:  
-```html
-<script src="dist/handsontable.full.min.js"></script>
-<link href="dist/handsontable.full.min.css" rel="stylesheet">
-```
-
-**handsontable.full.js** and **handsontable.full.css** are compiled with ___all___ the needed dependencies.
-
-## Bare distribution
-
-If you are a "Bob the Builder" kind of hacker, you will need to load Handsontable JS, CSS and their dependencies:
-```html
-<!-- Required dependencies (as external scripts) -->
-<link href="https://cdn.jsdelivr.net/npm/pikaday@1.5.1/css/pikaday.min.css" rel="stylesheet">
-<script src="https://cdn.jsdelivr.net/npm/moment@2.20.1/moment.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/pikaday@1.5.1/pikaday.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/numbro@2/dist/numbro.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/dompurify@2.0.8/dist/purify.js"></script>
-
-<!-- Optional dependencies -->
-<script src="https://cdn.jsdelivr.net/npm/hyperformula@0.6.0/dist/hyperformula.full.min.js"></script>
-
-<!-- Handsontable bare files -->
-<script src="dist/handsontable.js"></script>
-<link href="dist/handsontable.css" rel="stylesheet">
-```
-
-**handsontable.js** and **handsontable.css** are compiled ___without___ the needed dependencies. You will have to include `pikaday.js`, `moment.js`, `numbro.js`, `hyperformula` and `dompurify` on your own ie. from JSDelivr CDN.
-
-## Internationalization
-It is possible to include files which will register languages dictionaries. They allow to translate parts of Handsontable UI. You can either use only particular languages files or include all of them at once as a single file.
-
-All the information about the API and additional options can be found at our [official documentation](https://handsontable.com/docs/internationalization-i18n/).
-
-```html
-<!-- Internationalization, Polish - Poland language-country file -->
-<script src="dist/languages/pl-PL.js"></script>
-
-<!-- Internationalization, all available language files in one file -->
-<script src="dist/languages/all.js"></script>
-```
-
-## Custom distribution
-
-If you want to build your own custom Handsontable package distribution check out our [guide](https://handsontable.com/docs/building/) covering all the details.