handsontable 17.1.0 → 18.0.0-rc2

package/plugins/columnSorting/sortFunction/intlDate.mjs

@@ -2,11 +2,11 @@ import { createIntlDateCompareFunction } from '../utils.mjs';
 /**
  * Date sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
  *
- * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {object} columnMeta Column meta object.
- * @param {object} columnPluginSettings Plugin settings for the column.
- * @returns {Function} The compare function.
- */ export function compareFunctionFactory(sortOrder, columnMeta, columnPluginSettings) {
-    return createIntlDateCompareFunction(sortOrder, columnMeta.dateFormat, columnPluginSettings);
+ * @param sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param columnMeta Column meta object.
+ * @param columnPluginSettings Plugin settings for the column.
+ * @returns The compare function.
+ */ export function compareFunctionFactory(sortOrder, _columnMeta, columnPluginSettings) {
+    return createIntlDateCompareFunction(sortOrder, columnPluginSettings);
 }
 export const COLUMN_DATA_TYPE = 'intl-date';

package/plugins/columnSorting/sortFunction/intlTime.d.mts

@@ -0,0 +1 @@
+export * from './intlTime.js';

package/plugins/columnSorting/sortFunction/intlTime.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Time sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
+ *
+ * @param sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param columnMeta Column meta object.
+ * @param columnPluginSettings Plugin settings for the column.
+ * @returns The compare function.
+ */
+export declare function compareFunctionFactory(sortOrder: string, _columnMeta: Record<string, unknown>, columnPluginSettings: Record<string, unknown>): (value: unknown, nextValue: unknown) => number;
+export declare const COLUMN_DATA_TYPE = "intl-time";

package/plugins/columnSorting/sortFunction/intlTime.js

@@ -17,7 +17,7 @@ _export(exports, {
     }
 });
 const _utils = require("../utils");
-function compareFunctionFactory(sortOrder, columnMeta, columnPluginSettings) {
-    return (0, _utils.createIntlTimeCompareFunction)(sortOrder, columnMeta.timeFormat, columnPluginSettings);
+function compareFunctionFactory(sortOrder, _columnMeta, columnPluginSettings) {
+    return (0, _utils.createIntlTimeCompareFunction)(sortOrder, columnPluginSettings);
 }
 const COLUMN_DATA_TYPE = 'intl-time';

package/plugins/columnSorting/sortFunction/intlTime.mjs

@@ -2,11 +2,11 @@ import { createIntlTimeCompareFunction } from '../utils.mjs';
 /**
  * Time sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
  *
- * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {object} columnMeta Column meta object.
- * @param {object} columnPluginSettings Plugin settings for the column.
- * @returns {Function} The compare function.
- */ export function compareFunctionFactory(sortOrder, columnMeta, columnPluginSettings) {
-    return createIntlTimeCompareFunction(sortOrder, columnMeta.timeFormat, columnPluginSettings);
+ * @param sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param columnMeta Column meta object.
+ * @param columnPluginSettings Plugin settings for the column.
+ * @returns The compare function.
+ */ export function compareFunctionFactory(sortOrder, _columnMeta, columnPluginSettings) {
+    return createIntlTimeCompareFunction(sortOrder, columnPluginSettings);
 }
 export const COLUMN_DATA_TYPE = 'intl-time';

package/plugins/columnSorting/sortFunction/numeric.d.mts

@@ -0,0 +1 @@
+export * from './numeric.js';

package/plugins/columnSorting/sortFunction/numeric.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Numeric sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
+ *
+ * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param {object} columnMeta Column meta object.
+ * @param {object} columnPluginSettings Plugin settings for the column.
+ * @returns {Function} The compare function.
+ */
+export declare function compareFunctionFactory(sortOrder: string, columnMeta: Record<string, unknown>, columnPluginSettings: Record<string, unknown>): (value: unknown, nextValue: unknown) => 0 | 1 | -1;
+export declare const COLUMN_DATA_TYPE = "numeric";

package/plugins/columnSorting/sortFunction/time.d.mts

@@ -0,0 +1 @@
+export * from './time.js';

package/plugins/columnSorting/sortFunction/time.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Date sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
+ *
+ * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param {object} _columnMeta Column meta object (unused).
+ * @param {object} columnPluginSettings Plugin settings for the column.
+ * @returns {Function} The compare function.
+ */
+export declare function compareFunctionFactory(sortOrder: string, _columnMeta: Record<string, unknown>, columnPluginSettings: Record<string, unknown>): (value: unknown, nextValue: unknown) => number;
+export declare const COLUMN_DATA_TYPE = "time";

package/plugins/columnSorting/sortFunction/time.js

@@ -17,7 +17,7 @@ _export(exports, {
     }
 });
 const _utils = require("../utils");
-function compareFunctionFactory(sortOrder, columnMeta, columnPluginSettings) {
-    return (0, _utils.createDateTimeCompareFunction)(sortOrder, columnMeta.timeFormat, columnPluginSettings);
+function compareFunctionFactory(sortOrder, _columnMeta, columnPluginSettings) {
+    return (0, _utils.createIntlTimeCompareFunction)(sortOrder, columnPluginSettings);
 }
 const COLUMN_DATA_TYPE = 'time';

package/plugins/columnSorting/sortFunction/time.mjs

@@ -1,12 +1,12 @@
-import { createDateTimeCompareFunction } from '../utils.mjs';
+import { createIntlTimeCompareFunction } from '../utils.mjs';
 /**
  * Date sorting compare function factory. Method get as parameters `sortOrder` and `columnMeta` and return compare function.
  *
  * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {object} columnMeta Column meta object.
+ * @param {object} _columnMeta Column meta object (unused).
  * @param {object} columnPluginSettings Plugin settings for the column.
  * @returns {Function} The compare function.
- */ export function compareFunctionFactory(sortOrder, columnMeta, columnPluginSettings) {
-    return createDateTimeCompareFunction(sortOrder, columnMeta.timeFormat, columnPluginSettings);
+ */ export function compareFunctionFactory(sortOrder, _columnMeta, columnPluginSettings) {
+    return createIntlTimeCompareFunction(sortOrder, columnPluginSettings);
 }
 export const COLUMN_DATA_TYPE = 'time';

package/plugins/columnSorting/sortService/engine.d.mts

@@ -0,0 +1 @@
+export * from './engine.js';

package/plugins/columnSorting/sortService/engine.d.ts

@@ -0,0 +1,11 @@
+export declare const DO_NOT_SWAP = 0;
+export declare const FIRST_BEFORE_SECOND = -1;
+export declare const FIRST_AFTER_SECOND = 1;
+/**
+ * Sorts the provided indexes with data using the comparator registered under the given id.
+ *
+ * @param {Array} indexesWithData The data to sort.
+ * @param {string} rootComparatorId The comparator logic to use.
+ * @param {Array} argsForRootComparator Additional arguments for comparator function.
+ */
+export declare function sort(indexesWithData: unknown[], rootComparatorId: string, ...argsForRootComparator: unknown[][]): void;

package/plugins/columnSorting/sortService/engine.mjs

@@ -3,6 +3,8 @@ export const DO_NOT_SWAP = 0;
 export const FIRST_BEFORE_SECOND = -1;
 export const FIRST_AFTER_SECOND = 1;
 /**
+ * Sorts the provided indexes with data using the comparator registered under the given id.
+ *
  * @param {Array} indexesWithData The data to sort.
  * @param {string} rootComparatorId The comparator logic to use.
  * @param {Array} argsForRootComparator Additional arguments for comparator function.

package/plugins/columnSorting/sortService/index.d.mts

@@ -0,0 +1 @@
+export * from './index.js';

package/plugins/columnSorting/sortService/index.d.ts

@@ -0,0 +1,2 @@
+export { registerRootComparator, getRootComparator, getCompareFunctionFactory } from './registry';
+export { FIRST_AFTER_SECOND, FIRST_BEFORE_SECOND, DO_NOT_SWAP, sort } from './engine';

package/plugins/columnSorting/sortService/index.mjs

@@ -1,3 +1,2 @@
-import { registerRootComparator, getRootComparator, getCompareFunctionFactory } from './registry.mjs';
-import { FIRST_AFTER_SECOND, FIRST_BEFORE_SECOND, DO_NOT_SWAP, sort } from './engine.mjs';
-export { registerRootComparator, getRootComparator, getCompareFunctionFactory, FIRST_AFTER_SECOND, FIRST_BEFORE_SECOND, DO_NOT_SWAP, sort };
+export { registerRootComparator, getRootComparator, getCompareFunctionFactory } from './registry.mjs';
+export { FIRST_AFTER_SECOND, FIRST_BEFORE_SECOND, DO_NOT_SWAP, sort } from './engine.mjs';

package/plugins/columnSorting/sortService/registry.d.mts

@@ -0,0 +1 @@
+export * from './registry.js';

package/plugins/columnSorting/sortService/registry.d.ts

@@ -0,0 +1,10 @@
+declare const registerRootComparator: (name: string, item: unknown) => void, getRootComparator: (name: string) => unknown;
+type CompareFunctionFactory = (sortOrder: unknown, columnMeta: unknown, columnPluginSettings: unknown) => (value: unknown, nextValue: unknown) => number;
+/**
+ * Gets sort function for the particular column basing on it's data type.
+ *
+ * @param {string} type The data type.
+ * @returns {Function}
+ */
+export declare function getCompareFunctionFactory(type: string): CompareFunctionFactory;
+export { registerRootComparator, getRootComparator };

package/plugins/columnSorting/utils.d.mts

@@ -0,0 +1 @@
+export * from './utils.js';

package/plugins/columnSorting/utils.d.ts

@@ -0,0 +1,65 @@
+export declare const ASC_SORT_STATE = "asc";
+export declare const DESC_SORT_STATE = "desc";
+export declare const HEADER_SPAN_CLASS = "colHeader";
+/**
+ * Get if all sorted columns states are valid.
+ *
+ * @param {Array} sortStates The sort state collection.
+ * @returns {boolean}
+ */
+export declare function areValidSortStates(sortStates: unknown[]): boolean;
+/**
+ * Get next sort order for particular column. The order sequence looks as follows: 'asc' -> 'desc' -> undefined -> 'asc'.
+ *
+ * @param {string|undefined} sortOrder Sort order (`asc` for ascending, `desc` for descending and undefined for not sorted).
+ * @returns {string|undefined} Next sort order (`asc` for ascending, `desc` for descending and undefined for not sorted).
+ */
+export declare function getNextSortOrder(sortOrder?: string): "asc" | "desc" | undefined;
+/**
+ * Get `span` DOM element inside `th` DOM element.
+ *
+ * @param {Element} TH Th HTML element.
+ * @returns {Element | null}
+ */
+export declare function getHeaderSpanElement(TH: HTMLTableCellElement): HTMLElement | null;
+/**
+ *
+ * Get if handled header is first level column header.
+ *
+ * @param {number} column Visual column index.
+ * @param {Element} TH Th HTML element.
+ * @returns {boolean}
+ */
+export declare function isFirstLevelColumnHeader(column: number, TH: HTMLTableCellElement): boolean;
+/**
+ *  Get if header was clicked properly. Click on column header and NOT done by right click return `true`.
+ *
+ * @param {number} row Visual row index.
+ * @param {number} column Visual column index.
+ * @param {Event} clickEvent Click event.
+ * @returns {boolean}
+ */
+export declare function wasHeaderClickedProperly(row: number, column: number, clickEvent: Event): boolean;
+/**
+ * Creates intl-date sorting compare function.
+ *
+ * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param {object} columnPluginSettings Plugin settings for the column.
+ * @returns {Function} The compare function.
+ */
+export declare function createIntlDateCompareFunction(sortOrder: string, columnPluginSettings: Record<string, unknown>): (value: unknown, nextValue: unknown) => number;
+/**
+ * Creates intl-time sorting compare function.
+ *
+ * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
+ * @param {object} columnPluginSettings Plugin settings for the column.
+ * @returns {Function} The compare function.
+ */
+export declare function createIntlTimeCompareFunction(sortOrder: string, columnPluginSettings: Record<string, unknown>): (value: unknown, nextValue: unknown) => number;
+/**
+ * Warn users about problems when using `columnSorting` and `multiColumnSorting` plugins simultaneously.
+ *
+ * @param {string} workingPlugin The plugin that will work.
+ * @param {string} disabledPlugin The plugin that will remain disabled.
+ */
+export declare function warnAboutPluginsConflict(workingPlugin: string, disabledPlugin: string): void;

package/plugins/columnSorting/utils.js

@@ -21,9 +21,6 @@ _export(exports, {
     get areValidSortStates () {
         return areValidSortStates;
     },
-    get createDateTimeCompareFunction () {
-        return createDateTimeCompareFunction;
-    },
     get createIntlDateCompareFunction () {
         return createIntlDateCompareFunction;
     },
@@ -46,7 +43,6 @@ _export(exports, {
         return wasHeaderClickedProperly;
     }
 });
-const _moment = /*#__PURE__*/ _interop_require_default(require("moment"));
 const _object = require("../../helpers/object");
 const _event = require("../../helpers/dom/event");
 const _element = require("../../helpers/dom/element");
@@ -55,11 +51,6 @@ const _dateTime = require("../../helpers/dateTime");
 const _sortService = require("./sortService");
 const _console = require("../../helpers/console");
 const _templateLiteralTag = require("../../helpers/templateLiteralTag");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
 const ASC_SORT_STATE = 'asc';
 const DESC_SORT_STATE = 'desc';
 const HEADER_SPAN_CLASS = 'colHeader';
@@ -82,7 +73,8 @@ function areValidSortStates(sortStates) {
     if (sortStates.some((columnState)=>isValidColumnState(columnState) === false)) {
         return false;
     }
-    const sortedColumns = sortStates.map(({ column })=>column);
+    const validStates = sortStates.filter(isValidColumnState);
+    const sortedColumns = validStates.map((state)=>state.column);
     // Indexes occurs only once.
     return new Set(sortedColumns).size === sortedColumns.length;
 }
@@ -111,50 +103,10 @@ function wasHeaderClickedProperly(row, column, clickEvent) {
     if (row === -1) {
         return true;
     }
-    const targetHeader = typeof clickEvent.target.closest === 'function' ? clickEvent.target.closest('th') : null;
-    return (0, _element.isBottomMostColumnHeader)(targetHeader);
-}
-function createDateTimeCompareFunction(sortOrder, format, columnPluginSettings) {
-    return function(value, nextValue) {
-        const { sortEmptyCells } = columnPluginSettings;
-        if (value === nextValue) {
-            return _sortService.DO_NOT_SWAP;
-        }
-        if ((0, _mixed.isEmpty)(value)) {
-            if ((0, _mixed.isEmpty)(nextValue)) {
-                return _sortService.DO_NOT_SWAP;
-            }
-            // Just fist value is empty and `sortEmptyCells` option was set
-            if (sortEmptyCells) {
-                return sortOrder === 'asc' ? _sortService.FIRST_BEFORE_SECOND : _sortService.FIRST_AFTER_SECOND;
-            }
-            return _sortService.FIRST_AFTER_SECOND;
-        }
-        if ((0, _mixed.isEmpty)(nextValue)) {
-            // Just second value is empty and `sortEmptyCells` option was set
-            if (sortEmptyCells) {
-                return sortOrder === 'asc' ? _sortService.FIRST_AFTER_SECOND : _sortService.FIRST_BEFORE_SECOND;
-            }
-            return _sortService.FIRST_BEFORE_SECOND;
-        }
-        const firstDate = (0, _moment.default)(value, format);
-        const nextDate = (0, _moment.default)(nextValue, format);
-        if (!firstDate.isValid()) {
-            return _sortService.FIRST_AFTER_SECOND;
-        }
-        if (!nextDate.isValid()) {
-            return _sortService.FIRST_BEFORE_SECOND;
-        }
-        if (nextDate.isAfter(firstDate)) {
-            return sortOrder === 'asc' ? _sortService.FIRST_BEFORE_SECOND : _sortService.FIRST_AFTER_SECOND;
-        }
-        if (nextDate.isBefore(firstDate)) {
-            return sortOrder === 'asc' ? _sortService.FIRST_AFTER_SECOND : _sortService.FIRST_BEFORE_SECOND;
-        }
-        return _sortService.DO_NOT_SWAP;
-    };
+    const targetHeader = typeof (0, _element.eventTargetEl)(clickEvent)?.closest === 'function' ? (0, _element.eventTargetEl)(clickEvent).closest('th') : null;
+    return targetHeader !== null && (0, _element.isBottomMostColumnHeader)(targetHeader);
 }
-function createIntlDateCompareFunction(sortOrder, format, columnPluginSettings) {
+function createIntlDateCompareFunction(sortOrder, columnPluginSettings) {
     return function(value, nextValue) {
         const { sortEmptyCells } = columnPluginSettings;
         if (value === nextValue) {
@@ -194,7 +146,7 @@ function createIntlDateCompareFunction(sortOrder, format, columnPluginSettings)
         return _sortService.DO_NOT_SWAP;
     };
 }
-function createIntlTimeCompareFunction(sortOrder, format, columnPluginSettings) {
+function createIntlTimeCompareFunction(sortOrder, columnPluginSettings) {
     return function(value, nextValue) {
         const { sortEmptyCells } = columnPluginSettings;
         if (value === nextValue) {

package/plugins/columnSorting/utils.mjs

@@ -1,7 +1,6 @@
-import moment from 'moment';
 import { isObject } from '../../helpers/object.mjs';
 import { isRightClick } from '../../helpers/dom/event.mjs';
-import { isBottomMostColumnHeader } from '../../helpers/dom/element.mjs';
+import { eventTargetEl, isBottomMostColumnHeader } from '../../helpers/dom/element.mjs';
 import { isEmpty } from '../../helpers/mixed.mjs';
 import { parseToLocalDate, parseToLocalTime } from '../../helpers/dateTime.mjs';
 import { DO_NOT_SWAP, FIRST_BEFORE_SECOND, FIRST_AFTER_SECOND } from './sortService/index.mjs';
@@ -34,7 +33,8 @@ export const HEADER_SPAN_CLASS = 'colHeader';
     if (sortStates.some((columnState)=>isValidColumnState(columnState) === false)) {
         return false;
     }
-    const sortedColumns = sortStates.map(({ column })=>column);
+    const validStates = sortStates.filter(isValidColumnState);
+    const sortedColumns = validStates.map((state)=>state.column);
     // Indexes occurs only once.
     return new Set(sortedColumns).size === sortedColumns.length;
 }
@@ -87,64 +87,16 @@ export const HEADER_SPAN_CLASS = 'colHeader';
     if (row === -1) {
         return true;
     }
-    const targetHeader = typeof clickEvent.target.closest === 'function' ? clickEvent.target.closest('th') : null;
-    return isBottomMostColumnHeader(targetHeader);
-}
-/**
- * Creates date or time sorting compare function.
- *
- * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {string} format Date or time format.
- * @param {object} columnPluginSettings Plugin settings for the column.
- * @returns {Function} The compare function.
- */ export function createDateTimeCompareFunction(sortOrder, format, columnPluginSettings) {
-    return function(value, nextValue) {
-        const { sortEmptyCells } = columnPluginSettings;
-        if (value === nextValue) {
-            return DO_NOT_SWAP;
-        }
-        if (isEmpty(value)) {
-            if (isEmpty(nextValue)) {
-                return DO_NOT_SWAP;
-            }
-            // Just fist value is empty and `sortEmptyCells` option was set
-            if (sortEmptyCells) {
-                return sortOrder === 'asc' ? FIRST_BEFORE_SECOND : FIRST_AFTER_SECOND;
-            }
-            return FIRST_AFTER_SECOND;
-        }
-        if (isEmpty(nextValue)) {
-            // Just second value is empty and `sortEmptyCells` option was set
-            if (sortEmptyCells) {
-                return sortOrder === 'asc' ? FIRST_AFTER_SECOND : FIRST_BEFORE_SECOND;
-            }
-            return FIRST_BEFORE_SECOND;
-        }
-        const firstDate = moment(value, format);
-        const nextDate = moment(nextValue, format);
-        if (!firstDate.isValid()) {
-            return FIRST_AFTER_SECOND;
-        }
-        if (!nextDate.isValid()) {
-            return FIRST_BEFORE_SECOND;
-        }
-        if (nextDate.isAfter(firstDate)) {
-            return sortOrder === 'asc' ? FIRST_BEFORE_SECOND : FIRST_AFTER_SECOND;
-        }
-        if (nextDate.isBefore(firstDate)) {
-            return sortOrder === 'asc' ? FIRST_AFTER_SECOND : FIRST_BEFORE_SECOND;
-        }
-        return DO_NOT_SWAP;
-    };
+    const targetHeader = typeof eventTargetEl(clickEvent)?.closest === 'function' ? eventTargetEl(clickEvent).closest('th') : null;
+    return targetHeader !== null && isBottomMostColumnHeader(targetHeader);
 }
 /**
  * Creates intl-date sorting compare function.
  *
  * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {string} format Date or time format.
  * @param {object} columnPluginSettings Plugin settings for the column.
  * @returns {Function} The compare function.
- */ export function createIntlDateCompareFunction(sortOrder, format, columnPluginSettings) {
+ */ export function createIntlDateCompareFunction(sortOrder, columnPluginSettings) {
     return function(value, nextValue) {
         const { sortEmptyCells } = columnPluginSettings;
         if (value === nextValue) {
@@ -188,10 +140,9 @@ export const HEADER_SPAN_CLASS = 'colHeader';
  * Creates intl-time sorting compare function.
  *
  * @param {string} sortOrder Sort order (`asc` for ascending, `desc` for descending).
- * @param {string} format Date or time format.
  * @param {object} columnPluginSettings Plugin settings for the column.
  * @returns {Function} The compare function.
- */ export function createIntlTimeCompareFunction(sortOrder, format, columnPluginSettings) {
+ */ export function createIntlTimeCompareFunction(sortOrder, columnPluginSettings) {
     return function(value, nextValue) {
         const { sortEmptyCells } = columnPluginSettings;
         if (value === nextValue) {

package/plugins/columnSummary/columnSummary.d.mts

@@ -0,0 +1 @@
+export * from './columnSummary.js';