handsontable 14.2.0 → 14.3.0-next-3fa6b18-20240410

package/plugins/filters/filters.js

@@ -1,9 +1,9 @@
 "use strict";
 
 exports.__esModule = true;
-require("core-js/modules/es.array.unscopables.flat.js");
-require("core-js/modules/es.array.push.js");
 require("core-js/modules/es.error.cause.js");
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.array.unscopables.flat.js");
 var _base = require("../base");
 var _array = require("../../helpers/array");
 var _templateLiteralTag = require("../../helpers/templateLiteralTag");
@@ -26,19 +26,16 @@ var _constants2 = require("./constants");
 var _translations = require("../../translations");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
-function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
-function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
-function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+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 = 'filters';
 const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 250;
 const SHORTCUTS_GROUP = PLUGIN_KEY;
@@ -50,7 +47,7 @@ const SHORTCUTS_GROUP = PLUGIN_KEY;
  * @description
  * The plugin allows filtering the table data either by the built-in component or with the API.
  *
- * See [the filtering demo](@/guides/columns/column-filter.md) for examples.
+ * See [the filtering demo](@/guides/columns/column-filter/column-filter.md) for examples.
  *
  * @example
  * ::: only-for javascript
@@ -79,15 +76,7 @@ const SHORTCUTS_GROUP = PLUGIN_KEY;
  * :::
  */
 var _menuFocusNavigator = /*#__PURE__*/new WeakMap();
-var _onAfterChange = /*#__PURE__*/new WeakSet();
-var _onAfterDropdownMenuShow = /*#__PURE__*/new WeakSet();
-var _onAfterDropdownMenuHide = /*#__PURE__*/new WeakSet();
-var _onAfterDropdownMenuDefaultOptions = /*#__PURE__*/new WeakSet();
-var _onActionBarSubmit = /*#__PURE__*/new WeakSet();
-var _onComponentChange = /*#__PURE__*/new WeakSet();
-var _onSelectUIClosed = /*#__PURE__*/new WeakSet();
-var _onAfterGetColHeader = /*#__PURE__*/new WeakSet();
-var _updateComponents = /*#__PURE__*/new WeakSet();
+var _Filters_brand = /*#__PURE__*/new WeakSet();
 class Filters extends _base.BasePlugin {
   static get PLUGIN_KEY() {
     return PLUGIN_KEY;
@@ -109,59 +98,12 @@ class Filters extends _base.BasePlugin {
   constructor(hotInstance) {
     super(hotInstance);
     // One listener for the enable/disable functionality
-    /**
-     * It updates the components state. The state is triggered by ConditionUpdateObserver, which
-     * reacts to any condition added to the condition collection. It may be added through the UI
-     * components or by API call.
-     *
-     * @param {object} conditionsState An object with the state generated by UI components.
-     */
-    _classPrivateMethodInitSpec(this, _updateComponents);
-    /**
-     * On after get column header listener.
-     *
-     * @param {number} col Visual column index.
-     * @param {HTMLTableCellElement} TH Header's TH element.
-     */
-    _classPrivateMethodInitSpec(this, _onAfterGetColHeader);
-    /**
-     * On component SelectUI closed listener.
-     */
-    _classPrivateMethodInitSpec(this, _onSelectUIClosed);
-    /**
-     * On component change listener.
-     *
-     * @param {BaseComponent} component Component inheriting BaseComponent.
-     * @param {object} command Menu item object (command).
-     */
-    _classPrivateMethodInitSpec(this, _onComponentChange);
-    /**
-     * On action bar submit listener.
-     *
-     * @private
-     * @param {string} submitType The submit type.
-     */
-    _classPrivateMethodInitSpec(this, _onActionBarSubmit);
-    /**
-     * After dropdown menu default options listener.
-     *
-     * @param {object} defaultOptions ContextMenu default item options.
-     */
-    _classPrivateMethodInitSpec(this, _onAfterDropdownMenuDefaultOptions);
-    /**
-     * After dropdown menu hide listener.
-     */
-    _classPrivateMethodInitSpec(this, _onAfterDropdownMenuHide);
-    /**
-     * After dropdown menu show listener.
-     */
-    _classPrivateMethodInitSpec(this, _onAfterDropdownMenuShow);
     /**
      * `afterChange` listener.
      *
      * @param {Array} changes Array of changes.
      */
-    _classPrivateMethodInitSpec(this, _onAfterChange);
+    _classPrivateMethodInitSpec(this, _Filters_brand);
     _defineProperty(this, "dropdownMenuPlugin", null);
     /**
      * Instance of {@link ConditionCollection}.
@@ -196,11 +138,8 @@ class Filters extends _base.BasePlugin {
      *
      * @type {MenuFocusNavigator|undefined}
      */
-    _classPrivateFieldInitSpec(this, _menuFocusNavigator, {
-      writable: true,
-      value: void 0
-    });
-    this.hot.addHook('afterGetColHeader', (col, TH) => _classPrivateMethodGet(this, _onAfterGetColHeader, _onAfterGetColHeader2).call(this, col, TH));
+    _classPrivateFieldInitSpec(this, _menuFocusNavigator, void 0);
+    this.hot.addHook('afterGetColHeader', (col, TH) => _assertClassBrand(_Filters_brand, this, _onAfterGetColHeader).call(this, col, TH));
   }
 
   /**
@@ -226,9 +165,9 @@ class Filters extends _base.BasePlugin {
     const dropdownSettings = this.hot.getSettings().dropdownMenu;
     const menuContainer = dropdownSettings && dropdownSettings.uiContainer || this.hot.rootDocument.body;
     const addConfirmationHooks = component => {
-      component.addLocalHook('accept', () => _classPrivateMethodGet(this, _onActionBarSubmit, _onActionBarSubmit2).call(this, 'accept'));
-      component.addLocalHook('cancel', () => _classPrivateMethodGet(this, _onActionBarSubmit, _onActionBarSubmit2).call(this, 'cancel'));
-      component.addLocalHook('change', command => _classPrivateMethodGet(this, _onComponentChange, _onComponentChange2).call(this, component, command));
+      component.addLocalHook('accept', () => _assertClassBrand(_Filters_brand, this, _onActionBarSubmit).call(this, 'accept'));
+      component.addLocalHook('cancel', () => _assertClassBrand(_Filters_brand, this, _onActionBarSubmit).call(this, 'cancel'));
+      component.addLocalHook('change', command => _assertClassBrand(_Filters_brand, this, _onComponentChange).call(this, component, command));
       return component;
     };
     const filterByConditionLabel = () => `${this.hot.getTranslatedPhrase(constants.FILTERS_DIVS_FILTER_BY_CONDITION)}:`;
@@ -240,7 +179,7 @@ class Filters extends _base.BasePlugin {
         addSeparator: false,
         menuContainer
       });
-      conditionComponent.addLocalHook('afterClose', () => _classPrivateMethodGet(this, _onSelectUIClosed, _onSelectUIClosed2).call(this));
+      conditionComponent.addLocalHook('afterClose', () => _assertClassBrand(_Filters_brand, this, _onSelectUIClosed).call(this));
       this.components.set('filter_by_condition', addConfirmationHooks(conditionComponent));
     }
     if (!this.components.get('filter_operators')) {
@@ -256,7 +195,7 @@ class Filters extends _base.BasePlugin {
         addSeparator: true,
         menuContainer
       });
-      conditionComponent.addLocalHook('afterClose', () => _classPrivateMethodGet(this, _onSelectUIClosed, _onSelectUIClosed2).call(this));
+      conditionComponent.addLocalHook('afterClose', () => _assertClassBrand(_Filters_brand, this, _onSelectUIClosed).call(this));
       this.components.set('filter_by_condition2', addConfirmationHooks(conditionComponent));
     }
     if (!this.components.get('filter_by_value')) {
@@ -276,20 +215,20 @@ class Filters extends _base.BasePlugin {
     }
     if (!this.conditionUpdateObserver) {
       this.conditionUpdateObserver = new _conditionUpdateObserver.default(this.hot, this.conditionCollection, physicalColumn => this.getDataMapAtColumn(physicalColumn));
-      this.conditionUpdateObserver.addLocalHook('update', conditionState => _classPrivateMethodGet(this, _updateComponents, _updateComponents2).call(this, conditionState));
+      this.conditionUpdateObserver.addLocalHook('update', conditionState => _assertClassBrand(_Filters_brand, this, _updateComponents).call(this, conditionState));
     }
     this.components.forEach(component => component.show());
-    this.addHook('afterDropdownMenuDefaultOptions', defaultOptions => _classPrivateMethodGet(this, _onAfterDropdownMenuDefaultOptions, _onAfterDropdownMenuDefaultOptions2).call(this, defaultOptions));
-    this.addHook('afterDropdownMenuShow', () => _classPrivateMethodGet(this, _onAfterDropdownMenuShow, _onAfterDropdownMenuShow2).call(this));
-    this.addHook('afterDropdownMenuHide', () => _classPrivateMethodGet(this, _onAfterDropdownMenuHide, _onAfterDropdownMenuHide2).call(this));
-    this.addHook('afterChange', changes => _classPrivateMethodGet(this, _onAfterChange, _onAfterChange2).call(this, changes));
+    this.addHook('afterDropdownMenuDefaultOptions', defaultOptions => _assertClassBrand(_Filters_brand, this, _onAfterDropdownMenuDefaultOptions).call(this, defaultOptions));
+    this.addHook('afterDropdownMenuShow', () => _assertClassBrand(_Filters_brand, this, _onAfterDropdownMenuShow).call(this));
+    this.addHook('afterDropdownMenuHide', () => _assertClassBrand(_Filters_brand, this, _onAfterDropdownMenuHide).call(this));
+    this.addHook('afterChange', changes => _assertClassBrand(_Filters_brand, this, _onAfterChange).call(this, changes));
 
     // Temp. solution (extending menu items bug in contextMenu/dropdownMenu)
     if (this.hot.getSettings().dropdownMenu && this.dropdownMenuPlugin) {
       this.dropdownMenuPlugin.disablePlugin();
       this.dropdownMenuPlugin.enablePlugin();
     }
-    if (!_classPrivateFieldGet(this, _menuFocusNavigator) && this.dropdownMenuPlugin.enabled) {
+    if (!_classPrivateFieldGet(_menuFocusNavigator, this) && this.dropdownMenuPlugin.enabled) {
       const mainMenu = this.dropdownMenuPlugin.menu;
       const focusableItems = [
       // A fake menu item that once focused allows escaping from the focus navigation (using Tab keys)
@@ -297,7 +236,7 @@ class Filters extends _base.BasePlugin {
       {
         focus: () => {
           const menuNavigator = mainMenu.getNavigator();
-          const lastSelectedMenuItem = _classPrivateFieldGet(this, _menuFocusNavigator).getLastMenuPage();
+          const lastSelectedMenuItem = _classPrivateFieldGet(_menuFocusNavigator, this).getLastMenuPage();
           mainMenu.focus();
           if (lastSelectedMenuItem > 0) {
             menuNavigator.setCurrentPage(lastSelectedMenuItem);
@@ -309,15 +248,15 @@ class Filters extends _base.BasePlugin {
         let [, component] = _ref;
         return component.getElements();
       }).flat()];
-      _classPrivateFieldSet(this, _menuFocusNavigator, (0, _focusController.createMenuFocusController)(mainMenu, focusableItems));
+      _classPrivateFieldSet(_menuFocusNavigator, this, (0, _focusController.createMenuFocusController)(mainMenu, focusableItems));
       const forwardToFocusNavigation = event => {
-        _classPrivateFieldGet(this, _menuFocusNavigator).listen();
+        _classPrivateFieldGet(_menuFocusNavigator, this).listen();
         event.preventDefault();
         if ((0, _unicode.isKey)(event.keyCode, 'TAB')) {
           if (event.shiftKey) {
-            _classPrivateFieldGet(this, _menuFocusNavigator).toPreviousItem();
+            _classPrivateFieldGet(_menuFocusNavigator, this).toPreviousItem();
           } else {
-            _classPrivateFieldGet(this, _menuFocusNavigator).toNextItem();
+            _classPrivateFieldGet(_menuFocusNavigator, this).toNextItem();
           }
         }
       };
@@ -662,6 +601,11 @@ class Filters extends _base.BasePlugin {
     });
     this.updateDependentComponentsVisibility();
   }
+
+  /**
+   * After dropdown menu show listener.
+   */
+
   /**
    * Get an operation, based on the number and types of arguments (where arguments are states of components).
    *
@@ -683,6 +627,14 @@ class Filters extends _base.BasePlugin {
     }
     return operation;
   }
+
+  /**
+   * On action bar submit listener.
+   *
+   * @private
+   * @param {string} submitType The submit type.
+   */
+
   /**
    * Listen to the keyboard input on document body and forward events to instance of Handsontable
    * created by DropdownMenu plugin.
@@ -712,6 +664,14 @@ class Filters extends _base.BasePlugin {
       this.hideComponents(...componentsToShow);
     }
   }
+
+  /**
+   * On after get column header listener.
+   *
+   * @param {number} col Visual column index.
+   * @param {HTMLTableCellElement} TH Header's TH element.
+   */
+
   /**
    * Creates DataFilter instance based on condition collection.
    *
@@ -723,6 +683,15 @@ class Filters extends _base.BasePlugin {
     let conditionCollection = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.conditionCollection;
     return new _dataFilter.default(conditionCollection, physicalColumn => this.getDataMapAtColumn(physicalColumn));
   }
+
+  /**
+   * It updates the components state. The state is triggered by ConditionUpdateObserver, which
+   * reacts to any condition added to the condition collection. It may be added through the UI
+   * components or by API call.
+   *
+   * @param {object} conditionsState An object with the state generated by UI components.
+   */
+
   /**
    * Returns indexes of passed components inside list of `dropdownMenu` items.
    *
@@ -821,7 +790,7 @@ class Filters extends _base.BasePlugin {
   }
 }
 exports.Filters = Filters;
-function _onAfterChange2(changes) {
+function _onAfterChange(changes) {
   if (changes) {
     (0, _array.arrayEach)(changes, change => {
       const [, prop] = change;
@@ -832,14 +801,22 @@ function _onAfterChange2(changes) {
     });
   }
 }
-function _onAfterDropdownMenuShow2() {
+function _onAfterDropdownMenuShow() {
   this.restoreComponents(Array.from(this.components.values()));
 }
-function _onAfterDropdownMenuHide2() {
+/**
+ * After dropdown menu hide listener.
+ */
+function _onAfterDropdownMenuHide() {
   this.components.get('filter_by_condition').getSelectElement().closeOptions();
   this.components.get('filter_by_condition2').getSelectElement().closeOptions();
 }
-function _onAfterDropdownMenuDefaultOptions2(defaultOptions) {
+/**
+ * After dropdown menu default options listener.
+ *
+ * @param {object} defaultOptions ContextMenu default item options.
+ */
+function _onAfterDropdownMenuDefaultOptions(defaultOptions) {
   defaultOptions.items.push({
     name: _predefinedItems.SEPARATOR
   });
@@ -847,7 +824,7 @@ function _onAfterDropdownMenuDefaultOptions2(defaultOptions) {
     defaultOptions.items.push(component.getMenuItemDescriptor());
   });
 }
-function _onActionBarSubmit2(submitType) {
+function _onActionBarSubmit(submitType) {
   var _this$dropdownMenuPlu3;
   if (submitType === 'accept') {
     const selectedColumn = this.getSelectedColumn();
@@ -885,16 +862,25 @@ function _onActionBarSubmit2(submitType) {
   }
   (_this$dropdownMenuPlu3 = this.dropdownMenuPlugin) === null || _this$dropdownMenuPlu3 === void 0 || _this$dropdownMenuPlu3.close();
 }
-function _onComponentChange2(component, command) {
+/**
+ * On component change listener.
+ *
+ * @param {BaseComponent} component Component inheriting BaseComponent.
+ * @param {object} command Menu item object (command).
+ */
+function _onComponentChange(component, command) {
   this.updateDependentComponentsVisibility();
   if (component.constructor === _condition.ConditionComponent && !command.inputsCount) {
     this.setListeningDropdownMenu();
   }
 }
-function _onSelectUIClosed2() {
+/**
+ * On component SelectUI closed listener.
+ */
+function _onSelectUIClosed() {
   this.setListeningDropdownMenu();
 }
-function _onAfterGetColHeader2(col, TH) {
+function _onAfterGetColHeader(col, TH) {
   const physicalColumn = this.hot.toPhysicalColumn(col);
   if (this.enabled && this.conditionCollection.hasConditions(physicalColumn)) {
     (0, _element.addClass)(TH, 'htFiltersActive');
@@ -902,7 +888,7 @@ function _onAfterGetColHeader2(col, TH) {
     (0, _element.removeClass)(TH, 'htFiltersActive');
   }
 }
-function _updateComponents2(conditionsState) {
+function _updateComponents(conditionsState) {
   var _this$dropdownMenuPlu4;
   if (!((_this$dropdownMenuPlu4 = this.dropdownMenuPlugin) !== null && _this$dropdownMenuPlu4 !== void 0 && _this$dropdownMenuPlu4.enabled)) {
     return;