handsontable 12.3.3 → 12.4.0-next-ddbea0c-20230512

package/plugins/collapsibleColumns/collapsibleColumns.js

@@ -160,9 +160,33 @@ var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached reference to the NestedHeaders plugin.
+     *
+     * @private
+     * @type {NestedHeaders}
+     */
     _defineProperty(_assertThisInitialized(_this), "nestedHeadersPlugin", null);
+    /**
+     * Event manager instance reference.
+     *
+     * @private
+     * @type {EventManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "eventManager", new _eventManager.default(_assertThisInitialized(_this)));
+    /**
+     * The NestedHeaders plugin StateManager instance.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "headerStateManager", null);
+    /**
+     * Map of collapsed columns by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _collapsedColumnsMap, {
       writable: true,
       value: null
@@ -584,13 +608,6 @@ var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return [PLUGIN_KEY].concat(SETTING_KEYS);
     }
-
-    /**
-     * Cached reference to the NestedHeaders plugin.
-     *
-     * @private
-     * @type {NestedHeaders}
-     */
   }]);
   return CollapsibleColumns;
 }(_base.BasePlugin);

package/plugins/collapsibleColumns/collapsibleColumns.mjs

@@ -153,9 +153,33 @@ export var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached reference to the NestedHeaders plugin.
+     *
+     * @private
+     * @type {NestedHeaders}
+     */
     _defineProperty(_assertThisInitialized(_this), "nestedHeadersPlugin", null);
+    /**
+     * Event manager instance reference.
+     *
+     * @private
+     * @type {EventManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "eventManager", new EventManager(_assertThisInitialized(_this)));
+    /**
+     * The NestedHeaders plugin StateManager instance.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "headerStateManager", null);
+    /**
+     * Map of collapsed columns by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _collapsedColumnsMap, {
       writable: true,
       value: null
@@ -577,13 +601,6 @@ export var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return [PLUGIN_KEY].concat(SETTING_KEYS);
     }
-
-    /**
-     * Cached reference to the NestedHeaders plugin.
-     *
-     * @private
-     * @type {NestedHeaders}
-     */
   }]);
   return CollapsibleColumns;
 }(BasePlugin);

package/plugins/copyPaste/copyPaste.js

@@ -143,35 +143,115 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Counts how many column headers will be copied based on the passed range.
+     *
+     * @private
+     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
+     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
+     *                                           information with the number of copied headers.
+     */
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _countCopiedHeaders);
+    /**
+     * The maximum number of columns than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "columnsLimit", Infinity);
+    /**
+     * The maximum number of rows than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "rowsLimit", Infinity);
+    /**
+     * When pasting:
+     * - `'overwrite'`: overwrite the currently-selected cells
+     * - `'shift_down'`: move currently-selected cells down
+     * - `'shift_right'`: move currently-selected cells to the right
+     *
+     * @type {string}
+     * @default 'overwrite'
+     */
     _defineProperty(_assertThisInitialized(_this), "pasteMode", 'overwrite');
+    /**
+     * The UI container for the secondary focusable element.
+     *
+     * @type {HTMLElement}
+     */
     _defineProperty(_assertThisInitialized(_this), "uiContainer", _this.hot.rootDocument.body);
+    /**
+     * Shows the "Copy with headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy with group headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_group headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnGroupHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy headers only" item in the context menu and extends the context menu with the
+     * `'copy_column_headers_only'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeadersOnly, {
       writable: true,
       value: false
     });
+    /**
+     * Defines the data range to copy. Possible values:
+     *  * `'cells-only'` Copy selected cells only;
+     *  * `'column-headers-only'` Copy column headers only;
+     *  * `'with-all-column-headers'` Copy cells with all column headers;
+     *  * `'with-column-headers'` Copy cells with column headers;
+     *
+     * @type {'cells-only' | 'column-headers-only' | 'with-all-column-headers' | 'with-column-headers'}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyMode, {
       writable: true,
       value: 'cells-only'
     });
+    /**
+     * Flag that is used to prevent copying when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCopy, {
       writable: true,
       value: false
     });
+    /**
+     * Flag that is used to prevent cutting when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCut, {
       writable: true,
       value: false
     });
+    /**
+     * Class that helps generate copyable ranges based on the current selection for different copy mode
+     * types.
+     *
+     * @type {CopyableRangesFactory}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyableRangesFactory, {
       writable: true,
       value: new _copyableRanges.CopyableRangesFactory({
@@ -192,7 +272,19 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
         }
       })
     });
+    /**
+     * Ranges of the cells coordinates, which should be used to copy/cut/paste actions.
+     *
+     * @private
+     * @type {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>}
+     */
     _defineProperty(_assertThisInitialized(_this), "copyableRanges", []);
+    /**
+     * Provides focusable element to support IME and copy/paste/cut actions.
+     *
+     * @private
+     * @type {FocusableWrapper}
+     */
     _defineProperty(_assertThisInitialized(_this), "focusableElement", void 0);
     return _this;
   }
@@ -501,15 +593,6 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       var _this$hot$getActiveEd2;
       return (_this$hot$getActiveEd2 = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd2 === void 0 ? void 0 : _this$hot$getActiveEd2.isOpened();
     }
-
-    /**
-     * Counts how many column headers will be copied based on the passed range.
-     *
-     * @private
-     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
-     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
-     *                                           information with the number of copied headers.
-     */
   }, {
     key: "populateValues",
     value:
@@ -795,13 +878,6 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The maximum number of columns than can be copied to the clipboard.
-     *
-     * @type {number}
-     * @default Infinity
-     */
   }]);
   return CopyPaste;
 }(_base.BasePlugin);

package/plugins/copyPaste/copyPaste.mjs

@@ -136,35 +136,115 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Counts how many column headers will be copied based on the passed range.
+     *
+     * @private
+     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
+     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
+     *                                           information with the number of copied headers.
+     */
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _countCopiedHeaders);
+    /**
+     * The maximum number of columns than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "columnsLimit", Infinity);
+    /**
+     * The maximum number of rows than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "rowsLimit", Infinity);
+    /**
+     * When pasting:
+     * - `'overwrite'`: overwrite the currently-selected cells
+     * - `'shift_down'`: move currently-selected cells down
+     * - `'shift_right'`: move currently-selected cells to the right
+     *
+     * @type {string}
+     * @default 'overwrite'
+     */
     _defineProperty(_assertThisInitialized(_this), "pasteMode", 'overwrite');
+    /**
+     * The UI container for the secondary focusable element.
+     *
+     * @type {HTMLElement}
+     */
     _defineProperty(_assertThisInitialized(_this), "uiContainer", _this.hot.rootDocument.body);
+    /**
+     * Shows the "Copy with headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy with group headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_group headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnGroupHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy headers only" item in the context menu and extends the context menu with the
+     * `'copy_column_headers_only'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeadersOnly, {
       writable: true,
       value: false
     });
+    /**
+     * Defines the data range to copy. Possible values:
+     *  * `'cells-only'` Copy selected cells only;
+     *  * `'column-headers-only'` Copy column headers only;
+     *  * `'with-all-column-headers'` Copy cells with all column headers;
+     *  * `'with-column-headers'` Copy cells with column headers;
+     *
+     * @type {'cells-only' | 'column-headers-only' | 'with-all-column-headers' | 'with-column-headers'}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyMode, {
       writable: true,
       value: 'cells-only'
     });
+    /**
+     * Flag that is used to prevent copying when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCopy, {
       writable: true,
       value: false
     });
+    /**
+     * Flag that is used to prevent cutting when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCut, {
       writable: true,
       value: false
     });
+    /**
+     * Class that helps generate copyable ranges based on the current selection for different copy mode
+     * types.
+     *
+     * @type {CopyableRangesFactory}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyableRangesFactory, {
       writable: true,
       value: new CopyableRangesFactory({
@@ -185,7 +265,19 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
         }
       })
     });
+    /**
+     * Ranges of the cells coordinates, which should be used to copy/cut/paste actions.
+     *
+     * @private
+     * @type {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>}
+     */
     _defineProperty(_assertThisInitialized(_this), "copyableRanges", []);
+    /**
+     * Provides focusable element to support IME and copy/paste/cut actions.
+     *
+     * @private
+     * @type {FocusableWrapper}
+     */
     _defineProperty(_assertThisInitialized(_this), "focusableElement", void 0);
     return _this;
   }
@@ -494,15 +586,6 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       var _this$hot$getActiveEd2;
       return (_this$hot$getActiveEd2 = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd2 === void 0 ? void 0 : _this$hot$getActiveEd2.isOpened();
     }
-
-    /**
-     * Counts how many column headers will be copied based on the passed range.
-     *
-     * @private
-     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
-     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
-     *                                           information with the number of copied headers.
-     */
   }, {
     key: "populateValues",
     value:
@@ -788,13 +871,6 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The maximum number of columns than can be copied to the clipboard.
-     *
-     * @type {number}
-     * @default Infinity
-     */
   }]);
   return CopyPaste;
 }(BasePlugin);

package/plugins/copyPaste/copyableRanges.js

@@ -33,6 +33,13 @@ function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) {
 function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
 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 _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; } }
+/**
+ * The utils class produces the selection ranges in the `{startRow, startCol, endRow, endCol}` format
+ * based on the current table selection. The CopyPaste plugin consumes that ranges to generate
+ * appropriate data ready to copy to the clipboard.
+ *
+ * @private
+ */
 var _selectedRange = /*#__PURE__*/new WeakMap();
 var _countRows = /*#__PURE__*/new WeakMap();
 var _countColumns = /*#__PURE__*/new WeakMap();
@@ -41,38 +48,7 @@ var _columnsLimit = /*#__PURE__*/new WeakMap();
 var _countColumnHeaders = /*#__PURE__*/new WeakMap();
 var _trimColumnsRange = /*#__PURE__*/new WeakSet();
 var _trimRowsRange = /*#__PURE__*/new WeakSet();
-/**
- * The utils class produces the selection ranges in the `{startRow, startCol, endRow, endCol}` format
- * based on the current table selection. The CopyPaste plugin consumes that ranges to generate
- * appropriate data ready to copy to the clipboard.
- *
- * @private
- */
 var CopyableRangesFactory = /*#__PURE__*/function () {
-  /**
-   * @type {CellRange}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
   /* eslint-disable jsdoc/require-description-complete-sentence */
   /**
    * @param {{
@@ -90,28 +66,60 @@ var CopyableRangesFactory = /*#__PURE__*/function () {
       columnsLimit = _ref.columnsLimit,
       countColumnHeaders = _ref.countColumnHeaders;
     _classCallCheck(this, CopyableRangesFactory);
+    /**
+     * Trimmed the rows range to the limit.
+     *
+     * @param {*} startRow The lowest row index in the range.
+     * @param {*} endRow The highest row index in the range.
+     * @returns {number} Returns trimmed row index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimRowsRange);
+    /**
+     * Trimmed the columns range to the limit.
+     *
+     * @param {*} startColumn The lowest column index in the range.
+     * @param {*} endColumn The highest column index in the range.
+     * @returns {number} Returns trimmed column index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimColumnsRange);
+    /**
+     * @type {CellRange}
+     */
     _classPrivateFieldInitSpec(this, _selectedRange, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countRows, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countColumns, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _rowsLimit, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _columnsLimit, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countColumnHeaders, {
       writable: true,
       value: void 0
@@ -218,14 +226,6 @@ var CopyableRangesFactory = /*#__PURE__*/function () {
         endCol: finalEndCol
       };
     }
-
-    /**
-     * Trimmed the columns range to the limit.
-     *
-     * @param {*} startColumn The lowest column index in the range.
-     * @param {*} endColumn The highest column index in the range.
-     * @returns {number} Returns trimmed column index if it exceeds the limit.
-     */
   }]);
   return CopyableRangesFactory;
 }();

package/plugins/copyPaste/copyableRanges.mjs

@@ -44,30 +44,6 @@ var _countColumnHeaders = /*#__PURE__*/new WeakMap();
 var _trimColumnsRange = /*#__PURE__*/new WeakSet();
 var _trimRowsRange = /*#__PURE__*/new WeakSet();
 export var CopyableRangesFactory = /*#__PURE__*/function () {
-  /**
-   * @type {CellRange}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
-  /**
-   * @type {function(): number}
-   */
-
   /* eslint-disable jsdoc/require-description-complete-sentence */
   /**
    * @param {{
@@ -85,28 +61,60 @@ export var CopyableRangesFactory = /*#__PURE__*/function () {
       columnsLimit = _ref.columnsLimit,
       countColumnHeaders = _ref.countColumnHeaders;
     _classCallCheck(this, CopyableRangesFactory);
+    /**
+     * Trimmed the rows range to the limit.
+     *
+     * @param {*} startRow The lowest row index in the range.
+     * @param {*} endRow The highest row index in the range.
+     * @returns {number} Returns trimmed row index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimRowsRange);
+    /**
+     * Trimmed the columns range to the limit.
+     *
+     * @param {*} startColumn The lowest column index in the range.
+     * @param {*} endColumn The highest column index in the range.
+     * @returns {number} Returns trimmed column index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimColumnsRange);
+    /**
+     * @type {CellRange}
+     */
     _classPrivateFieldInitSpec(this, _selectedRange, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countRows, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countColumns, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _rowsLimit, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _columnsLimit, {
       writable: true,
       value: void 0
     });
+    /**
+     * @type {function(): number}
+     */
     _classPrivateFieldInitSpec(this, _countColumnHeaders, {
       writable: true,
       value: void 0
@@ -213,14 +221,6 @@ export var CopyableRangesFactory = /*#__PURE__*/function () {
         endCol: finalEndCol
       };
     }
-
-    /**
-     * Trimmed the columns range to the limit.
-     *
-     * @param {*} startColumn The lowest column index in the range.
-     * @param {*} endColumn The highest column index in the range.
-     * @returns {number} Returns trimmed column index if it exceeds the limit.
-     */
   }]);
   return CopyableRangesFactory;
 }();

package/plugins/customBorders/customBorders.d.ts

@@ -14,6 +14,8 @@ export interface BorderRange {
   };
 }
 export type DetailedSettings = (SimpleCellCoords | BorderRange) & {
+  start?: BorderOptions | string;
+  end?: BorderOptions | string;
   left?: BorderOptions | string;
   right?: BorderOptions | string;
   top?: BorderOptions | string;

package/plugins/customBorders/customBorders.js

@@ -129,6 +129,12 @@ var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Saved borders.
+     *
+     * @private
+     * @type {Array}
+     */
     _defineProperty(_assertThisInitialized(_this), "savedBorders", []);
     return _this;
   }
@@ -879,13 +885,6 @@ var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Saved borders.
-     *
-     * @private
-     * @type {Array}
-     */
   }]);
   return CustomBorders;
 }(_base.BasePlugin);