handsontable 18.0.0 → 18.1.0-rc7

package/helpers/string.d.ts

@@ -1,3 +1,4 @@
+export { substitute } from './templateString';
 /**
  * Convert string to upper case first letter.
  *
@@ -33,26 +34,29 @@ export declare function isJSON(string: string): boolean;
  */
 export declare function isPercentValue(value: string): boolean;
 /**
- * Substitute strings placed between square brackets into value defined in `variables` object. String names defined in
- * square brackets must be the same as property name of `variables` object.
+ * Strip any HTML tag from the string.
  *
- * @param {string} template Template string.
- * @param {object} variables Object which contains all available values which can be injected into template.
+ * @param {string} string String to cut HTML from.
  * @returns {string}
  */
-export declare function substitute(template: string, variables?: Record<string, unknown>): string;
+export declare function stripTags(string: string): string;
 /**
- * Strip any HTML tag from the string.
+ * Escapes the characters that carry meaning in HTML, so the string renders as the text it is.
  *
- * @param {string} string String to cut HTML from.
+ * Prefer this over {@link stripTags} for a value interpolated into a markup string: `stripTags`
+ * drops everything between a `<` and the next `>`, so a title such as `'Loaded 5 < 10 rows'` loses
+ * half of itself, while escaping blocks the markup and keeps the text whole.
+ *
+ * @param {string} string String to escape.
  * @returns {string}
  */
-export declare function stripTags(string: string): string;
+export declare function escapeHtml(string: string): string;
 /**
  * Returns the string unchanged.
  *
- * @deprecated Default sanitization is now a pass-through. Use the sanitizer
- * configuration option to supply a custom sanitizer function.
+ * @deprecated Since 18.0.0. Handsontable no longer bundles an HTML sanitizer; this helper is a
+ * pass-through and will be removed in 19.0.0. Supply your own sanitizer through the
+ * `sanitizer` configuration option instead.
  * @param {string} string String to return.
  * @returns {string}
  */

package/helpers/string.js

@@ -12,6 +12,9 @@ _export(exports, {
     get equalsIgnoreCase () {
         return equalsIgnoreCase;
     },
+    get escapeHtml () {
+        return escapeHtml;
+    },
     get isJSON () {
         return isJSON;
     },
@@ -31,7 +34,7 @@ _export(exports, {
         return stripTags;
     },
     get substitute () {
-        return substitute;
+        return _templateString.substitute;
     },
     get toHyphen () {
         return toHyphen;
@@ -41,6 +44,8 @@ _export(exports, {
     }
 });
 const _mixed = require("./mixed");
+const _console = require("./console");
+const _templateString = require("./templateString");
 function toUpperCaseFirst(string) {
     return string[0].toUpperCase() + string.substr(1);
 }
@@ -75,14 +80,6 @@ function isJSON(string) {
 function isPercentValue(value) {
     return /^(?:\d\d?%|100%)$/.test(value);
 }
-function substitute(template, variables = {}) {
-    return `${template}`.replace(/(?:\\)?\[([^[\]]+)]/g, (match, name)=>{
-        if (match.charAt(0) === '\\') {
-            return match.substr(1, match.length - 1);
-        }
-        return variables[name] === undefined ? '' : String(variables[name]);
-    });
-}
 function stripTags(string) {
     const str = String(string);
     let result = '';
@@ -106,7 +103,18 @@ function stripTags(string) {
     }
     return result;
 }
+const HTML_ESCAPE_CHARS = {
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    '\'': '&#39;'
+};
+function escapeHtml(string) {
+    return String(string).replace(/[&<>"']/g, (char)=>HTML_ESCAPE_CHARS[char]);
+}
 function sanitize(string) {
+    (0, _console.deprecatedWarnOnce)('helper.sanitize', '`sanitize()` is deprecated and will be removed in Handsontable 19.0.0. ' + 'It returns its input unchanged. Use the `sanitizer` option to supply your own sanitizer.');
     return string;
 }
 function toHyphen(str) {

package/helpers/string.mjs

@@ -1,4 +1,8 @@
 import { stringify } from './mixed.mjs';
+import { deprecatedWarnOnce } from './console.mjs';
+// Re-exported to keep `substitute` reachable from its documented `helpers/string` path. The
+// implementation lives in a leaf module so that `helpers/console` can use it without a cycle.
+export { substitute } from './templateString.mjs';
 /**
  * Convert string to upper case first letter.
  *
@@ -57,21 +61,6 @@ import { stringify } from './mixed.mjs';
  */ export function isPercentValue(value) {
     return /^(?:\d\d?%|100%)$/.test(value);
 }
-/**
- * Substitute strings placed between square brackets into value defined in `variables` object. String names defined in
- * square brackets must be the same as property name of `variables` object.
- *
- * @param {string} template Template string.
- * @param {object} variables Object which contains all available values which can be injected into template.
- * @returns {string}
- */ export function substitute(template, variables = {}) {
-    return `${template}`.replace(/(?:\\)?\[([^[\]]+)]/g, (match, name)=>{
-        if (match.charAt(0) === '\\') {
-            return match.substr(1, match.length - 1);
-        }
-        return variables[name] === undefined ? '' : String(variables[name]);
-    });
-}
 /**
  * Strip any HTML tag from the string.
  *
@@ -100,14 +89,35 @@ import { stringify } from './mixed.mjs';
     }
     return result;
 }
+const HTML_ESCAPE_CHARS = {
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    '\'': '&#39;'
+};
+/**
+ * Escapes the characters that carry meaning in HTML, so the string renders as the text it is.
+ *
+ * Prefer this over {@link stripTags} for a value interpolated into a markup string: `stripTags`
+ * drops everything between a `<` and the next `>`, so a title such as `'Loaded 5 < 10 rows'` loses
+ * half of itself, while escaping blocks the markup and keeps the text whole.
+ *
+ * @param {string} string String to escape.
+ * @returns {string}
+ */ export function escapeHtml(string) {
+    return String(string).replace(/[&<>"']/g, (char)=>HTML_ESCAPE_CHARS[char]);
+}
 /**
  * Returns the string unchanged.
  *
- * @deprecated Default sanitization is now a pass-through. Use the sanitizer
- * configuration option to supply a custom sanitizer function.
+ * @deprecated Since 18.0.0. Handsontable no longer bundles an HTML sanitizer; this helper is a
+ * pass-through and will be removed in 19.0.0. Supply your own sanitizer through the
+ * `sanitizer` configuration option instead.
  * @param {string} string String to return.
  * @returns {string}
  */ export function sanitize(string) {
+    deprecatedWarnOnce('helper.sanitize', '`sanitize()` is deprecated and will be removed in Handsontable 19.0.0. ' + 'It returns its input unchanged. Use the `sanitizer` option to supply your own sanitizer.');
     return string;
 }
 /**

package/helpers/templateString.d.mts

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

package/helpers/templateString.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Substitute strings placed between square brackets into value defined in `variables` object. String names defined in
+ * square brackets must be the same as property name of `variables` object.
+ *
+ * Lives in its own module, not in `helpers/string`, so that `helpers/console` can use it without
+ * importing `helpers/string` — `helpers/string` needs `deprecatedWarnOnce` from `helpers/console`,
+ * and the resulting cycle would leave one of the two modules reading an uninitialized binding.
+ *
+ * @param {string} template Template string.
+ * @param {object} variables Object which contains all available values which can be injected into template.
+ * @returns {string}
+ */
+export declare function substitute(template: string, variables?: Record<string, unknown>): string;

package/helpers/templateString.js

@@ -0,0 +1,29 @@
+/**
+ * Substitute strings placed between square brackets into value defined in `variables` object. String names defined in
+ * square brackets must be the same as property name of `variables` object.
+ *
+ * Lives in its own module, not in `helpers/string`, so that `helpers/console` can use it without
+ * importing `helpers/string` — `helpers/string` needs `deprecatedWarnOnce` from `helpers/console`,
+ * and the resulting cycle would leave one of the two modules reading an uninitialized binding.
+ *
+ * @param {string} template Template string.
+ * @param {object} variables Object which contains all available values which can be injected into template.
+ * @returns {string}
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "substitute", {
+    enumerable: true,
+    get: function() {
+        return substitute;
+    }
+});
+function substitute(template, variables = {}) {
+    return `${template}`.replace(/(?:\\)?\[([^[\]]+)]/g, (match, name)=>{
+        if (match.charAt(0) === '\\') {
+            return match.substr(1, match.length - 1);
+        }
+        return variables[name] === undefined ? '' : String(variables[name]);
+    });
+}

package/helpers/templateString.mjs

@@ -0,0 +1,19 @@
+/**
+ * Substitute strings placed between square brackets into value defined in `variables` object. String names defined in
+ * square brackets must be the same as property name of `variables` object.
+ *
+ * Lives in its own module, not in `helpers/string`, so that `helpers/console` can use it without
+ * importing `helpers/string` — `helpers/string` needs `deprecatedWarnOnce` from `helpers/console`,
+ * and the resulting cycle would leave one of the two modules reading an uninitialized binding.
+ *
+ * @param {string} template Template string.
+ * @param {object} variables Object which contains all available values which can be injected into template.
+ * @returns {string}
+ */ export function substitute(template, variables = {}) {
+    return `${template}`.replace(/(?:\\)?\[([^[\]]+)]/g, (match, name)=>{
+        if (match.charAt(0) === '\\') {
+            return match.substr(1, match.length - 1);
+        }
+        return variables[name] === undefined ? '' : String(variables[name]);
+    });
+}

package/helpers/uiButton.d.mts

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

package/helpers/uiButton.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A button type supported by the built-in UI components (`dialog`, `emptyDataState`,
+ * `notification`). Each type maps to the `ht-button--<type>` modifier class.
+ */
+export type ButtonType = 'primary' | 'secondary';
+/**
+ * Checks whether the passed value is one of the supported button types.
+ *
+ * Both the settings validators and the render sites go through this, so a value the validator
+ * accepts is exactly a value the markup can carry.
+ */
+export declare function isButtonType(type: unknown): type is ButtonType;
+/**
+ * Resolves a caller-supplied button type to one of the supported values, falling back to
+ * `secondary` for anything else.
+ *
+ * The UI components build their `ht-button--<type>` class from this value, so resolving it at the
+ * render site keeps an unexpected value from breaking out of the class name (and, once that markup
+ * is built with DOM APIs instead, from throwing `InvalidCharacterError` in `classList.add()`).
+ */
+export declare function resolveButtonType(type: unknown): ButtonType;

package/helpers/uiButton.js

@@ -0,0 +1,37 @@
+/**
+ * A button type supported by the built-in UI components (`dialog`, `emptyDataState`,
+ * `notification`). Each type maps to the `ht-button--<type>` modifier class.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get isButtonType () {
+        return isButtonType;
+    },
+    get resolveButtonType () {
+        return resolveButtonType;
+    }
+});
+/**
+ * The supported button types. Kept module-local so the allowlist cannot be mutated from the
+ * outside; use `isButtonType()` to test a value against it.
+ */ const BUTTON_TYPES = [
+    'primary',
+    'secondary'
+];
+/**
+ * The button type used when the configured one is not recognized.
+ */ const DEFAULT_BUTTON_TYPE = 'secondary';
+function isButtonType(type) {
+    return typeof type === 'string' && BUTTON_TYPES.includes(type);
+}
+function resolveButtonType(type) {
+    return isButtonType(type) ? type : DEFAULT_BUTTON_TYPE;
+}

package/helpers/uiButton.mjs

@@ -0,0 +1,31 @@
+/**
+ * A button type supported by the built-in UI components (`dialog`, `emptyDataState`,
+ * `notification`). Each type maps to the `ht-button--<type>` modifier class.
+ */ /**
+ * The supported button types. Kept module-local so the allowlist cannot be mutated from the
+ * outside; use `isButtonType()` to test a value against it.
+ */ const BUTTON_TYPES = [
+    'primary',
+    'secondary'
+];
+/**
+ * The button type used when the configured one is not recognized.
+ */ const DEFAULT_BUTTON_TYPE = 'secondary';
+/**
+ * Checks whether the passed value is one of the supported button types.
+ *
+ * Both the settings validators and the render sites go through this, so a value the validator
+ * accepts is exactly a value the markup can carry.
+ */ export function isButtonType(type) {
+    return typeof type === 'string' && BUTTON_TYPES.includes(type);
+}
+/**
+ * Resolves a caller-supplied button type to one of the supported values, falling back to
+ * `secondary` for anything else.
+ *
+ * The UI components build their `ht-button--<type>` class from this value, so resolving it at the
+ * render site keeps an unexpected value from breaking out of the class name (and, once that markup
+ * is built with DOM APIs instead, from throwing `InvalidCharacterError` in `classList.add()`).
+ */ export function resolveButtonType(type) {
+    return isButtonType(type) ? type : DEFAULT_BUTTON_TYPE;
+}

package/i18n/languages/fa-IR.d.ts

@@ -1,5 +1,6 @@
 declare const dictionary: {
     languageCode: string;
+    languageDirection: string;
     "Common:ok": string;
     "Common:cancel": string;
     "ContextMenu:items.noItems": string;

package/i18n/languages/fa-IR.js

@@ -58,6 +58,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 }
 const dictionary = {
     languageCode: 'fa-IR',
+    languageDirection: 'rtl',
     [_constants.OK]: 'تایید',
     [_constants.CANCEL]: 'لغو',
     [_constants.CONTEXTMENU_ITEMS_NO_ITEMS]: 'هیچ گزینه ای در دسترس نیست',

package/i18n/languages/fa-IR.mjs

@@ -7,6 +7,7 @@
  */ import * as C from '../constants.mjs';
 const dictionary = {
     languageCode: 'fa-IR',
+    languageDirection: 'rtl',
     [C.OK]: 'تایید',
     [C.CANCEL]: 'لغو',
     [C.CONTEXTMENU_ITEMS_NO_ITEMS]: 'هیچ گزینه ای در دسترس نیست',

package/index.d.ts

@@ -2,8 +2,8 @@ import Handsontable from './base';
 export { CellCoords, CellRange } from './base';
 export type { HooksRegistry } from './base';
 export { IndexMapper } from './translations';
-export type { GridSettings, Events } from './core/settings';
-export type { CellValue, CellChange, RowObject, ChangeSource, CellMeta, CellProperties, ColumnSettings, SourceRowData } from './settings';
+export type { GridSettings, Events, SanitizerContext } from './core/settings';
+export type { CellValue, CellChange, RowObject, ChangeSource, CellMeta, CellProperties, ColumnSettings, SourceRowData, RemoveIndexSignature } from './settings';
 export type { RangeType, HotInstance } from './core/types';
 export type { OverlayType } from './3rdparty/walkontable/src/types';
 export type { BaseEditor as BaseEditorInstance } from './editors/baseEditor/baseEditor';
@@ -12,5 +12,5 @@ export type { CellType } from './cellTypes/registry';
 export type { EditorType } from './editors/registry';
 export type { RendererType } from './renderers/registry';
 export type { ValidatorType } from './validators/registry';
-export type { BaseTheme, ThemeBuilder, ThemeColorScheme, ThemeColorsConfig, ThemeConfig, ThemeDensityConfig, ThemeDensitySizes, ThemeIconsConfig, ThemeLightDarkValue, ThemeParams, ThemeSizingConfig, ThemeTokenValue, ThemeTokensConfig, } from './themes';
+export type { BaseTheme, DensityType, ThemeBuilder, ThemeColorScheme, ThemeColorsConfig, ThemeConfig, ThemeDensityConfig, ThemeDensitySizes, ThemeIconsConfig, ThemeLightDarkValue, ThemeParams, ThemeSizingConfig, ThemeTokenValue, ThemeTokensConfig, } from './themes';
 export default Handsontable;

package/languages/all.js

@@ -396,7 +396,8 @@ function _define_property(obj, key, value) {
 var C = (handsontable__rspack_import_0_default().languages.dictionaryKeys);
 var _obj;
 var dictionary = (_obj = {
-    languageCode: 'fa-IR'
+    languageCode: 'fa-IR',
+    languageDirection: 'rtl'
 }, _define_property(_obj, C.OK, 'تایید'), _define_property(_obj, C.CANCEL, 'لغو'), _define_property(_obj, C.CONTEXTMENU_ITEMS_NO_ITEMS, 'هیچ گزینه ای در دسترس نیست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_ABOVE, 'درج ردیف در بالا'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_BELOW, 'درج ردیف در پایین'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_LEFT, 'درج ستون در چپ'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_RIGHT, 'درج ستون در راست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_REMOVE_ROW, [
     'حذف ردیف',
     'حذف ردیف ها'

package/languages/fa-IR.js

@@ -114,7 +114,8 @@ function _define_property(obj, key, value) {
 var C = (handsontable__rspack_import_0_default().languages.dictionaryKeys);
 var _obj;
 var dictionary = (_obj = {
-    languageCode: 'fa-IR'
+    languageCode: 'fa-IR',
+    languageDirection: 'rtl'
 }, _define_property(_obj, C.OK, 'تایید'), _define_property(_obj, C.CANCEL, 'لغو'), _define_property(_obj, C.CONTEXTMENU_ITEMS_NO_ITEMS, 'هیچ گزینه ای در دسترس نیست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_ABOVE, 'درج ردیف در بالا'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_BELOW, 'درج ردیف در پایین'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_LEFT, 'درج ستون در چپ'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_RIGHT, 'درج ستون در راست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_REMOVE_ROW, [
     'حذف ردیف',
     'حذف ردیف ها'

package/languages/fa-IR.mjs

@@ -9,6 +9,7 @@
 const C = Handsontable.languages.dictionaryKeys;
 const dictionary = {
     languageCode: 'fa-IR',
+    languageDirection: 'rtl',
     [C.OK]: 'تایید',
     [C.CANCEL]: 'لغو',
     [C.CONTEXTMENU_ITEMS_NO_ITEMS]: 'هیچ گزینه ای در دسترس نیست',

package/languages/index.js

@@ -396,7 +396,8 @@ function _define_property(obj, key, value) {
 var C = (handsontable__rspack_import_0_default().languages.dictionaryKeys);
 var _obj;
 var dictionary = (_obj = {
-    languageCode: 'fa-IR'
+    languageCode: 'fa-IR',
+    languageDirection: 'rtl'
 }, _define_property(_obj, C.OK, 'تایید'), _define_property(_obj, C.CANCEL, 'لغو'), _define_property(_obj, C.CONTEXTMENU_ITEMS_NO_ITEMS, 'هیچ گزینه ای در دسترس نیست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_ABOVE, 'درج ردیف در بالا'), _define_property(_obj, C.CONTEXTMENU_ITEMS_ROW_BELOW, 'درج ردیف در پایین'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_LEFT, 'درج ستون در چپ'), _define_property(_obj, C.CONTEXTMENU_ITEMS_INSERT_RIGHT, 'درج ستون در راست'), _define_property(_obj, C.CONTEXTMENU_ITEMS_REMOVE_ROW, [
     'حذف ردیف',
     'حذف ردیف ها'

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/handsontable/handsontable/issues"
   },
   "author": "Handsoncode <hello@handsontable.com>",
-  "version": "18.0.0",
+  "version": "18.1.0-rc7",
   "main": "index",
   "module": "index.mjs",
   "jsnext:main": "index.mjs",
@@ -91,6 +91,16 @@
         "default": "./cellTypes/handsontableType/index.js"
       }
     },
+    "./cellTypes/intlDatetimeType": {
+      "import": {
+        "types": "./cellTypes/intlDatetimeType/index.d.mts",
+        "default": "./cellTypes/intlDatetimeType/index.mjs"
+      },
+      "require": {
+        "types": "./cellTypes/intlDatetimeType/index.d.ts",
+        "default": "./cellTypes/intlDatetimeType/index.js"
+      }
+    },
     "./cellTypes/intlDateType": {
       "import": {
         "types": "./cellTypes/intlDateType/index.d.mts",
@@ -437,6 +447,16 @@
         "default": "./editors/intlDateEditor/index.js"
       }
     },
+    "./editors/intlDatetimeEditor": {
+      "import": {
+        "types": "./editors/intlDatetimeEditor/index.d.mts",
+        "default": "./editors/intlDatetimeEditor/index.mjs"
+      },
+      "require": {
+        "types": "./editors/intlDatetimeEditor/index.d.ts",
+        "default": "./editors/intlDatetimeEditor/index.js"
+      }
+    },
     "./editors/intlTimeEditor": {
       "import": {
         "types": "./editors/intlTimeEditor/index.d.mts",
@@ -827,6 +847,16 @@
         "default": "./plugins/mergeCells/index.js"
       }
     },
+    "./plugins/moveCells": {
+      "import": {
+        "types": "./plugins/moveCells/index.d.mts",
+        "default": "./plugins/moveCells/index.mjs"
+      },
+      "require": {
+        "types": "./plugins/moveCells/index.d.ts",
+        "default": "./plugins/moveCells/index.js"
+      }
+    },
     "./plugins/multiColumnSorting": {
       "import": {
         "types": "./plugins/multiColumnSorting/index.d.mts",
@@ -897,6 +927,16 @@
         "default": "./plugins/search/index.js"
       }
     },
+    "./plugins/selectionHandles": {
+      "import": {
+        "types": "./plugins/selectionHandles/index.d.mts",
+        "default": "./plugins/selectionHandles/index.mjs"
+      },
+      "require": {
+        "types": "./plugins/selectionHandles/index.d.ts",
+        "default": "./plugins/selectionHandles/index.js"
+      }
+    },
     "./plugins/stretchColumns": {
       "import": {
         "types": "./plugins/stretchColumns/index.d.mts",
@@ -1037,6 +1077,16 @@
         "default": "./renderers/intlDateRenderer/index.js"
       }
     },
+    "./renderers/intlDatetimeRenderer": {
+      "import": {
+        "types": "./renderers/intlDatetimeRenderer/index.d.mts",
+        "default": "./renderers/intlDatetimeRenderer/index.mjs"
+      },
+      "require": {
+        "types": "./renderers/intlDatetimeRenderer/index.d.ts",
+        "default": "./renderers/intlDatetimeRenderer/index.js"
+      }
+    },
     "./renderers/intlTimeRenderer": {
       "import": {
         "types": "./renderers/intlTimeRenderer/index.d.mts",
@@ -1167,6 +1217,16 @@
         "default": "./validators/dropdownValidator/index.js"
       }
     },
+    "./validators/intlDatetimeValidator": {
+      "import": {
+        "types": "./validators/intlDatetimeValidator/index.d.mts",
+        "default": "./validators/intlDatetimeValidator/index.mjs"
+      },
+      "require": {
+        "types": "./validators/intlDatetimeValidator/index.d.ts",
+        "default": "./validators/intlDatetimeValidator/index.js"
+      }
+    },
     "./validators/intlDateValidator": {
       "import": {
         "types": "./validators/intlDateValidator/index.d.mts",

package/plugins/autoColumnSize/autoColumnSize.d.ts

@@ -2,7 +2,7 @@ import type { HotInstance } from '../../core/types';
 import { BasePlugin } from '../base';
 import GhostTable from '../../utils/ghostTable';
 import SamplesGenerator from '../../utils/samplesGenerator';
-import { PhysicalIndexToValueMap as IndexToValueMap } from '../../translations';
+import type { PhysicalIndexToValueMap as IndexToValueMap } from '../../translations';
 export declare const PLUGIN_KEY = "autoColumnSize";
 export declare const PLUGIN_PRIORITY = 10;
 /**
@@ -52,6 +52,12 @@ export declare const PLUGIN_PRIORITY = 10;
  *   }
  * ```
  *
+ * ::: tip
+ * If you use custom renderers or custom styles that produce non-standard column widths, and you call
+ * {@link Core#scrollViewportTo}, make sure `AutoColumnSize` is enabled. Without it, `scrollViewportTo()` calculates
+ * scroll positions based on incorrect column widths and may scroll to an incorrect position.
+ * :::
+ *
  * To configure this plugin see {@link Options#autoColumnSize}.
  *
  * @example
@@ -177,6 +183,13 @@ export declare class AutoColumnSize extends BasePlugin {
      * Returns the maximum number of columns whose widths are calculated synchronously before switching to async mode.
      */
     static get SYNC_CALCULATION_LIMIT(): number;
+    /**
+     * Returns the maximum number of cells sampled in a single asynchronous calculation step. Together
+     * with {@link AutoColumnSize.CALCULATION_STEP} it bounds the work done per animation frame: a
+     * column whose row range exceeds the budget is swept across multiple frames, and its width is
+     * written once, when the sweep completes.
+     */
+    static get CALCULATION_CELLS_BUDGET(): number;
     /**
      * Instance of {@link GhostTable} for rows and columns size calculations.
      *
@@ -286,12 +299,22 @@ export declare class AutoColumnSize extends BasePlugin {
     /**
      * Gets the first visible column.
      *
+     * When the {@link MergeCells} plugin is enabled with its default `virtualized: false` setting, a merged
+     * cell that crosses the viewport edge extends the rendered column range. In that case this method can
+     * return a column index outside the strictly visible viewport. To read the actual visible viewport, use
+     * {@link Core#getFirstFullyVisibleColumn} or {@link Core#getFirstPartiallyVisibleColumn}.
+     *
      * @returns {number} Returns visual column index, -1 if table is not rendered or if there are no columns to base the the calculations on.
      */
     getFirstVisibleColumn(): number;
     /**
      * Gets the last visible column.
      *
+     * When the {@link MergeCells} plugin is enabled with its default `virtualized: false` setting, a merged
+     * cell that crosses the viewport edge extends the rendered column range. In that case this method can
+     * return a column index outside the strictly visible viewport. To read the actual visible viewport, use
+     * {@link Core#getLastFullyVisibleColumn} or {@link Core#getLastPartiallyVisibleColumn}.
+     *
      * @returns {number} Returns visual column index or -1 if table is not rendered.
      */
     getLastVisibleColumn(): number;