handsontable 16.1.1 → 16.2.0-next-216dbd0-20251112

package/plugins/base/base.mjs

@@ -2,6 +2,7 @@ import "core-js/modules/es.error.cause.js";
 import "core-js/modules/es.array.push.js";
 import "core-js/modules/esnext.iterator.constructor.js";
 import "core-js/modules/esnext.iterator.for-each.js";
+import "core-js/modules/esnext.iterator.map.js";
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
@@ -203,32 +204,57 @@ export class BasePlugin {
    * @returns {*}
    */
   getSetting(settingName) {
+    var _this = this;
     const defaultSettings = this.constructor.DEFAULT_SETTINGS;
+    const settingsValidators = this.constructor.SETTINGS_VALIDATORS;
     if (settingName === undefined) {
       if (isObject(_classPrivateFieldGet(_pluginSettings, this))) {
         return assignObjectDefaults(_classPrivateFieldGet(_pluginSettings, this), defaultSettings);
       }
       return _classPrivateFieldGet(_pluginSettings, this);
     }
+    let settingValue;
     if ((Array.isArray(_classPrivateFieldGet(_pluginSettings, this)) || isObject(_classPrivateFieldGet(_pluginSettings, this))) && defaultSettings[defaultMainSettingSymbol] === settingName) {
-      var _classPrivateFieldGet2;
       if (Array.isArray(_classPrivateFieldGet(_pluginSettings, this))) {
-        return _classPrivateFieldGet(_pluginSettings, this);
+        settingValue = _classPrivateFieldGet(_pluginSettings, this);
+      } else {
+        var _classPrivateFieldGet2;
+        settingValue = (_classPrivateFieldGet2 = _classPrivateFieldGet(_pluginSettings, this)[settingName]) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : defaultSettings[settingName];
       }
-      return (_classPrivateFieldGet2 = _classPrivateFieldGet(_pluginSettings, this)[settingName]) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : defaultSettings[settingName];
-    }
-    if (settingName.includes('.')) {
+    } else if (settingName.includes('.')) {
       const pluginValue = getProperty(_classPrivateFieldGet(_pluginSettings, this), settingName);
       const defaultValue = getProperty(defaultSettings, settingName);
       if (isObject(pluginValue)) {
-        return assignObjectDefaults(pluginValue, defaultValue);
+        settingValue = assignObjectDefaults(pluginValue, defaultValue);
+      } else {
+        settingValue = pluginValue !== undefined ? pluginValue : defaultValue;
       }
-      return pluginValue !== undefined ? pluginValue : defaultValue;
+    } else if (isObject(_classPrivateFieldGet(_pluginSettings, this))) {
+      settingValue = assignObjectDefaults(_classPrivateFieldGet(_pluginSettings, this), defaultSettings)[settingName];
+    } else {
+      settingValue = defaultSettings[settingName];
     }
-    if (isObject(_classPrivateFieldGet(_pluginSettings, this))) {
-      return assignObjectDefaults(_classPrivateFieldGet(_pluginSettings, this), defaultSettings)[settingName];
+    if (typeof settingValue === 'function' && settingsValidators && typeof settingsValidators === 'object') {
+      const validator = settingsValidators[settingName];
+      if (validator && typeof validator === 'function') {
+        return function () {
+          for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+            args[_key] = arguments[_key];
+          }
+          const result = settingValue(...args);
+          const isValid = validator(result);
+          if (isValid === false) {
+            const formattedArgs = args.map(arg => typeof arg === 'string' ? `"${arg}"` : '').join(', ');
+            const source = args.length > 0 ? formattedArgs : '';
+            warn(`${_this.pluginName} Plugin: "${settingName}" function (${source}) result \
+               is not valid and will be ignored.`);
+            return;
+          }
+          return result;
+        };
+      }
     }
-    return defaultSettings[settingName];
+    return settingValue;
   }
 
   /**

package/plugins/columnSummary/endpoints.js

@@ -230,6 +230,10 @@ class Endpoints {
    */
   resetSetupAfterStructureAlteration(action, index, number, logicRows, source) {
     let forceRefresh = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : true;
+    // Automatic row/column creation (`minSpareRows`/`minSpareCols`) should not trigger the endpoint recalculation.
+    if (source === 'auto') {
+      return;
+    }
     if (this.settingsType === 'function') {
       // We need to run it on a next avaiable hook, because the TrimRows' `afterCreateRow` hook triggers after this one,
       // and it needs to be run to properly calculate the endpoint value.
@@ -399,7 +403,9 @@ class Endpoints {
     (0, _array.arrayEach)(endpoints, endpoint => {
       this.resetEndpointValue(endpoint, useOffset);
     });
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 
@@ -414,7 +420,9 @@ class Endpoints {
       this.setEndpointValue(value, 'init');
     });
     this.currentEndpoint = null;
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 
@@ -440,7 +448,9 @@ class Endpoints {
     (0, _array.arrayEach)(needToRefresh, value => {
       this.refreshEndpoint(this.getEndpoint(value));
     });
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 

package/plugins/columnSummary/endpoints.mjs

@@ -227,6 +227,10 @@ class Endpoints {
    */
   resetSetupAfterStructureAlteration(action, index, number, logicRows, source) {
     let forceRefresh = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : true;
+    // Automatic row/column creation (`minSpareRows`/`minSpareCols`) should not trigger the endpoint recalculation.
+    if (source === 'auto') {
+      return;
+    }
     if (this.settingsType === 'function') {
       // We need to run it on a next avaiable hook, because the TrimRows' `afterCreateRow` hook triggers after this one,
       // and it needs to be run to properly calculate the endpoint value.
@@ -396,7 +400,9 @@ class Endpoints {
     arrayEach(endpoints, endpoint => {
       this.resetEndpointValue(endpoint, useOffset);
     });
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 
@@ -411,7 +417,9 @@ class Endpoints {
       this.setEndpointValue(value, 'init');
     });
     this.currentEndpoint = null;
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 
@@ -437,7 +445,9 @@ class Endpoints {
     arrayEach(needToRefresh, value => {
       this.refreshEndpoint(this.getEndpoint(value));
     });
-    this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    if (this.cellsToSetCache.length) {
+      this.hot.setDataAtCell(this.cellsToSetCache, 'ColumnSummary.reset');
+    }
     this.cellsToSetCache = [];
   }
 

package/plugins/customBorders/customBorders.d.ts

@@ -7,6 +7,7 @@ export interface BorderOptions {
   width?: number;
   color?: string;
   hide?: boolean;
+  style?: 'dashed' | 'dotted' | 'solid';
 }
 export interface BorderRange {
   range: {

package/plugins/customBorders/customBorders.js

@@ -3,14 +3,18 @@
 exports.__esModule = true;
 require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.for-each.js");
 var _base = require("../base");
 var _object = require("../../helpers/object");
+var _console = require("../../helpers/console");
 var _number = require("../../helpers/number");
 var _array = require("../../helpers/array");
 var C = _interopRequireWildcard(require("../../i18n/constants"));
 var _contextMenuItem = require("./contextMenuItem");
 var _utils = require("./utils");
 var _selection = require("../../selection");
+var _mixed = require("../../helpers/mixed");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
 function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
@@ -20,6 +24,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
 const PLUGIN_KEY = exports.PLUGIN_KEY = 'customBorders';
 const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 90;
+const SUPPORTED_STYLES = ['dashed', 'dotted', 'solid'];
 
 /* eslint-disable jsdoc/require-description-complete-sentence */
 
@@ -65,10 +70,12 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 90;
  *     start: {
  *       width: 2,
  *       color: 'red',
+ *       style: 'dotted'
  *     },
  *     end: {
  *       width: 1,
  *       color: 'green',
+ *       style: 'dashed'
  *     },
  *     top: '',
  *     bottom: '',
@@ -81,9 +88,10 @@ class CustomBorders extends _base.BasePlugin {
   constructor() {
     super(...arguments);
     /**
-     * Add border options to context menu.
+     * Validate the style settings. If the style value is not supported, the property is removed from the configuration.
      *
-     * @param {object} defaultOptions Context menu items.
+     * @private
+     * @param {object[]} customBorders The user defined custom border objects array.
      */
     _classPrivateMethodInitSpec(this, _CustomBorders_brand);
     /**
@@ -700,6 +708,7 @@ class CustomBorders extends _base.BasePlugin {
     if (this.hot.isRtl() && hasLeftOrRight) {
       throw new Error('The "left"/"right" properties are not supported for RTL. Please use option "start"/"end".');
     }
+    _assertClassBrand(_CustomBorders_brand, this, _validateStyleSettings).call(this, customBorders);
   }
   /**
    * Destroys the plugin instance.
@@ -709,6 +718,27 @@ class CustomBorders extends _base.BasePlugin {
   }
 }
 exports.CustomBorders = CustomBorders;
+function _validateStyleSettings(customBorders) {
+  customBorders.forEach(customBorder => {
+    Object.keys(customBorder).forEach(key => {
+      const style = customBorder[key].style;
+      if ((0, _mixed.isDefined)(style) && !SUPPORTED_STYLES.includes(style)) {
+        // eslint-disable-next-line max-len
+        (0, _console.warn)(`The "${style}" border style is not supported. Please use one of the following styles: ${SUPPORTED_STYLES.join(', ')}.
+The border style will be ignored.`);
+        delete customBorder[key].style;
+      } else if ((0, _mixed.isDefined)(style) && style === 'solid') {
+        // 'solid' is the default style
+        delete customBorder[key].style;
+      }
+    });
+  });
+}
+/**
+ * Add border options to context menu.
+ *
+ * @param {object} defaultOptions Context menu items.
+ */
 function _onAfterContextMenuDefaultOptions(defaultOptions) {
   if (!this.hot.getSettings()[PLUGIN_KEY]) {
     return;

package/plugins/customBorders/customBorders.mjs

@@ -1,5 +1,7 @@
 import "core-js/modules/es.error.cause.js";
 import "core-js/modules/es.array.push.js";
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.for-each.js";
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
 function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
@@ -8,14 +10,17 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
 import { BasePlugin } from "../base/index.mjs";
 import { hasOwnProperty, deepClone } from "../../helpers/object.mjs";
+import { warn } from "../../helpers/console.mjs";
 import { rangeEach } from "../../helpers/number.mjs";
 import { arrayEach, arrayReduce, arrayMap } from "../../helpers/array.mjs";
 import * as C from "../../i18n/constants.mjs";
 import { top as menuItemTop, bottom as menuItemBottom, left as menuItemLeft, right as menuItemRight, noBorders as menuItemNoBorders } from "./contextMenuItem/index.mjs";
 import { createId, createDefaultCustomBorder, createSingleEmptyBorder, createEmptyBorders, extendDefaultBorder, hasLeftRightTypeOptions, hasStartEndTypeOptions, toInlinePropName, normalizeBorder, denormalizeBorder } from "./utils.mjs";
 import { detectSelectionType, normalizeSelectionFactory } from "../../selection/index.mjs";
+import { isDefined } from "../../helpers/mixed.mjs";
 export const PLUGIN_KEY = 'customBorders';
 export const PLUGIN_PRIORITY = 90;
+const SUPPORTED_STYLES = ['dashed', 'dotted', 'solid'];
 
 /* eslint-disable jsdoc/require-description-complete-sentence */
 
@@ -61,10 +66,12 @@ export const PLUGIN_PRIORITY = 90;
  *     start: {
  *       width: 2,
  *       color: 'red',
+ *       style: 'dotted'
  *     },
  *     end: {
  *       width: 1,
  *       color: 'green',
+ *       style: 'dashed'
  *     },
  *     top: '',
  *     bottom: '',
@@ -77,9 +84,10 @@ export class CustomBorders extends BasePlugin {
   constructor() {
     super(...arguments);
     /**
-     * Add border options to context menu.
+     * Validate the style settings. If the style value is not supported, the property is removed from the configuration.
      *
-     * @param {object} defaultOptions Context menu items.
+     * @private
+     * @param {object[]} customBorders The user defined custom border objects array.
      */
     _classPrivateMethodInitSpec(this, _CustomBorders_brand);
     /**
@@ -696,6 +704,7 @@ export class CustomBorders extends BasePlugin {
     if (this.hot.isRtl() && hasLeftOrRight) {
       throw new Error('The "left"/"right" properties are not supported for RTL. Please use option "start"/"end".');
     }
+    _assertClassBrand(_CustomBorders_brand, this, _validateStyleSettings).call(this, customBorders);
   }
   /**
    * Destroys the plugin instance.
@@ -704,6 +713,27 @@ export class CustomBorders extends BasePlugin {
     super.destroy();
   }
 }
+function _validateStyleSettings(customBorders) {
+  customBorders.forEach(customBorder => {
+    Object.keys(customBorder).forEach(key => {
+      const style = customBorder[key].style;
+      if (isDefined(style) && !SUPPORTED_STYLES.includes(style)) {
+        // eslint-disable-next-line max-len
+        warn(`The "${style}" border style is not supported. Please use one of the following styles: ${SUPPORTED_STYLES.join(', ')}.
+The border style will be ignored.`);
+        delete customBorder[key].style;
+      } else if (isDefined(style) && style === 'solid') {
+        // 'solid' is the default style
+        delete customBorder[key].style;
+      }
+    });
+  });
+}
+/**
+ * Add border options to context menu.
+ *
+ * @param {object} defaultOptions Context menu items.
+ */
 function _onAfterContextMenuDefaultOptions(defaultOptions) {
   if (!this.hot.getSettings()[PLUGIN_KEY]) {
     return;

package/plugins/dialog/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+
+exports.__esModule = true;
+/**
+ * The main class name for the dialog-related modal elements.
+ */
+const DIALOG_CLASS_NAME = exports.DIALOG_CLASS_NAME = 'ht-dialog';

package/plugins/dialog/constants.mjs

@@ -0,0 +1,4 @@
+/**
+ * The main class name for the dialog-related modal elements.
+ */
+export const DIALOG_CLASS_NAME = 'ht-dialog';

package/plugins/dialog/dialog.d.ts

@@ -2,22 +2,42 @@ import Core from '../../core';
 import { BasePlugin } from '../base';
 
 export interface DialogConfig {
+  template?: {
+    type: 'confirm';
+    title: string;
+    description?: string;
+    buttons?: {
+      text: string;
+      type: 'primary' | 'secondary';
+      callback?: (event: MouseEvent) => void;
+    }[];
+  };
   content?: string | HTMLElement;
   customClassName?: string;
   background?: 'solid' | 'semi-transparent';
   contentBackground?: boolean;
   animation?: boolean;
   closable?: boolean;
+  a11y?: {
+    role?: 'dialog' | 'alertdialog';
+    ariaLabel?: string;
+    ariaLabelledby?: string;
+    ariaDescribedby?: string;
+  };
 }
 
 export type Settings = boolean | DialogConfig;
 
-export class Dialog extends BasePlugin {
+type TemplateOptions = string | { title: string, description?: string };
 
+export class Dialog extends BasePlugin {
   constructor(hotInstance: Core);
+
   isVisible(): boolean;
   show(config?: DialogConfig): void;
   hide(): void;
   update(config: DialogConfig): void;
+  showAlert(message?: TemplateOptions, callback?: (event: MouseEvent) => void): void;
+  showConfirm(message?: TemplateOptions, onOk?: (event: MouseEvent) => void, onCancel?: (event: MouseEvent) => void): void;
   focus(): void;
-} 
+}