handsontable 16.0.1 → 16.1.0-next-abd8f2e-20250904

package/plugins/pagination/strategies/autoPageSize.js

@@ -0,0 +1,96 @@
+"use strict";
+
+exports.__esModule = true;
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/es.array.push.js");
+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 + ""; }
+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); }
+/**
+ * @typedef PageInfo
+ * @property {number} startIndex The visual index of the first item in the page.
+ * @property {number} endIndex The visual index of the last item in the page.
+ * @property {number} pageSize The number of items in the page.
+ */
+
+/**
+ * The module computes how many items fit on each page so that the combined
+ * height of items never exceeds the available viewport, eliminating vertical scroll.
+ * Unlike for "FixedPageSizeStrategy" plugin, this one calculates the "pageSize" for each
+ * page every time the `calculate` method is called.
+ *
+ * @private
+ * @class AutoPageSizeStrategy
+ */
+class AutoPageSizeStrategy {
+  constructor() {
+    /**
+     * @type {PageInfo[]}
+     */
+    _defineProperty(this, "pages", []);
+  }
+  /**
+   * Calculates the state of pagination.
+   *
+   * @param {object} options Options for pagination calculation.
+   * @param {function(): number[]} options.itemsSizeProvider A function that returns an array of item sizes.
+   * @param {function(): number} options.viewportSizeProvider A function that returns the size of the viewport in pixels.
+   */
+  calculate(_ref) {
+    let {
+      itemsSizeProvider,
+      viewportSizeProvider
+    } = _ref;
+    const itemSizes = itemsSizeProvider();
+    const viewportSize = viewportSizeProvider();
+    const pages = [];
+    let startIndex = 0;
+    let totalSize = 1; // 1px border compensation for the first row
+    let pageSize = 0;
+    for (let index = 0; index < itemSizes.length; index++) {
+      const itemSize = itemSizes[index];
+      if (pageSize > 0 && totalSize + itemSize >= viewportSize) {
+        pages.push({
+          startIndex,
+          endIndex: index - 1,
+          pageSize
+        });
+        startIndex = index;
+        totalSize = 1; // 1px border compensation for the first row
+        pageSize = 0;
+      }
+      totalSize += itemSize;
+      pageSize += 1;
+    }
+    pages.push({
+      startIndex,
+      endIndex: Math.max(0, itemSizes.length - 1),
+      pageSize
+    });
+    this.pages = pages;
+  }
+
+  /**
+   * Gets the total number of pages.
+   *
+   * @returns {number} The total number of pages.
+   */
+  getTotalPages() {
+    return this.pages.length;
+  }
+
+  /**
+   * Gets the state of a specific page.
+   *
+   * @param {number} currentPage The current page number (1-based index).
+   * @returns {PageInfo | undefined}
+   */
+  getState(currentPage) {
+    currentPage -= 1;
+    if (currentPage < 0 || currentPage >= this.getTotalPages()) {
+      return;
+    }
+    return this.pages[currentPage];
+  }
+}
+exports.AutoPageSizeStrategy = AutoPageSizeStrategy;

package/plugins/pagination/strategies/autoPageSize.mjs

@@ -0,0 +1,92 @@
+import "core-js/modules/es.error.cause.js";
+import "core-js/modules/es.array.push.js";
+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 + ""; }
+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); }
+/**
+ * @typedef PageInfo
+ * @property {number} startIndex The visual index of the first item in the page.
+ * @property {number} endIndex The visual index of the last item in the page.
+ * @property {number} pageSize The number of items in the page.
+ */
+
+/**
+ * The module computes how many items fit on each page so that the combined
+ * height of items never exceeds the available viewport, eliminating vertical scroll.
+ * Unlike for "FixedPageSizeStrategy" plugin, this one calculates the "pageSize" for each
+ * page every time the `calculate` method is called.
+ *
+ * @private
+ * @class AutoPageSizeStrategy
+ */
+export class AutoPageSizeStrategy {
+  constructor() {
+    /**
+     * @type {PageInfo[]}
+     */
+    _defineProperty(this, "pages", []);
+  }
+  /**
+   * Calculates the state of pagination.
+   *
+   * @param {object} options Options for pagination calculation.
+   * @param {function(): number[]} options.itemsSizeProvider A function that returns an array of item sizes.
+   * @param {function(): number} options.viewportSizeProvider A function that returns the size of the viewport in pixels.
+   */
+  calculate(_ref) {
+    let {
+      itemsSizeProvider,
+      viewportSizeProvider
+    } = _ref;
+    const itemSizes = itemsSizeProvider();
+    const viewportSize = viewportSizeProvider();
+    const pages = [];
+    let startIndex = 0;
+    let totalSize = 1; // 1px border compensation for the first row
+    let pageSize = 0;
+    for (let index = 0; index < itemSizes.length; index++) {
+      const itemSize = itemSizes[index];
+      if (pageSize > 0 && totalSize + itemSize >= viewportSize) {
+        pages.push({
+          startIndex,
+          endIndex: index - 1,
+          pageSize
+        });
+        startIndex = index;
+        totalSize = 1; // 1px border compensation for the first row
+        pageSize = 0;
+      }
+      totalSize += itemSize;
+      pageSize += 1;
+    }
+    pages.push({
+      startIndex,
+      endIndex: Math.max(0, itemSizes.length - 1),
+      pageSize
+    });
+    this.pages = pages;
+  }
+
+  /**
+   * Gets the total number of pages.
+   *
+   * @returns {number} The total number of pages.
+   */
+  getTotalPages() {
+    return this.pages.length;
+  }
+
+  /**
+   * Gets the state of a specific page.
+   *
+   * @param {number} currentPage The current page number (1-based index).
+   * @returns {PageInfo | undefined}
+   */
+  getState(currentPage) {
+    currentPage -= 1;
+    if (currentPage < 0 || currentPage >= this.getTotalPages()) {
+      return;
+    }
+    return this.pages[currentPage];
+  }
+}

package/plugins/pagination/strategies/fixedPageSize.js

@@ -0,0 +1,88 @@
+"use strict";
+
+exports.__esModule = true;
+require("core-js/modules/es.error.cause.js");
+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 + ""; }
+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); }
+/**
+ * @typedef PageInfo
+ * @property {number} startIndex The visual index of the first item in the page.
+ * @property {number} endIndex The visual index of the last item in the page.
+ * @property {number} pageSize The number of items in the page.
+ */
+
+/**
+ * The module computes the state of pagination based on a fixed page size.
+ *
+ * @class FixedPageSizeStrategy
+ * @private
+ */
+class FixedPageSizeStrategy {
+  constructor() {
+    /**
+     * The fixed page size.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "pageSize", 1);
+    /**
+     * Total number of items in the dataset.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "totalItems", 0);
+    /**
+     * Total number of pages.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "totalPages", 0);
+  }
+  /**
+   * Calculates the state of pagination.
+   *
+   * @param {object} options Options for pagination calculation.
+   * @param {number} options.pageSize The fixed number of items per page.
+   * @param {number} options.totalItems The total number of items in the dataset.
+   */
+  calculate(_ref) {
+    let {
+      pageSize,
+      totalItems
+    } = _ref;
+    this.pageSize = Math.max(pageSize, 1);
+    this.totalItems = totalItems;
+    this.totalPages = Math.max(1, Math.ceil(this.totalItems / this.pageSize));
+  }
+
+  /**
+   * Gets the total number of pages.
+   *
+   * @returns {number} The total number of pages.
+   */
+  getTotalPages() {
+    return this.totalPages;
+  }
+
+  /**
+   * Gets the state of a specific page.
+   *
+   * @param {number} currentPage The current page number (1-based index).
+   * @returns {PageInfo | undefined}
+   */
+  getState(currentPage) {
+    currentPage -= 1;
+    if (currentPage < 0 || currentPage >= this.getTotalPages()) {
+      return;
+    }
+    const startIndex = currentPage * this.pageSize;
+    const endIndex = Math.max(0, Math.min(startIndex + this.pageSize - 1, this.totalItems - 1));
+    return {
+      startIndex,
+      endIndex,
+      pageSize: this.pageSize
+    };
+  }
+}
+exports.FixedPageSizeStrategy = FixedPageSizeStrategy;

package/plugins/pagination/strategies/fixedPageSize.mjs

@@ -0,0 +1,84 @@
+import "core-js/modules/es.error.cause.js";
+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 + ""; }
+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); }
+/**
+ * @typedef PageInfo
+ * @property {number} startIndex The visual index of the first item in the page.
+ * @property {number} endIndex The visual index of the last item in the page.
+ * @property {number} pageSize The number of items in the page.
+ */
+
+/**
+ * The module computes the state of pagination based on a fixed page size.
+ *
+ * @class FixedPageSizeStrategy
+ * @private
+ */
+export class FixedPageSizeStrategy {
+  constructor() {
+    /**
+     * The fixed page size.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "pageSize", 1);
+    /**
+     * Total number of items in the dataset.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "totalItems", 0);
+    /**
+     * Total number of pages.
+     *
+     * @type {number}
+     */
+    _defineProperty(this, "totalPages", 0);
+  }
+  /**
+   * Calculates the state of pagination.
+   *
+   * @param {object} options Options for pagination calculation.
+   * @param {number} options.pageSize The fixed number of items per page.
+   * @param {number} options.totalItems The total number of items in the dataset.
+   */
+  calculate(_ref) {
+    let {
+      pageSize,
+      totalItems
+    } = _ref;
+    this.pageSize = Math.max(pageSize, 1);
+    this.totalItems = totalItems;
+    this.totalPages = Math.max(1, Math.ceil(this.totalItems / this.pageSize));
+  }
+
+  /**
+   * Gets the total number of pages.
+   *
+   * @returns {number} The total number of pages.
+   */
+  getTotalPages() {
+    return this.totalPages;
+  }
+
+  /**
+   * Gets the state of a specific page.
+   *
+   * @param {number} currentPage The current page number (1-based index).
+   * @returns {PageInfo | undefined}
+   */
+  getState(currentPage) {
+    currentPage -= 1;
+    if (currentPage < 0 || currentPage >= this.getTotalPages()) {
+      return;
+    }
+    const startIndex = currentPage * this.pageSize;
+    const endIndex = Math.max(0, Math.min(startIndex + this.pageSize - 1, this.totalItems - 1));
+    return {
+      startIndex,
+      endIndex,
+      pageSize: this.pageSize
+    };
+  }
+}

package/plugins/pagination/strategies/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+exports.__esModule = true;
+exports.createPaginatorStrategy = createPaginatorStrategy;
+require("core-js/modules/es.error.cause.js");
+var _fixedPageSize = require("./fixedPageSize");
+var _autoPageSize = require("./autoPageSize");
+const strategies = new Map([['fixed', _fixedPageSize.FixedPageSizeStrategy], ['auto', _autoPageSize.AutoPageSizeStrategy]]);
+
+/**
+ * Create a pagination calculation strategy based on the provided type.
+ *
+ * @param {string} strategyType The type of pagination strategy to create.
+ * @returns {FixedPageSizeStrategy | AutoPageSizeStrategy}
+ */
+function createPaginatorStrategy(strategyType) {
+  if (!strategies.has(strategyType)) {
+    throw new Error(`Unknown pagination strategy type: ${strategyType}`);
+  }
+  const Strategy = strategies.get(strategyType);
+  return new Strategy();
+}

package/plugins/pagination/strategies/index.mjs

@@ -0,0 +1,18 @@
+import "core-js/modules/es.error.cause.js";
+import { FixedPageSizeStrategy } from "./fixedPageSize.mjs";
+import { AutoPageSizeStrategy } from "./autoPageSize.mjs";
+const strategies = new Map([['fixed', FixedPageSizeStrategy], ['auto', AutoPageSizeStrategy]]);
+
+/**
+ * Create a pagination calculation strategy based on the provided type.
+ *
+ * @param {string} strategyType The type of pagination strategy to create.
+ * @returns {FixedPageSizeStrategy | AutoPageSizeStrategy}
+ */
+export function createPaginatorStrategy(strategyType) {
+  if (!strategies.has(strategyType)) {
+    throw new Error(`Unknown pagination strategy type: ${strategyType}`);
+  }
+  const Strategy = strategies.get(strategyType);
+  return new Strategy();
+}