handsontable 0.0.0-next-d3b83d5-20240514 → 0.0.0-next-f0b9f34-20240515

package/helpers/mixed.js

@@ -134,7 +134,7 @@ const domMessages = {
 function _injectProductInfo(key, element) {
   const hasValidType = !isEmpty(key);
   const isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  const hotVersion = "0.0.0-next-d3b83d5-20240514";
+  const hotVersion = "0.0.0-next-f0b9f34-20240515";
   let keyValidityDate;
   let consoleMessageState = 'invalid';
   let domMessageState = 'invalid';

package/helpers/mixed.mjs

@@ -124,7 +124,7 @@ const domMessages = {
 export function _injectProductInfo(key, element) {
   const hasValidType = !isEmpty(key);
   const isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  const hotVersion = "0.0.0-next-d3b83d5-20240514";
+  const hotVersion = "0.0.0-next-f0b9f34-20240515";
   let keyValidityDate;
   let consoleMessageState = 'invalid';
   let domMessageState = 'invalid';

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/handsontable/handsontable/issues"
   },
   "author": "Handsoncode <hello@handsontable.com>",
-  "version": "0.0.0-next-d3b83d5-20240514",
+  "version": "0.0.0-next-f0b9f34-20240515",
   "main": "index",
   "module": "index.mjs",
   "jsnext:main": "index.mjs",

package/pluginHooks.d.ts

@@ -261,7 +261,7 @@ export interface Events {
 }
 
 export class Hooks {
-  add<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>, context?: Core): Hooks;
+  add<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>, context?: Core, orderIndex?: number): Hooks;
   createEmptyBucket(): Bucket;
   deregister(key: string): void;
   destroy(context?: Core): void;

package/pluginHooks.js

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.array.unscopables.flat-map.js");
 var _array = require("./helpers/array");
 var _object = require("./helpers/object");
 var _string = require("./helpers/string");
@@ -2665,6 +2666,7 @@ const REMOVED_HOOKS = new Map([['modifyRow', '8.0.0'], ['modifyCol', '8.0.0'], [
  */
 /* eslint-enable jsdoc/require-description-complete-sentence */
 const DEPRECATED_HOOKS = new Map([[]]);
+const callbackOrder = new WeakMap();
 class Hooks {
   static getSingleton() {
     return getGlobalSingleton();
@@ -2704,7 +2706,10 @@ class Hooks {
     const bucket = Object.create(null);
 
     // eslint-disable-next-line no-return-assign
-    (0, _array.arrayEach)(REGISTERED_HOOKS, hook => bucket[hook] = []);
+    (0, _array.arrayEach)(REGISTERED_HOOKS, hook => {
+      bucket[hook] = [];
+      this.initOrderMap(bucket, hook);
+    });
     return bucket;
   }
 
@@ -2736,6 +2741,10 @@ class Hooks {
    * @param {string} key Hook name.
    * @param {Function|Array} callback Callback function or an array of functions.
    * @param {object} [context=null] The context for the hook callback to be added - a Handsontable instance or leave empty.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    * @returns {Hooks} Instance of Hooks.
    *
    * @example
@@ -2755,6 +2764,7 @@ class Hooks {
    */
   add(key, callback) {
     let context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+    let orderIndex = arguments.length > 3 ? arguments[3] : undefined;
     if (Array.isArray(callback)) {
       (0, _array.arrayEach)(callback, c => this.add(key, c, context));
     } else {
@@ -2771,6 +2781,7 @@ class Hooks {
       if (typeof bucket[key] === 'undefined') {
         this.register(key);
         bucket[key] = [];
+        this.initOrderMap(bucket, key);
       }
       callback.skip = false;
       if (bucket[key].indexOf(callback) === -1) {
@@ -2789,6 +2800,8 @@ class Hooks {
           bucket[key].push(callback);
         }
       }
+      this.setCallbackOrderIndex(bucket, key, callback, orderIndex);
+      this.orderBucketByOrderIndex(bucket, key);
     }
     return this;
   }
@@ -2800,6 +2813,10 @@ class Hooks {
    * @param {string} key Hook/Event name.
    * @param {Function|Array} callback Callback function.
    * @param {object} [context=null] A Handsontable instance.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    *
    * @example
    * ```js
@@ -2808,11 +2825,12 @@ class Hooks {
    */
   once(key, callback) {
     let context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+    let orderIndex = arguments.length > 3 ? arguments[3] : undefined;
     if (Array.isArray(callback)) {
       (0, _array.arrayEach)(callback, c => this.once(key, c, context));
     } else {
       callback.runOnce = true;
-      this.add(key, callback, context);
+      this.add(key, callback, context, orderIndex);
     }
   }
 
@@ -3040,6 +3058,65 @@ class Hooks {
   getRegistered() {
     return REGISTERED_HOOKS;
   }
+
+  /**
+   * Sets the order index of the callback in the bucket object.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} key Hook name.
+   * @param {Function} callback Callback function.
+   * @param {number|undefined} orderIndex Order index of the callback.
+   */
+  setCallbackOrderIndex(bucket, key, callback, orderIndex) {
+    const normalizedOrderIndex = Number.isInteger(orderIndex) ? orderIndex : 0;
+    const orderMap = this.getCallbackOrderMap(bucket, key);
+    orderMap.set(normalizedOrderIndex, [...(orderMap.get(normalizedOrderIndex) || []), callback]);
+  }
+
+  /**
+   * Reorders the callbacks in the bucket object by their order index.
+   *
+   * @private
+   * @param {objcet} bucket The bucket object.
+   * @param {string} key Hook name.
+   */
+  orderBucketByOrderIndex(bucket, key) {
+    const orderMap = this.getCallbackOrderMap(bucket, key);
+    if (orderMap === undefined || orderMap.size === 0 || orderMap.size === 1 && orderMap.has(0)) {
+      return;
+    }
+    bucket[key] = [...orderMap].sort((a, b) => a[0] - b[0]).flatMap(_ref => {
+      let [, callbacks] = _ref;
+      return callbacks;
+    });
+  }
+
+  /**
+   * Extends the bucket object with the order property.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} hook The hook name.
+   */
+  initOrderMap(bucket, hook) {
+    if (!callbackOrder.has(bucket)) {
+      callbackOrder.set(bucket, []);
+    }
+    callbackOrder.get(bucket)[hook] = new Map();
+  }
+
+  /**
+   * Returns the order map for the provided hook.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} hook The hook name.
+   * @returns {Map<number, Array<Function>>} Returns the order map for the provided hook.
+   */
+  getCallbackOrderMap(bucket, hook) {
+    return callbackOrder.get(bucket)[hook];
+  }
 }
 const globalSingleton = new Hooks();
 

package/pluginHooks.mjs

@@ -1,5 +1,6 @@
 import "core-js/modules/es.error.cause.js";
 import "core-js/modules/es.array.push.js";
+import "core-js/modules/es.array.unscopables.flat-map.js";
 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 : 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); }
@@ -2661,6 +2662,7 @@ const REMOVED_HOOKS = new Map([['modifyRow', '8.0.0'], ['modifyCol', '8.0.0'], [
  */
 /* eslint-enable jsdoc/require-description-complete-sentence */
 const DEPRECATED_HOOKS = new Map([[]]);
+const callbackOrder = new WeakMap();
 class Hooks {
   static getSingleton() {
     return getGlobalSingleton();
@@ -2700,7 +2702,10 @@ class Hooks {
     const bucket = Object.create(null);
 
     // eslint-disable-next-line no-return-assign
-    arrayEach(REGISTERED_HOOKS, hook => bucket[hook] = []);
+    arrayEach(REGISTERED_HOOKS, hook => {
+      bucket[hook] = [];
+      this.initOrderMap(bucket, hook);
+    });
     return bucket;
   }
 
@@ -2732,6 +2737,10 @@ class Hooks {
    * @param {string} key Hook name.
    * @param {Function|Array} callback Callback function or an array of functions.
    * @param {object} [context=null] The context for the hook callback to be added - a Handsontable instance or leave empty.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    * @returns {Hooks} Instance of Hooks.
    *
    * @example
@@ -2751,6 +2760,7 @@ class Hooks {
    */
   add(key, callback) {
     let context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+    let orderIndex = arguments.length > 3 ? arguments[3] : undefined;
     if (Array.isArray(callback)) {
       arrayEach(callback, c => this.add(key, c, context));
     } else {
@@ -2767,6 +2777,7 @@ class Hooks {
       if (typeof bucket[key] === 'undefined') {
         this.register(key);
         bucket[key] = [];
+        this.initOrderMap(bucket, key);
       }
       callback.skip = false;
       if (bucket[key].indexOf(callback) === -1) {
@@ -2785,6 +2796,8 @@ class Hooks {
           bucket[key].push(callback);
         }
       }
+      this.setCallbackOrderIndex(bucket, key, callback, orderIndex);
+      this.orderBucketByOrderIndex(bucket, key);
     }
     return this;
   }
@@ -2796,6 +2809,10 @@ class Hooks {
    * @param {string} key Hook/Event name.
    * @param {Function|Array} callback Callback function.
    * @param {object} [context=null] A Handsontable instance.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    *
    * @example
    * ```js
@@ -2804,11 +2821,12 @@ class Hooks {
    */
   once(key, callback) {
     let context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+    let orderIndex = arguments.length > 3 ? arguments[3] : undefined;
     if (Array.isArray(callback)) {
       arrayEach(callback, c => this.once(key, c, context));
     } else {
       callback.runOnce = true;
-      this.add(key, callback, context);
+      this.add(key, callback, context, orderIndex);
     }
   }
 
@@ -3036,6 +3054,65 @@ class Hooks {
   getRegistered() {
     return REGISTERED_HOOKS;
   }
+
+  /**
+   * Sets the order index of the callback in the bucket object.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} key Hook name.
+   * @param {Function} callback Callback function.
+   * @param {number|undefined} orderIndex Order index of the callback.
+   */
+  setCallbackOrderIndex(bucket, key, callback, orderIndex) {
+    const normalizedOrderIndex = Number.isInteger(orderIndex) ? orderIndex : 0;
+    const orderMap = this.getCallbackOrderMap(bucket, key);
+    orderMap.set(normalizedOrderIndex, [...(orderMap.get(normalizedOrderIndex) || []), callback]);
+  }
+
+  /**
+   * Reorders the callbacks in the bucket object by their order index.
+   *
+   * @private
+   * @param {objcet} bucket The bucket object.
+   * @param {string} key Hook name.
+   */
+  orderBucketByOrderIndex(bucket, key) {
+    const orderMap = this.getCallbackOrderMap(bucket, key);
+    if (orderMap === undefined || orderMap.size === 0 || orderMap.size === 1 && orderMap.has(0)) {
+      return;
+    }
+    bucket[key] = [...orderMap].sort((a, b) => a[0] - b[0]).flatMap(_ref => {
+      let [, callbacks] = _ref;
+      return callbacks;
+    });
+  }
+
+  /**
+   * Extends the bucket object with the order property.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} hook The hook name.
+   */
+  initOrderMap(bucket, hook) {
+    if (!callbackOrder.has(bucket)) {
+      callbackOrder.set(bucket, []);
+    }
+    callbackOrder.get(bucket)[hook] = new Map();
+  }
+
+  /**
+   * Returns the order map for the provided hook.
+   *
+   * @private
+   * @param {object} bucket The bucket object.
+   * @param {string} hook The hook name.
+   * @returns {Map<number, Array<Function>>} Returns the order map for the provided hook.
+   */
+  getCallbackOrderMap(bucket, hook) {
+    return callbackOrder.get(bucket)[hook];
+  }
 }
 const globalSingleton = new Hooks();
 

package/plugins/base/base.d.ts

@@ -19,7 +19,7 @@ export class BasePlugin {
   enablePlugin(): void;
   disablePlugin(): void;
   updatePlugin(): void;
-  addHook<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>): void;
+  addHook<K extends keyof Events>(key: K, callback: Events[K] | Array<Events[K]>, orderIndex?: number): void;
   removeHooks(name: keyof Events): void;
   clearHooks(): void;
   callOnPluginsReady(callback: () => void): void;

package/plugins/base/base.js

@@ -178,11 +178,15 @@ class BasePlugin {
    *
    * @param {string} name The hook name.
    * @param {Function} callback The listener function to add.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    */
-  addHook(name, callback) {
+  addHook(name, callback, orderIndex) {
     _classPrivateFieldGet(_hooks, this)[name] = _classPrivateFieldGet(_hooks, this)[name] || [];
     const hooks = _classPrivateFieldGet(_hooks, this)[name];
-    this.hot.addHook(name, callback);
+    this.hot.addHook(name, callback, orderIndex);
     hooks.push(callback);
     _classPrivateFieldGet(_hooks, this)[name] = hooks;
   }

package/plugins/base/base.mjs

@@ -174,11 +174,15 @@ export class BasePlugin {
    *
    * @param {string} name The hook name.
    * @param {Function} callback The listener function to add.
+   * @param {number} [orderIndex] Order index of the callback.
+   *                              If > 0, the callback will be added after the others, for example, with an index of 1, the callback will be added before the ones with an index of 2, 3, etc., but after the ones with an index of 0 and lower.
+   *                              If < 0, the callback will be added before the others, for example, with an index of -1, the callback will be added after the ones with an index of -2, -3, etc., but before the ones with an index of 0 and higher.
+   *                              If 0 or no order index is provided, the callback will be added between the "negative" and "positive" indexes.
    */
-  addHook(name, callback) {
+  addHook(name, callback, orderIndex) {
     _classPrivateFieldGet(_hooks, this)[name] = _classPrivateFieldGet(_hooks, this)[name] || [];
     const hooks = _classPrivateFieldGet(_hooks, this)[name];
-    this.hot.addHook(name, callback);
+    this.hot.addHook(name, callback, orderIndex);
     hooks.push(callback);
     _classPrivateFieldGet(_hooks, this)[name] = hooks;
   }

package/plugins/hiddenColumns/hiddenColumns.js

@@ -211,7 +211,7 @@ class HiddenColumns extends _base.BasePlugin {
       return _assertClassBrand(_HiddenColumns_brand, _this, _onAfterContextMenuDefaultOptions).call(_this, ...args);
     });
     this.addHook('afterGetCellMeta', (row, col, cellProperties) => _assertClassBrand(_HiddenColumns_brand, this, _onAfterGetCellMeta).call(this, row, col, cellProperties));
-    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_HiddenColumns_brand, this, _onModifyColWidth).call(this, width, col));
+    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_HiddenColumns_brand, this, _onModifyColWidth).call(this, width, col), 2);
     this.addHook('afterGetColHeader', function () {
       for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         args[_key2] = arguments[_key2];

package/plugins/hiddenColumns/hiddenColumns.mjs

@@ -207,7 +207,7 @@ export class HiddenColumns extends BasePlugin {
       return _assertClassBrand(_HiddenColumns_brand, _this, _onAfterContextMenuDefaultOptions).call(_this, ...args);
     });
     this.addHook('afterGetCellMeta', (row, col, cellProperties) => _assertClassBrand(_HiddenColumns_brand, this, _onAfterGetCellMeta).call(this, row, col, cellProperties));
-    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_HiddenColumns_brand, this, _onModifyColWidth).call(this, width, col));
+    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_HiddenColumns_brand, this, _onModifyColWidth).call(this, width, col), 2);
     this.addHook('afterGetColHeader', function () {
       for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         args[_key2] = arguments[_key2];

package/plugins/manualColumnResize/manualColumnResize.js

@@ -168,7 +168,7 @@ class ManualColumnResize extends _base.BasePlugin {
     _classPrivateFieldSet(_columnWidthsMap, this, new _translations.PhysicalIndexToValueMap());
     _classPrivateFieldGet(_columnWidthsMap, this).addLocalHook('init', () => _assertClassBrand(_ManualColumnResize_brand, this, _onMapInit).call(this));
     this.hot.columnIndexMapper.registerMap(this.pluginName, _classPrivateFieldGet(_columnWidthsMap, this));
-    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_ManualColumnResize_brand, this, _onModifyColWidth).call(this, width, col));
+    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_ManualColumnResize_brand, this, _onModifyColWidth).call(this, width, col), 1);
     this.addHook('beforeStretchingColumnWidth', (stretchedWidth, column) => _assertClassBrand(_ManualColumnResize_brand, this, _onBeforeStretchingColumnWidth).call(this, stretchedWidth, column));
     this.addHook('beforeColumnResize', (newSize, column, isDoubleClick) => _assertClassBrand(_ManualColumnResize_brand, this, _onBeforeColumnResize).call(this, newSize, column, isDoubleClick));
     this.bindEvents();

package/plugins/manualColumnResize/manualColumnResize.mjs

@@ -163,7 +163,7 @@ export class ManualColumnResize extends BasePlugin {
     _classPrivateFieldSet(_columnWidthsMap, this, new IndexToValueMap());
     _classPrivateFieldGet(_columnWidthsMap, this).addLocalHook('init', () => _assertClassBrand(_ManualColumnResize_brand, this, _onMapInit).call(this));
     this.hot.columnIndexMapper.registerMap(this.pluginName, _classPrivateFieldGet(_columnWidthsMap, this));
-    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_ManualColumnResize_brand, this, _onModifyColWidth).call(this, width, col));
+    this.addHook('modifyColWidth', (width, col) => _assertClassBrand(_ManualColumnResize_brand, this, _onModifyColWidth).call(this, width, col), 1);
     this.addHook('beforeStretchingColumnWidth', (stretchedWidth, column) => _assertClassBrand(_ManualColumnResize_brand, this, _onBeforeStretchingColumnWidth).call(this, stretchedWidth, column));
     this.addHook('beforeColumnResize', (newSize, column, isDoubleClick) => _assertClassBrand(_ManualColumnResize_brand, this, _onBeforeColumnResize).call(this, newSize, column, isDoubleClick));
     this.bindEvents();