@rowsncolumns/spreadsheet-state 29.0.0 → 29.1.1

package/dist/esm/hooks/use-on-sort-table.js

@@ -5,6 +5,7 @@ import { produceWithPatches } from "immer";
 import set from "lodash/set";
 import { useCallback } from "react";
 import { createSheetCellIdentifier } from "../api/formula";
+import { getCellSortValue } from "../api/sort";
 import { createSheetDraft } from "../api/immer-utils";
 import { SheetCell } from "../sheet-cell";
 import { useShowError } from "../atoms/error-state.atom";
@@ -15,7 +16,7 @@ import { sortRowEntriesByFrozenState, } from "./utils/sort-rows";
  * @param param0
  * @returns
  */
-export const useOnSortTable = ({ locale, sharedStringRegistry, createHistory, enqueueCalculation, enqueueStructureChange, enqueueGraphOperation, onChangeSheetData, onChangeTables, onChangeSheets, getDependents, isHiddenRow, getActiveCell, getFrozenRowCount, getSheetName, getEffectiveFormat, theme, enableSortTimingLogs, onCommand, }) => {
+export const useOnSortTable = ({ locale, sharedStringRegistry, createHistory, enqueueCalculation, enqueueStructureChange, enqueueGraphOperation, onChangeSheetData, onChangeTables, onChangeSheets, getCellData, getDependents, isHiddenRow, isManuallyHiddenRow, getActiveCell, getFrozenRowCount, getSheetName, getEffectiveFormat, theme, enableSortTimingLogs, onCommand, }) => {
     const canEditCellRange = useCanEditCellRange();
     const canPerformSheetAction = useCanPerformSheetAction();
     const showError = useShowError();
@@ -94,105 +95,122 @@ export const useOnSortTable = ({ locale, sharedStringRegistry, createHistory, en
                 return prevTables;
             }
         });
-        // Update basic filter sort specs if exists
+        const { range, headerRow = true, totalRow } = filter;
+        const startRowIndex = range.startRowIndex + (headerRow ? 1 : 0);
+        const endRowIndex = range.endRowIndex - (totalRow ? 1 : 0);
+        const frozenRowCount = getFrozenRowCount(sheetId);
+        const isPinnedRow = (rowIndex) => isManuallyHiddenRow
+            ? isManuallyHiddenRow(sheetId, rowIndex)
+            : isHiddenRow(sheetId, rowIndex);
+        const overallStart = now();
+        // Gather the sort keys from the committed cell data. Pinned rows
+        // contribute no entry and are never rewritten.
+        const buildStart = now();
+        const rowEntries = [];
+        for (let rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
+            if (isPinnedRow(rowIndex)) {
+                continue;
+            }
+            // One sort value per spec, in spec order, so the comparator can
+            // apply each spec as a "then by" tiebreaker. Each spec's column is
+            // `range.startColumnIndex + spec.dimensionIndex`.
+            const sortValues = sortSpecs.map((spec) => {
+                const specColumnIndex = range.startColumnIndex + spec.dimensionIndex;
+                const sortCell = new SheetCell(sheetId, { rowIndex, columnIndex: specColumnIndex }, getCellData(sheetId, rowIndex, specColumnIndex), { locale, sharedStringRegistry });
+                const fallbackValue = getCellSortValue(sortCell);
+                // For color/icon sort modes, replace the value with the
+                // matching attribute from the cell's effective format.
+                const sortBy = spec.sortBy ?? "value";
+                const fmt = sortBy === "cellColor" || sortBy === "fontColor" || sortBy === "icon"
+                    ? getEffectiveFormat?.(sheetId, rowIndex, specColumnIndex)
+                    : undefined;
+                // Resolve theme-indexed colors to their painted hex so
+                // sort-rows.ts can compare via plain string equality.
+                return sortBy === "cellColor"
+                    ? getStringifiedColor(fmt?.backgroundColor, theme)
+                    : sortBy === "fontColor"
+                        ? getStringifiedColor(fmt?.textFormat?.color, theme)
+                        : sortBy === "icon"
+                            ? fmt?.conditionalIcon
+                                ? {
+                                    iconSet: fmt.conditionalIcon.iconSet,
+                                    iconId: fmt.conditionalIcon.iconId,
+                                }
+                                : undefined
+                            : fallbackValue;
+            });
+            rowEntries.push({ rowIndex, sortValues });
+        }
+        const buildMs = now() - buildStart;
+        // The slots the sorted rows land on, ascending (the sort reorders
+        // `rowEntries` in place).
+        const destRows = rowEntries.map((entry) => entry.rowIndex);
+        // Sort data — one engine spec per SortSpecs entry, in order.
+        // `sortedEntries[i]` is the row that lands on `destRows[i]`.
+        const sortStart = now();
+        const sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, sortSpecs.map((spec) => ({
+            sortOrder: spec.sortOrder,
+            sortBy: spec.sortBy,
+            // Pre-resolve so the comparator can use string equality.
+            sortColor: getStringifiedColor(spec.sortColor, theme),
+            sortIcon: spec.sortIcon,
+            customList: spec.customList,
+        })));
+        const sortMs = now() - sortStart;
+        // Update basic filter sort specs if exists, and carry each row's
+        // `hiddenByFilter` flag to the row's destination: a sort does not
+        // re-evaluate the filter, so the hidden set follows the rows.
         onChangeSheets?.((prevSheets) => {
-            const sheet = prevSheets.find((sheet) => sheet.sheetId === sheetId);
-            if (sheet && sheet.basicFilter?.id === filter.id) {
-                const [nextState, patches, inversePatches] = produceWithPatches(prevSheets, (draft) => {
-                    const sheet = draft.find((sheet) => sheet.sheetId === sheetId);
-                    if (sheet) {
-                        set(sheet, "basicFilter.sortSpecs", sortSpecs);
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheets, (draft) => {
+                const sheet = draft.find((sheet) => sheet.sheetId === sheetId);
+                if (!sheet) {
+                    return;
+                }
+                if (sheet.basicFilter?.id === filter.id) {
+                    set(sheet, "basicFilter.sortSpecs", sortSpecs);
+                }
+                const hiddenByFilterAt = (rowIndex) => Boolean(sheet.rowMetadata?.[rowIndex]?.hiddenByFilter);
+                // Read every source flag before writing any destination.
+                const carried = destRows.map((rowIndex, index) => hiddenByFilterAt(sortedEntries[index]?.rowIndex ?? rowIndex));
+                destRows.forEach((rowIndex, index) => {
+                    const hiddenByFilter = carried[index];
+                    if (hiddenByFilter === hiddenByFilterAt(rowIndex)) {
+                        return;
                     }
+                    if (!sheet.rowMetadata) {
+                        sheet.rowMetadata = [];
+                    }
+                    sheet.rowMetadata[rowIndex] = {
+                        ...sheet.rowMetadata[rowIndex],
+                        hiddenByFilter,
+                    };
                 });
-                saveHistory({
-                    sheets: {
-                        patches,
-                        inversePatches,
-                    },
-                });
-                return nextState;
+            });
+            if (!patches.length) {
+                return prevSheets;
             }
-            return prevSheets;
+            saveHistory({
+                sheets: {
+                    patches,
+                    inversePatches,
+                },
+            });
+            return nextState;
         });
         // Update sheet data
         onChangeSheetData?.((prevSheetData) => {
-            const overallStart = now();
-            let buildMs = 0;
-            let sortMs = 0;
             let applyMs = 0;
             const [nextState, patches, inversePatches] = produceWithPatches(prevSheetData, (draft) => {
                 const sheet = draft[sheetId];
-                const { range, headerRow = true, totalRow } = filter;
-                const startRowIndex = range.startRowIndex + (headerRow ? 1 : 0);
-                const endRowIndex = range.endRowIndex - (totalRow ? 1 : 0);
-                const rowEntries = [];
                 const rowSnapshots = new Map();
-                const frozenRowCount = getFrozenRowCount(sheetId);
-                // Gather row data
-                const buildStart = now();
-                for (let rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        continue;
-                    }
-                    const rowValue = sheet[rowIndex];
-                    rowSnapshots.set(rowIndex, (rowValue?.values ?? []).slice());
-                    // One sort value per spec, in spec order, so the comparator
-                    // can apply each spec as a "then by" tiebreaker. Each spec's
-                    // column is `range.startColumnIndex + spec.dimensionIndex`.
-                    const sortValues = sortSpecs.map((spec) => {
-                        const specColumnIndex = range.startColumnIndex + spec.dimensionIndex;
-                        const sortCellData = rowValue?.values?.[specColumnIndex];
-                        const sortCell = new SheetCell(sheetId, { rowIndex, columnIndex: specColumnIndex }, sortCellData, { locale, sharedStringRegistry });
-                        const fallbackValue = sortCell.getEffectiveValue() ?? sortCell.formattedValue;
-                        // For color/icon sort modes, replace the value with the
-                        // matching attribute from the cell's effective format.
-                        const sortBy = spec.sortBy ?? "value";
-                        const fmt = sortBy === "cellColor" ||
-                            sortBy === "fontColor" ||
-                            sortBy === "icon"
-                            ? getEffectiveFormat?.(sheetId, rowIndex, specColumnIndex)
-                            : undefined;
-                        // Resolve theme-indexed colors to their painted hex so
-                        // sort-rows.ts can compare via plain string equality.
-                        return sortBy === "cellColor"
-                            ? getStringifiedColor(fmt?.backgroundColor, theme)
-                            : sortBy === "fontColor"
-                                ? getStringifiedColor(fmt?.textFormat?.color, theme)
-                                : sortBy === "icon"
-                                    ? fmt?.conditionalIcon
-                                        ? {
-                                            iconSet: fmt.conditionalIcon.iconSet,
-                                            iconId: fmt.conditionalIcon.iconId,
-                                        }
-                                        : undefined
-                                    : fallbackValue;
-                    });
-                    rowEntries.push({ rowIndex, sortValues });
+                for (const rowIndex of destRows) {
+                    rowSnapshots.set(rowIndex, (sheet[rowIndex]?.values ?? []).slice());
                 }
-                buildMs = now() - buildStart;
-                // Sort data — one engine spec per SortSpecs entry, in order.
-                const sortStart = now();
-                const sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, sortSpecs.map((spec) => ({
-                    sortOrder: spec.sortOrder,
-                    sortBy: spec.sortBy,
-                    // Pre-resolve so the comparator can use string equality.
-                    sortColor: getStringifiedColor(spec.sortColor, theme),
-                    sortIcon: spec.sortIcon,
-                    customList: spec.customList,
-                })));
-                sortMs = now() - sortStart;
-                // Counter for how many rows we have skipped
-                let skippedRow = 0;
                 // Save
                 const applyStart = now();
-                for (let rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        skippedRow++;
-                        continue;
-                    }
-                    const sourceRow = sortedEntries[rowIndex - skippedRow - startRowIndex];
+                for (let index = 0; index < destRows.length; index++) {
+                    const rowIndex = destRows[index];
+                    const sourceRow = sortedEntries[index];
                     if (!sourceRow) {
                         continue;
                     }
@@ -302,6 +320,7 @@ export const useOnSortTable = ({ locale, sharedStringRegistry, createHistory, en
             filter,
             dimensionIndex: primarySpec.dimensionIndex,
             sortOrder: primarySpec.sortOrder,
+            sortSpecs,
         });
     }, [
         locale,
@@ -314,8 +333,10 @@ export const useOnSortTable = ({ locale, sharedStringRegistry, createHistory, en
         onChangeSheetData,
         onChangeTables,
         getActiveCell,
+        getCellData,
         getDependents,
         isHiddenRow,
+        isManuallyHiddenRow,
         getFrozenRowCount,
         getSheetName,
         getEffectiveFormat,

package/dist/esm/hooks/use-on-subtotal.d.ts

@@ -12,6 +12,12 @@ export type UseOnSubtotalProps = {
     onChangeBatch: (sheetId: number, ranges: GridRange, values: (string | null)[][]) => void;
     onGroupRows: SubtotalPlanExecutor["onGroupRows"];
     onUngroupRows: SubtotalPlanExecutor["onUngroupRows"];
+    /**
+     * `useUndoRedo`'s `batchHistory`: runs the plan's inserts, writes and
+     * groupings as ONE undo entry (Excel undoes a Subtotal in one step). Without
+     * it every step records its own entry.
+     */
+    batchHistory?: <R>(action: () => R) => R;
 };
 /**
  * Excel's Data → Outline → Subtotal, composed over the existing row
@@ -19,8 +25,9 @@ export type UseOnSubtotalProps = {
  * through the same streamed commands (see `planSubtotals` for the layout).
  * Groups on the DISPLAYED value of the group column (Excel compares what the
  * cells show). "Replace current subtotals" also resets the range's outline
- * before regrouping, so re-applying keeps Excel's three levels. Returns the
- * applied plan, or `undefined` when the range is protected or has no data rows.
+ * before regrouping, so re-applying keeps Excel's three levels. The whole
+ * apply is one history entry when `batchHistory` is wired. Returns the applied
+ * plan, or `undefined` when the range is protected or has no data rows.
  */
-export declare const useOnSubtotal: ({ getEffectiveValue, getFormattedValue, getFormulaValue, getRowOutlineLevel, onDeleteRow, onInsertRow, onChangeBatch, onGroupRows, onUngroupRows, }: UseOnSubtotalProps) => (sheetId: number, options: SubtotalOptions) => SubtotalPlan | undefined;
+export declare const useOnSubtotal: ({ getEffectiveValue, getFormattedValue, getFormulaValue, getRowOutlineLevel, onDeleteRow, onInsertRow, onChangeBatch, onGroupRows, onUngroupRows, batchHistory, }: UseOnSubtotalProps) => (sheetId: number, options: SubtotalOptions) => SubtotalPlan | undefined;
 //# sourceMappingURL=use-on-subtotal.d.ts.map

package/dist/esm/hooks/use-on-subtotal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-on-subtotal.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-subtotal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAG5D,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEjE,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC;AAE9C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,eAAe,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAC1E,kBAAkB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAChF,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,aAAa,EAAE,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,KACxB,IAAI,CAAC;IACV,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,aAAa,EAAE,oBAAoB,CAAC,eAAe,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GAAI,qJAU3B,kBAAkB,eAIP,MAAM,WAAW,eAAe,KAAG,YAAY,GAAG,SAoC/D,CAAC"}
+{"version":3,"file":"use-on-subtotal.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-subtotal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAG5D,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEjE,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC;AAE9C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,eAAe,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAC1E,kBAAkB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAChF,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,aAAa,EAAE,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,KACxB,IAAI,CAAC;IACV,WAAW,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,aAAa,EAAE,oBAAoB,CAAC,eAAe,CAAC,CAAC;IACrD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAI,mKAW3B,kBAAkB,eAIP,MAAM,WAAW,eAAe,KAAG,YAAY,GAAG,SAuC/D,CAAC"}

package/dist/esm/hooks/use-on-subtotal.js

@@ -7,10 +7,11 @@ import { useCanEditCellRange } from "./use-can-edit-cellrange";
  * through the same streamed commands (see `planSubtotals` for the layout).
  * Groups on the DISPLAYED value of the group column (Excel compares what the
  * cells show). "Replace current subtotals" also resets the range's outline
- * before regrouping, so re-applying keeps Excel's three levels. Returns the
- * applied plan, or `undefined` when the range is protected or has no data rows.
+ * before regrouping, so re-applying keeps Excel's three levels. The whole
+ * apply is one history entry when `batchHistory` is wired. Returns the applied
+ * plan, or `undefined` when the range is protected or has no data rows.
  */
-export const useOnSubtotal = ({ getEffectiveValue, getFormattedValue, getFormulaValue, getRowOutlineLevel, onDeleteRow, onInsertRow, onChangeBatch, onGroupRows, onUngroupRows, }) => {
+export const useOnSubtotal = ({ getEffectiveValue, getFormattedValue, getFormulaValue, getRowOutlineLevel, onDeleteRow, onInsertRow, onChangeBatch, onGroupRows, onUngroupRows, batchHistory = (action) => action(), }) => {
     const canEditCellRange = useCanEditCellRange();
     return useCallback((sheetId, options) => {
         if (!canEditCellRange(sheetId, options.range)) {
@@ -25,15 +26,16 @@ export const useOnSubtotal = ({ getEffectiveValue, getFormattedValue, getFormula
         });
         if (!plan)
             return undefined;
-        applySubtotalPlan(sheetId, plan, {
+        batchHistory(() => applySubtotalPlan(sheetId, plan, {
             onDeleteRow,
             onInsertRow,
             onChangeBatch,
             onGroupRows,
             onUngroupRows,
-        });
+        }));
         return plan;
     }, [
+        batchHistory,
         canEditCellRange,
         getEffectiveValue,
         getFormattedValue,

package/dist/esm/hooks/use-on-table.d.ts

@@ -1,15 +1,28 @@
+import type { CellFormat, GridRange } from "@rowsncolumns/common-types";
 import type { CellInterface, Direction, SelectionArea } from "@rowsncolumns/grid";
-import type { BandedDefinition, CanvasGridMethods, CellData, FilterView, SelectionAttributes, Sheet, SpreadsheetTheme, TableTheme, TableView } from "@rowsncolumns/spreadsheet";
+import type { BandedDefinition, CanvasGridMethods, CellData, CreateTableOptions, FilterView, NamedRange, SelectionAttributes, Sheet, SpreadsheetTheme, TableTheme, TableView } from "@rowsncolumns/spreadsheet";
 import type { OnCommand } from "../commands";
 import type { GeneratedNames } from "../generated-names";
-import type { CellXfsRegistry } from "./use-cellxfs-registry";
-import type { SharedStringRegistry } from "./use-ss-registry";
 import type { useCalculation } from "./use-calculation";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
 import type { useSheetProperties } from "./use-sheet-properties";
-import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SheetData, UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SharedStringRegistry } from "./use-ss-registry";
 import type { SpreadsheetPatch } from "./use-undo-redo";
 export type UseOnTableProps<T extends CellData, S extends Sheet> = {
     locale?: string;
+    /**
+     * `useUndoRedo`'s `batchHistory`: a create with "My table has headers" unchecked inserts the
+     * header row and defines the table as ONE undo entry when this is wired.
+     */
+    batchHistory?: <R>(action: () => R) => R;
+    /** Current document facets, read by the header-row insert's Excel refusal guard and its shift. */
+    sheetData?: SheetData<T>;
+    sheets?: S[];
+    getActiveCell?: () => CellInterface;
+    getSelections?: () => SelectionArea<SelectionAttributes>[];
+    onChangeCitations?: UseSpreadsheetProps<T, S>["onChangeCitations"];
+    onChangeCharts?: UseSpreadsheetProps<T, S>["onChangeCharts"];
     cellXfsRegistry?: CellXfsRegistry;
     sharedStringRegistry?: SharedStringRegistry;
     theme: SpreadsheetTheme;
@@ -23,12 +36,21 @@ export type UseOnTableProps<T extends CellData, S extends Sheet> = {
     rowCount: number;
     columnCount: number;
     tables?: TableView[];
+    /** The workbook's defined names — a table may not take one of them (Excel's single namespace). */
+    namedRanges?: NamedRange[];
     basicFilter?: FilterView | null;
     /**
      * Id creation strategy
      */
     idCreationStrategy?: UseSpreadsheetProps["idCreationStrategy"];
     getDependents: ReturnType<typeof useCalculation>["getDependents"];
+    /** Formula cells to sweep when a table is renamed or converted to a range; without it the sheet data is swept. */
+    getGraphNodes?: ReturnType<typeof useCalculation>["getGraphNodes"];
+    /**
+     * The banded (table stripe) formats the grid paints on a sheet — baked into the cells when a
+     * table is converted to a range, as the format painter captures them.
+     */
+    getBandedCells?: (sheetId: number) => Map<string, CellFormat> | undefined;
     getEffectiveValue: ReturnType<typeof useSheetProperties>["getEffectiveValue"];
     getFormattedValue: ReturnType<typeof useSheetProperties>["getFormattedValue"];
     onRequestCalculate: ReturnType<typeof useCalculation>["onRequestCalculate"];
@@ -36,13 +58,23 @@ export type UseOnTableProps<T extends CellData, S extends Sheet> = {
     getSheetName(sheetId: number): string;
     onCommand?: OnCommand;
     generatedNames?: GeneratedNames;
+    /**
+     * Read with `sheetData` / `sheets` when Total Row is switched on with data
+     * directly below the table: the occupied row is shifted down (Excel inserts
+     * a row), or the toggle is refused with Excel's message when that shift
+     * would tear another table, a merge or an array. Without `sheetData` the
+     * totals row is written in place as before.
+     */
+    getArrayRanges?: (sheetId: number) => GridRange[] | undefined;
+    onChangeDataValidations?: UseSpreadsheetProps<T, S>["onChangeDataValidations"];
+    onChangeConditionalFormats?: UseSpreadsheetProps<T, S>["onChangeConditionalFormats"];
 };
-export declare const useOnTable: <T extends CellData, S extends Sheet>({ locale, cellXfsRegistry, sharedStringRegistry, rowCount, columnCount, tables, basicFilter, theme: spreadsheetTheme, idCreationStrategy, enqueueCalculation, enqueueStructureChange, createHistory, onChangeSheets, onChangeTables, onChangeSheetData, getFormattedValue, getEffectiveValue, onRequestCalculate, getDependents, enqueueGraphOperation, getContentfulRangeAroundCell, getSheetName, onCommand, generatedNames, }: UseOnTableProps<T, S>) => {
-    onCreateTable: (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[], tableSpec?: Partial<TableView>, theme?: TableTheme, bandedRange?: BandedDefinition) => void;
+export declare const useOnTable: <T extends CellData, S extends Sheet>({ locale, batchHistory, sheetData, sheets, getActiveCell, getSelections, onChangeCitations, onChangeCharts, cellXfsRegistry, sharedStringRegistry, rowCount, columnCount, tables, namedRanges, basicFilter, theme: spreadsheetTheme, idCreationStrategy, enqueueCalculation, enqueueStructureChange, createHistory, onChangeSheets, onChangeTables, onChangeSheetData, getFormattedValue, getEffectiveValue, onRequestCalculate, getDependents, getGraphNodes, getBandedCells, enqueueGraphOperation, getContentfulRangeAroundCell, getSheetName, onCommand, generatedNames, getArrayRanges, onChangeDataValidations, onChangeConditionalFormats, }: UseOnTableProps<T, S>) => {
+    onCreateTable: (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[], tableSpec?: Partial<TableView>, theme?: TableTheme, bandedRange?: BandedDefinition, options?: CreateTableOptions) => void;
     onRemoveTable: (tableView: TableView) => void;
     onUpdateTable: (sheetId: number, tableId: TableView["id"], updatedTable: Partial<TableView>) => void;
     onCreateBasicFilter: (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[], basicFilterSpec?: Partial<FilterView>) => void;
-    onInsertTableColumn: (tableView: TableView, dimensionIndex: number, direction: Direction.Left | Direction.Right) => void;
+    onInsertTableColumn: (tableView: TableView, dimensionIndex: number, direction: Direction.Left | Direction.Right, count?: number) => void;
     onDeleteTableColumn: (tableView: TableView, dimensionIndex: number) => void;
 };
 export { addTableColumn } from "../interface/table-utils";

package/dist/esm/hooks/use-on-table.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-on-table.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EACT,aAAa,EACd,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAEjB,QAAQ,EACR,UAAU,EACV,mBAAmB,EACnB,KAAK,EACL,gBAAgB,EAChB,UAAU,EACV,SAAS,EACV,MAAM,2BAA2B,CAAC;AAKnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAazD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,KAAK,EAAE,gBAAgB,CAAC;IACxB,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAClE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACzD,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,sBAAsB,CAAC,EAAE,UAAU,CACjC,OAAO,cAAc,CACtB,CAAC,wBAAwB,CAAC,CAAC;IAC5B,qBAAqB,EAAE,UAAU,CAC/B,OAAO,cAAc,CACtB,CAAC,uBAAuB,CAAC,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAChC;;OAEG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAC/D,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,4BAA4B,EAAE,iBAAiB,CAAC,kCAAkC,CAAC,CAAC;IACpF,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,kaAyB7D,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;6BAOT,MAAM,cACH,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,cACpC,OAAO,CAAC,SAAS,CAAC,UACtB,UAAU,gBACJ,gBAAgB;+BA8FpB,SAAS;6BAwBV,MAAM,WACN,SAAS,CAAC,IAAI,CAAC,gBACV,OAAO,CAAC,SAAS,CAAC;;qCAqNrB,SAAS,kBACJ,MAAM,aACX,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK;qCA2DjC,SAAS,kBAAkB,MAAM;CA6DhD,CAAC;AACF,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"use-on-table.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EACT,aAAa,EACd,MAAM,oBAAoB,CAAC;AAO5B,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAEjB,QAAQ,EACR,kBAAkB,EAClB,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,KAAK,EACL,gBAAgB,EAChB,UAAU,EACV,SAAS,EACV,MAAM,2BAA2B,CAAC;AAenC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAmBzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,kGAAkG;IAClG,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,aAAa,CAAC;IACpC,aAAa,CAAC,EAAE,MAAM,aAAa,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC3D,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC7D,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,KAAK,EAAE,gBAAgB,CAAC;IACxB,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAClE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACzD,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,sBAAsB,CAAC,EAAE,UAAU,CACjC,OAAO,cAAc,CACtB,CAAC,wBAAwB,CAAC,CAAC;IAC5B,qBAAqB,EAAE,UAAU,CAC/B,OAAO,cAAc,CACtB,CAAC,uBAAuB,CAAC,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,kGAAkG;IAClG,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAChC;;OAEG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAC/D,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,kHAAkH;IAClH,aAAa,CAAC,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IACnE;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;IAC1E,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,iBAAiB,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC9E,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,4BAA4B,EAAE,iBAAiB,CAAC,kCAAkC,CAAC,CAAC;IACpF,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,GAAG,SAAS,CAAC;IAC9D,uBAAuB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC;IAC/E,0BAA0B,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC;CACtF,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,qnBAsC7D,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;6BAOT,MAAM,cACH,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,cACpC,OAAO,CAAC,SAAS,CAAC,UACtB,UAAU,gBACJ,gBAAgB,YACpB,kBAAkB;+BAuLlB,SAAS;6BAwCV,MAAM,WACN,SAAS,CAAC,IAAI,CAAC,gBACV,OAAO,CAAC,SAAS,CAAC;;qCA0UrB,SAAS,kBACJ,MAAM,aACX,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,UACnC,MAAM;qCAkEJ,SAAS,kBAAkB,MAAM;CAmEhD,CAAC;AACF,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC"}