@rowsncolumns/spreadsheet-state 29.0.0 → 29.1.0

package/dist/cjs/interface/table-totalrow.js

@@ -1,11 +1,15 @@
 import { __read, __values } from "tslib";
-import { isNil, isNumber } from "@rowsncolumns/utils";
+import { getTotalsRowFormula, isNil, isNumber } from "@rowsncolumns/utils";
 import { produceWithPatches } from "immer";
 import { createSheetCellIdentifier } from "../api/formula";
 import { createSheetDraft } from "../api/immer-utils";
 import { SheetCell } from "../sheet-cell";
 /**
- * Add a total row to a table.
+ * Add a total row to a table the way Excel does when Total Row is switched on:
+ * "Total" in the first column and ONE structured-reference `SUBTOTAL` in the
+ * last column — Sum (`109`) when that column's body is all numbers, Count
+ * (`103`) otherwise; every other totals cell stays blank. A single-column
+ * table gets the formula.
  *
  * Expects `updatedTable.range` to already include the total row, i.e.
  * `range.endRowIndex` is the row the totals are written to.
@@ -15,104 +19,134 @@ export var addTotalRow = function (_a) {
     return function (sheetId, updatedTable, saveHistory) {
         // We need to track this for history. Precedent cells
         var recalcCells = new Map();
-        /**
-         * 1. Validate number columns
-         * 2. Add Subtotal function
-         */
-        var numberColumnIndexes = [];
         var sheetCell = new SheetCell();
         var _a = updatedTable.range, startRowIndex = _a.startRowIndex, startColumnIndex = _a.startColumnIndex, endRowIndex = _a.endRowIndex, endColumnIndex = _a.endColumnIndex;
-        // Add total text
         var totalRowIndex = endRowIndex;
+        var bodyStartRowIndex = startRowIndex + (updatedTable.headerRow !== false ? 1 : 0);
         /**
          * Update sheet
          */
         onChangeSheetData === null || onChangeSheetData === void 0 ? void 0 : onChangeSheetData(function (prevSheetData) {
             var _a = __read(produceWithPatches(prevSheetData, function (draft) {
-                var e_1, _a;
-                var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-                // User is adding a total row
-                for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                var _a, _b, _c;
+                // Is every non-blank body cell of the column a number? Dates are
+                // stored as numbers, but summing them is meaningless.
+                var isNumericColumn = function (columnIndex) {
+                    var _a, _b, _c;
                     var values = [];
-                    var isDateColumn = false;
-                    for (var rowIndex = startRowIndex + (updatedTable.headerRow ? 1 : 0); rowIndex < totalRowIndex; rowIndex++) {
-                        var cellData = (_d = (_c = (_b = draft[sheetId]) === null || _b === void 0 ? void 0 : _b[rowIndex]) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d[columnIndex];
-                        sheetCell.assign(sheetId, {
-                            rowIndex: rowIndex,
-                            columnIndex: columnIndex,
-                        }, cellData, { locale: locale });
-                        var effectiveValue = sheetCell.getEffectiveValue();
+                    for (var rowIndex = bodyStartRowIndex; rowIndex < totalRowIndex; rowIndex++) {
+                        var cellData = (_c = (_b = (_a = draft[sheetId]) === null || _a === void 0 ? void 0 : _a[rowIndex]) === null || _b === void 0 ? void 0 : _b.values) === null || _c === void 0 ? void 0 : _c[columnIndex];
+                        sheetCell.assign(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, cellData, {
+                            locale: locale,
+                        });
                         var numberFormat = sheetCell.getNumberFormat();
-                        // Dates are stored as numbers, but summing them is meaningless
                         if ((numberFormat === null || numberFormat === void 0 ? void 0 : numberFormat.type) === "DATE" ||
                             (numberFormat === null || numberFormat === void 0 ? void 0 : numberFormat.type) === "DATE_TIME") {
-                            isDateColumn = true;
-                            break;
+                            return false;
                         }
+                        var effectiveValue = sheetCell.getEffectiveValue();
                         if (!isNil(effectiveValue)) {
                             values.push(effectiveValue);
                         }
                     }
-                    if (!isDateColumn && values.length && values.every(isNumber)) {
-                        numberColumnIndexes.push(columnIndex);
-                    }
+                    return values.length > 0 && values.every(isNumber);
+                };
+                var currentSheet = createSheetDraft(draft, sheetId, totalRowIndex);
+                var writeTotalCell = function (columnIndex, value) {
+                    var _a, _b;
+                    sheetCell.assign(sheetId, { rowIndex: totalRowIndex, columnIndex: columnIndex }, (_b = (_a = currentSheet[totalRowIndex]) === null || _a === void 0 ? void 0 : _a.values) === null || _b === void 0 ? void 0 : _b[columnIndex], { locale: locale });
+                    sheetCell.setUserEnteredValue(value);
+                    // The totals row's bold and top rule come from the table style's
+                    // `totalRow` band, not from an explicit cell format.
+                    currentSheet[totalRowIndex].values[columnIndex] =
+                        sheetCell.getCellData();
+                };
+                var writeTotalFormula = function (columnIndex, formula) {
+                    writeTotalCell(columnIndex, formula);
+                    var position = { rowIndex: totalRowIndex, columnIndex: columnIndex, sheetId: sheetId };
+                    enqueueCalculation({ type: "add", position: position });
+                    recalcCells.set(createSheetCellIdentifier(sheetId, totalRowIndex, columnIndex), position);
+                };
+                // A column with a recorded `totalsRowFunction` (the totals dropdown's
+                // choice, kept across toggles) regenerates that; the others take
+                // Excel's defaults below.
+                var recorded = new Set();
+                for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                    var column = (_a = updatedTable.columns) === null || _a === void 0 ? void 0 : _a[columnIndex - startColumnIndex];
+                    var fn = column === null || column === void 0 ? void 0 : column.totalsRowFunction;
+                    if (!fn)
+                        continue;
+                    recorded.add(columnIndex);
+                    var formula = (column === null || column === void 0 ? void 0 : column.name)
+                        ? getTotalsRowFormula(fn, updatedTable.title, column.name)
+                        : undefined;
+                    if (formula)
+                        writeTotalFormula(columnIndex, formula);
+                }
+                var lastColumnName = (_c = (_b = updatedTable.columns) === null || _b === void 0 ? void 0 : _b[endColumnIndex - startColumnIndex]) === null || _c === void 0 ? void 0 : _c.name;
+                var lastColumnFormula = lastColumnName && !recorded.has(endColumnIndex)
+                    ? getTotalsRowFormula(isNumericColumn(endColumnIndex) ? "sum" : "count", updatedTable.title, lastColumnName)
+                    : undefined;
+                // The total label owns the first column unless the formula needs it
+                // (single-column table).
+                if (!recorded.has(startColumnIndex) &&
+                    (endColumnIndex > startColumnIndex || !lastColumnFormula)) {
+                    writeTotalCell(startColumnIndex, "Total");
                 }
+                if (lastColumnFormula) {
+                    writeTotalFormula(endColumnIndex, lastColumnFormula);
+                }
+            }), 3), nextState = _a[0], patches = _a[1], inversePatches = _a[2];
+            saveHistory({
+                sheetData: { patches: patches, inversePatches: inversePatches },
+                recalcCells: { undo: recalcCells, redo: recalcCells },
+            });
+            return nextState;
+        });
+    };
+};
+/**
+ * Rewrite the totals-row cells of `columnIndexes` from their column's recorded
+ * `totalsRowFunction` (the totals dropdown's choice): a function writes its
+ * structured `SUBTOTAL`, `none` (or no name to reference) clears the cell.
+ *
+ * Expects `table.range` to include the total row (`range.endRowIndex`).
+ */
+export var setTotalRowFunctions = function (_a) {
+    var locale = _a.locale, onChangeSheetData = _a.onChangeSheetData, enqueueCalculation = _a.enqueueCalculation;
+    return function (sheetId, table, columnIndexes, saveHistory) {
+        var recalcCells = new Map();
+        var sheetCell = new SheetCell();
+        var totalRowIndex = table.range.endRowIndex;
+        onChangeSheetData === null || onChangeSheetData === void 0 ? void 0 : onChangeSheetData(function (prevSheetData) {
+            var _a = __read(produceWithPatches(prevSheetData, function (draft) {
+                var e_1, _a;
+                var _b, _c, _d;
                 var currentSheet = createSheetDraft(draft, sheetId, totalRowIndex);
-                sheetCell.assign(sheetId, {
-                    rowIndex: totalRowIndex,
-                    columnIndex: startColumnIndex,
-                }, (_f = (_e = currentSheet[totalRowIndex]) === null || _e === void 0 ? void 0 : _e.values) === null || _f === void 0 ? void 0 : _f[startColumnIndex], { locale: locale });
-                // Add total text
-                sheetCell.setUserEnteredValue("Total");
-                // Bold, can be overridden by user
-                sheetCell.setUserEnteredFormat("textFormat", {
-                    bold: true,
-                });
-                // Set cell data
-                currentSheet[totalRowIndex].values[startColumnIndex] =
-                    sheetCell.getCellData();
                 try {
-                    // Add subtotal
-                    for (var numberColumnIndexes_1 = __values(numberColumnIndexes), numberColumnIndexes_1_1 = numberColumnIndexes_1.next(); !numberColumnIndexes_1_1.done; numberColumnIndexes_1_1 = numberColumnIndexes_1.next()) {
-                        var columnIndex = numberColumnIndexes_1_1.value;
-                        // The total label owns the first column
-                        if (columnIndex === startColumnIndex) {
-                            continue;
-                        }
-                        var rowIndex = totalRowIndex;
-                        var cellData = (_j = (_h = (_g = draft[sheetId]) === null || _g === void 0 ? void 0 : _g[rowIndex]) === null || _h === void 0 ? void 0 : _h.values) === null || _j === void 0 ? void 0 : _j[columnIndex];
-                        sheetCell.assign(sheetId, {
-                            columnIndex: columnIndex,
-                            rowIndex: rowIndex,
-                        }, cellData, { locale: locale });
-                        var columnName = (_l = (_k = updatedTable.columns) === null || _k === void 0 ? void 0 : _k[columnIndex - startColumnIndex]) === null || _l === void 0 ? void 0 : _l.name;
-                        if (columnName) {
-                            sheetCell.setUserEnteredValue("=SUBTOTAL(109, [".concat(columnName, "])"));
+                    for (var columnIndexes_1 = __values(columnIndexes), columnIndexes_1_1 = columnIndexes_1.next(); !columnIndexes_1_1.done; columnIndexes_1_1 = columnIndexes_1.next()) {
+                        var columnIndex = columnIndexes_1_1.value;
+                        var column = (_b = table.columns) === null || _b === void 0 ? void 0 : _b[columnIndex - table.range.startColumnIndex];
+                        var formula = (column === null || column === void 0 ? void 0 : column.totalsRowFunction) && column.name
+                            ? getTotalsRowFormula(column.totalsRowFunction, table.title, column.name)
+                            : undefined;
+                        sheetCell.assign(sheetId, { rowIndex: totalRowIndex, columnIndex: columnIndex }, formula ? (_d = (_c = currentSheet[totalRowIndex]) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d[columnIndex] : undefined, { locale: locale });
+                        if (formula) {
+                            sheetCell.setUserEnteredValue(formula);
                             // Bold, can be overridden by user
-                            sheetCell.setUserEnteredFormat("textFormat", {
-                                bold: true,
-                            });
-                            // Set cell data
-                            currentSheet[totalRowIndex].values[columnIndex] =
-                                sheetCell.getCellData();
-                            var position = {
-                                rowIndex: rowIndex,
-                                columnIndex: columnIndex,
-                                sheetId: sheetId,
-                            };
-                            enqueueCalculation({
-                                type: "add",
-                                position: position,
-                            });
-                            // Add sheet id
-                            recalcCells.set(createSheetCellIdentifier(sheetId, rowIndex, columnIndex), position);
+                            sheetCell.setUserEnteredFormat("textFormat", { bold: true });
                         }
+                        currentSheet[totalRowIndex].values[columnIndex] =
+                            sheetCell.getCellData();
+                        var position = { rowIndex: totalRowIndex, columnIndex: columnIndex, sheetId: sheetId };
+                        enqueueCalculation({ type: "add", position: position });
+                        recalcCells.set(createSheetCellIdentifier(sheetId, totalRowIndex, columnIndex), position);
                     }
                 }
                 catch (e_1_1) { e_1 = { error: e_1_1 }; }
                 finally {
                     try {
-                        if (numberColumnIndexes_1_1 && !numberColumnIndexes_1_1.done && (_a = numberColumnIndexes_1.return)) _a.call(numberColumnIndexes_1);
+                        if (columnIndexes_1_1 && !columnIndexes_1_1.done && (_a = columnIndexes_1.return)) _a.call(columnIndexes_1);
                     }
                     finally { if (e_1) throw e_1.error; }
                 }

package/dist/cjs/interface/table-utils.d.ts

@@ -1,21 +1,74 @@
-import type { GridRange } from "@rowsncolumns/common-types";
-import type { CellData, TableView } from "@rowsncolumns/spreadsheet";
+import type { GridRange, SelectionArea } from "@rowsncolumns/common-types";
+import type { CellData, Column, TableView } from "@rowsncolumns/spreadsheet";
 import type { Draft } from "immer";
 import type { GeneratedNames } from "../generated-names";
+import type { SheetData } from "../hooks/use-spreadsheet-state";
+/**
+ * Does any cell of `rowIndex` within a table's columns hold a value or formula?
+ * Decides whether switching Total Row on must first shift the row below the
+ * table down (Excel inserts a row rather than overwrite data).
+ */
+export declare const tableRowHasContent: <T extends CellData>(rows: SheetData<T>[number] | undefined, rowIndex: number, startColumnIndex: number, endColumnIndex: number) => boolean;
+/**
+ * Excel's Header Row → ON re-adds the header ABOVE the data when the row above the table is free:
+ * it exists, holds no value or formula in the table's columns, and belongs to no other table.
+ * Otherwise the first data row becomes the header row in place.
+ */
+export declare const tableHeaderRowAboveIsFree: <T extends CellData>({ sheetId, table, sheetData, tables, }: {
+    sheetId: number;
+    table: TableView;
+    sheetData: SheetData<T> | undefined;
+    tables: TableView[] | undefined;
+}) => boolean;
 export declare const rangesOverlap: (a: GridRange, b: GridRange) => boolean;
 export declare const tableWouldOverlap: (candidate: {
     sheetId: number;
     range: GridRange;
     id?: TableView["id"];
 }, existing: TableView[] | undefined) => boolean;
-type AddTableColumnOptions<T extends CellData> = {
+/**
+ * Excel: a table's header names are unique, compared case-insensitively — a duplicate takes the
+ * next free numeric suffix (`Name`, `Name2`, `Name3`).
+ */
+export declare const getUniqueTableColumnName: (name: string, taken: Iterable<string>) => string;
+type TableHeaderNamesOptions = {
     sheetId: number;
-    draft: Draft<any>;
     range: GridRange;
     getFormattedValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | null | undefined;
-    locale?: string;
     generatedNames?: GeneratedNames;
+    /** Columns the table already names, by position — kept as they are; only the rest are derived. */
+    columns?: (Column | undefined)[] | null;
 };
-export declare const addTableColumn: <T extends CellData>({ draft, sheetId, range, getFormattedValue, locale, generatedNames, }: AddTableColumnOptions<T>) => void;
+/**
+ * The header names a table takes over `range` (Excel): a column the table already names keeps
+ * that name; every other column takes its header cell's display text, de-duplicated against the
+ * names before it (`Name`, `Name2`, …), and a blank header cell takes the first free `ColumnN`.
+ */
+export declare const getTableHeaderNames: ({ sheetId, range, getFormattedValue, generatedNames, columns, }: TableHeaderNamesOptions) => string[];
+type AddTableColumnOptions<T extends CellData> = TableHeaderNamesOptions & {
+    draft: Draft<any>;
+    locale?: string;
+};
+/**
+ * Write a table's header row: every header cell holds its column's name as TEXT (Excel stores
+ * headers as text — a `2024` header becomes the string "2024"), so a blank, numeric, formula or
+ * de-duplicated header cell is (re)written; a text cell already reading its name is left alone.
+ * The names come from {@link getTableHeaderNames}, so the table's `columns` and its cells agree.
+ */
+export declare const addTableColumn: <T extends CellData>({ draft, sheetId, range, getFormattedValue, locale, generatedNames, columns, }: AddTableColumnOptions<T>) => string[];
+export type TableHeaderRefill = {
+    tableId: TableView["id"];
+    rowIndex: number;
+    columnIndex: number;
+    /** Position of the header within `table.columns`. */
+    dimensionIndex: number;
+    name: string;
+};
+export declare const getTableHeaderRefills: ({ sheetId, tables, selections, generatedNames, }: {
+    sheetId: number;
+    tables: TableView[] | undefined;
+    selections: Pick<SelectionArea, "range">[];
+    generatedNames?: GeneratedNames;
+}) => TableHeaderRefill[];
 export {};
 //# sourceMappingURL=table-utils.d.ts.map

package/dist/cjs/interface/table-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"table-utils.d.ts","sourceRoot":"","sources":["../../../interface/table-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAU,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAOzD,eAAO,MAAM,aAAa,GAAI,GAAG,SAAS,EAAE,GAAG,SAAS,KAAG,OAMxD,CAAC;AAEJ,eAAO,MAAM,iBAAiB,GAC5B,WAAW;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,CAAC;IAAC,EAAE,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;CAAE,EACtE,UAAU,SAAS,EAAE,GAAG,SAAS,KAChC,OAQF,CAAC;AAEF,KAAK,qBAAqB,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,iBAAiB,EAAE,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,QAAQ,EAAE,uEAOhD,qBAAqB,CAAC,CAAC,CAAC,SAoC1B,CAAC"}
+{"version":3,"file":"table-utils.d.ts","sourceRoot":"","sources":["../../../interface/table-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE7E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAGhE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,QAAQ,EACnD,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,EACtC,UAAU,MAAM,EAChB,kBAAkB,MAAM,EACxB,gBAAgB,MAAM,KACrB,OAUF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,QAAQ,EAAE,wCAK3D;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACpC,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;CACjC,KAAG,OAqBH,CAAC;AAKF,eAAO,MAAM,aAAa,GAAI,GAAG,SAAS,EAAE,GAAG,SAAS,KAAG,OAMxD,CAAC;AAEJ,eAAO,MAAM,iBAAiB,GAC5B,WAAW;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,CAAC;IAAC,EAAE,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;CAAE,EACtE,UAAU,SAAS,EAAE,GAAG,SAAS,KAChC,OAQF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GACnC,MAAM,MAAM,EACZ,OAAO,QAAQ,CAAC,MAAM,CAAC,KACtB,MAaF,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,iBAAiB,EAAE,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,kGAAkG;IAClG,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,iEAMjC,uBAAuB,KAAG,MAAM,EA2BlC,CAAC;AAEF,KAAK,qBAAqB,CAAC,CAAC,SAAS,QAAQ,IAAI,uBAAuB,GAAG;IACzE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AA6BF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,QAAQ,EAAE,gFAQhD,qBAAqB,CAAC,CAAC,CAAC,aAyC1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAMF,eAAO,MAAM,qBAAqB,GAAI,kDAKnC;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAChC,UAAU,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE,CAAC;IAC3C,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,KAAG,iBAAiB,EAuCpB,CAAC"}

package/dist/cjs/interface/table-utils.js

@@ -1,6 +1,45 @@
+import { __assign, __read, __spreadArray, __values } from "tslib";
+import { getCellUserEnteredValue } from "@rowsncolumns/utils";
 import { createSheetDraft } from "../api/immer-utils";
 import { getNextTableColumnName } from "../helpers";
 import { SheetCell } from "../sheet-cell";
+/**
+ * Does any cell of `rowIndex` within a table's columns hold a value or formula?
+ * Decides whether switching Total Row on must first shift the row below the
+ * table down (Excel inserts a row rather than overwrite data).
+ */
+export var tableRowHasContent = function (rows, rowIndex, startColumnIndex, endColumnIndex) {
+    var _a;
+    var values = (_a = rows === null || rows === void 0 ? void 0 : rows[rowIndex]) === null || _a === void 0 ? void 0 : _a.values;
+    if (!values)
+        return false;
+    for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+        var ue = getCellUserEnteredValue(values[columnIndex]);
+        if (ue && Object.values(ue).some(function (value) { return value !== undefined && value !== null; })) {
+            return true;
+        }
+    }
+    return false;
+};
+/**
+ * Excel's Header Row → ON re-adds the header ABOVE the data when the row above the table is free:
+ * it exists, holds no value or formula in the table's columns, and belongs to no other table.
+ * Otherwise the first data row becomes the header row in place.
+ */
+export var tableHeaderRowAboveIsFree = function (_a) {
+    var sheetId = _a.sheetId, table = _a.table, sheetData = _a.sheetData, tables = _a.tables;
+    var rowIndex = table.range.startRowIndex - 1;
+    if (rowIndex < 1)
+        return false;
+    if (tableRowHasContent(sheetData === null || sheetData === void 0 ? void 0 : sheetData[sheetId], rowIndex, table.range.startColumnIndex, table.range.endColumnIndex)) {
+        return false;
+    }
+    return !tableWouldOverlap({
+        sheetId: sheetId,
+        id: table.id,
+        range: __assign(__assign({}, table.range), { startRowIndex: rowIndex, endRowIndex: rowIndex }),
+    }, tables);
+};
 // Excel rejects (recovers + drops) tables whose rectangles overlap on the same
 // sheet. Validate before mutating state so we never accumulate bad data that
 // later fails to export cleanly.
@@ -19,26 +58,183 @@ export var tableWouldOverlap = function (candidate, existing) {
             rangesOverlap(t.range, candidate.range);
     });
 };
+/**
+ * Excel: a table's header names are unique, compared case-insensitively — a duplicate takes the
+ * next free numeric suffix (`Name`, `Name2`, `Name3`).
+ */
+export var getUniqueTableColumnName = function (name, taken) {
+    var e_1, _a;
+    var lower = new Set();
+    try {
+        for (var taken_1 = __values(taken), taken_1_1 = taken_1.next(); !taken_1_1.done; taken_1_1 = taken_1.next()) {
+            var existing = taken_1_1.value;
+            lower.add(existing.toLowerCase());
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (taken_1_1 && !taken_1_1.done && (_a = taken_1.return)) _a.call(taken_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    if (!lower.has(name.toLowerCase())) {
+        return name;
+    }
+    var suffix = 2;
+    while (lower.has("".concat(name).concat(suffix).toLowerCase())) {
+        suffix++;
+    }
+    return "".concat(name).concat(suffix);
+};
+/**
+ * The header names a table takes over `range` (Excel): a column the table already names keeps
+ * that name; every other column takes its header cell's display text, de-duplicated against the
+ * names before it (`Name`, `Name2`, …), and a blank header cell takes the first free `ColumnN`.
+ */
+export var getTableHeaderNames = function (_a) {
+    var _b;
+    var sheetId = _a.sheetId, range = _a.range, getFormattedValue = _a.getFormattedValue, generatedNames = _a.generatedNames, columns = _a.columns;
+    var names = [];
+    var reserved = (columns !== null && columns !== void 0 ? columns : []).flatMap(function (column) {
+        return (column === null || column === void 0 ? void 0 : column.name) ? [{ name: column.name }] : [];
+    });
+    for (var columnIndex = range.startColumnIndex; columnIndex <= range.endColumnIndex; columnIndex++) {
+        var existing = (_b = columns === null || columns === void 0 ? void 0 : columns[columnIndex - range.startColumnIndex]) === null || _b === void 0 ? void 0 : _b.name;
+        if (existing) {
+            names.push(existing);
+            continue;
+        }
+        var text = getFormattedValue(sheetId, range.startRowIndex, columnIndex);
+        var taken = __spreadArray(__spreadArray([], __read(reserved), false), __read(names.map(function (name) { return ({ name: name }); })), false);
+        names.push(text
+            ? getUniqueTableColumnName(text, taken.map(function (column) { return column.name; }))
+            : getNextTableColumnName(taken, generatedNames));
+    }
+    return names;
+};
+/** True when the cell is plain text (not a number, boolean or formula) reading exactly `text`. */
+var isTextCellReading = function (cellData, text, formattedValue) {
+    if (!cellData) {
+        return false;
+    }
+    var ue = cellData.ue;
+    var typed = (ue === null || ue === void 0 ? void 0 : ue.fv) != null ||
+        (ue === null || ue === void 0 ? void 0 : ue.formulaValue) != null ||
+        (ue === null || ue === void 0 ? void 0 : ue.nv) != null ||
+        (ue === null || ue === void 0 ? void 0 : ue.numberValue) != null ||
+        (ue === null || ue === void 0 ? void 0 : ue.bv) != null ||
+        (ue === null || ue === void 0 ? void 0 : ue.boolValue) != null;
+    if (typed) {
+        return false;
+    }
+    return ((ue === null || ue === void 0 ? void 0 : ue.sv) === text ||
+        (ue === null || ue === void 0 ? void 0 : ue.stringValue) === text ||
+        (cellData.ss != null && formattedValue === text));
+};
+/**
+ * Write a table's header row: every header cell holds its column's name as TEXT (Excel stores
+ * headers as text — a `2024` header becomes the string "2024"), so a blank, numeric, formula or
+ * de-duplicated header cell is (re)written; a text cell already reading its name is left alone.
+ * The names come from {@link getTableHeaderNames}, so the table's `columns` and its cells agree.
+ */
 export var addTableColumn = function (_a) {
     var _b, _c, _d;
-    var draft = _a.draft, sheetId = _a.sheetId, range = _a.range, getFormattedValue = _a.getFormattedValue, locale = _a.locale, generatedNames = _a.generatedNames;
-    // Validate first row
-    var columns = [];
+    var draft = _a.draft, sheetId = _a.sheetId, range = _a.range, getFormattedValue = _a.getFormattedValue, locale = _a.locale, generatedNames = _a.generatedNames, columns = _a.columns;
+    var names = getTableHeaderNames({
+        sheetId: sheetId,
+        range: range,
+        getFormattedValue: getFormattedValue,
+        generatedNames: generatedNames,
+        columns: columns,
+    });
     var sheetCell = new SheetCell();
     var currentSheet = createSheetDraft(draft, sheetId, range.startRowIndex);
     for (var columnIndex = range.startColumnIndex; columnIndex <= range.endColumnIndex; columnIndex++) {
-        var formattedValue = getFormattedValue(sheetId, range.startRowIndex, columnIndex);
-        // Get table column name
-        var columnName = getNextTableColumnName(columns, generatedNames);
-        // Add name to empty header cell
-        if (!formattedValue) {
-            sheetCell.assign(sheetId, { rowIndex: range.startRowIndex, columnIndex: columnIndex }, (_d = (_c = (_b = draft === null || draft === void 0 ? void 0 : draft[sheetId]) === null || _b === void 0 ? void 0 : _b[range.startRowIndex]) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d[columnIndex], { locale: locale });
-            sheetCell.setUserEnteredValue(columnName);
-            currentSheet[range.startRowIndex].values[columnIndex] =
-                sheetCell.getCellData();
-        }
-        columns.push({
-            name: formattedValue || columnName,
+        var name_1 = names[columnIndex - range.startColumnIndex];
+        var cellData = (_d = (_c = (_b = draft === null || draft === void 0 ? void 0 : draft[sheetId]) === null || _b === void 0 ? void 0 : _b[range.startRowIndex]) === null || _c === void 0 ? void 0 : _c.values) === null || _d === void 0 ? void 0 : _d[columnIndex];
+        if (isTextCellReading(cellData, name_1, getFormattedValue(sheetId, range.startRowIndex, columnIndex))) {
+            continue;
+        }
+        sheetCell.assign(sheetId, { rowIndex: range.startRowIndex, columnIndex: columnIndex }, cellData, { locale: locale });
+        sheetCell.setUserEnteredValue(name_1, undefined, {
+            disableTypeInference: true,
         });
+        currentSheet[range.startRowIndex].values[columnIndex] =
+            sheetCell.getCellData();
+    }
+    return names;
+};
+// Excel keeps a table under Delete / Clear contents: the cells empty out but
+// the table stays, and a cleared header cell falls back to the first free
+// generic `ColumnN` name — a table column is never nameless. Names the table
+// still uses (uncleared headers) stay reserved so the refills never collide.
+export var getTableHeaderRefills = function (_a) {
+    var e_2, _b;
+    var _c;
+    var sheetId = _a.sheetId, tables = _a.tables, selections = _a.selections, generatedNames = _a.generatedNames;
+    var refills = [];
+    var _loop_1 = function (table) {
+        var e_3, _f, e_4, _g;
+        if (table.sheetId !== sheetId || table.headerRow === false)
+            return "continue";
+        var _h = table.range, rowIndex = _h.startRowIndex, startColumnIndex = _h.startColumnIndex, endColumnIndex = _h.endColumnIndex;
+        var cleared = new Set();
+        try {
+            for (var selections_1 = (e_3 = void 0, __values(selections)), selections_1_1 = selections_1.next(); !selections_1_1.done; selections_1_1 = selections_1.next()) {
+                var range = selections_1_1.value.range;
+                if (rowIndex < range.startRowIndex || rowIndex > range.endRowIndex) {
+                    continue;
+                }
+                for (var columnIndex = Math.max(startColumnIndex, range.startColumnIndex); columnIndex <= Math.min(endColumnIndex, range.endColumnIndex); columnIndex++) {
+                    cleared.add(columnIndex);
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (selections_1_1 && !selections_1_1.done && (_f = selections_1.return)) _f.call(selections_1);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
+        if (!cleared.size)
+            return "continue";
+        var columns = ((_c = table.columns) !== null && _c !== void 0 ? _c : []).filter(function (_, dimensionIndex) { return !cleared.has(startColumnIndex + dimensionIndex); });
+        try {
+            for (var _j = (e_4 = void 0, __values(__spreadArray([], __read(cleared), false).sort(function (a, b) { return a - b; }))), _k = _j.next(); !_k.done; _k = _j.next()) {
+                var columnIndex = _k.value;
+                var name_2 = getNextTableColumnName(columns, generatedNames);
+                columns.push({ name: name_2 });
+                refills.push({
+                    tableId: table.id,
+                    rowIndex: rowIndex,
+                    columnIndex: columnIndex,
+                    dimensionIndex: columnIndex - startColumnIndex,
+                    name: name_2,
+                });
+            }
+        }
+        catch (e_4_1) { e_4 = { error: e_4_1 }; }
+        finally {
+            try {
+                if (_k && !_k.done && (_g = _j.return)) _g.call(_j);
+            }
+            finally { if (e_4) throw e_4.error; }
+        }
+    };
+    try {
+        for (var _d = __values(tables !== null && tables !== void 0 ? tables : []), _e = _d.next(); !_e.done; _e = _d.next()) {
+            var table = _e.value;
+            _loop_1(table);
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_e && !_e.done && (_b = _d.return)) _b.call(_d);
+        }
+        finally { if (e_2) throw e_2.error; }
     }
+    return refills;
 };

package/dist/cjs/interface/update-table.d.ts

@@ -1,4 +1,19 @@
+import type { GridRange } from "@rowsncolumns/common-types";
 import type { CellData, Sheet, TableView } from "@rowsncolumns/spreadsheet";
 import type { UseOnTableProps } from "../hooks/use-on-table";
-export declare const updateTable: <T extends CellData, S extends Sheet>({ locale, tables, enqueueCalculation, createHistory, onChangeTables, onChangeSheetData, getFormattedValue, getDependents, generatedNames, }: Pick<UseOnTableProps<T, S>, "locale" | "tables" | "enqueueCalculation" | "getDependents" | "createHistory" | "onChangeTables" | "onChangeSheetData" | "getFormattedValue" | "generatedNames">) => (sheetId: number, tableId: TableView["id"], updatedTable: Partial<TableView>) => void;
+/**
+ * The range an update gives `table`: an explicit range that differs from the current one is taken
+ * as is (Excel's Resize Table — the dialog's range wins, whatever toggles ride along); else the
+ * current range grown by one row when the update turns the total row on and shrunk by one when it
+ * turns it off, with the header row toggle moving the top edge (Excel): OFF drops the header row
+ * out of the table (the range starts one row lower — never past the last data row), ON re-adds a
+ * header row ABOVE the data when `headerRowAboveIsFree` (see `tableHeaderRowAboveIsFree`), else
+ * the first data row becomes the header in place. Same rule as the rnc engine's
+ * `table_spec_range`. The hook's refusal guard and the update itself must agree on it, so both
+ * resolve it here.
+ */
+export declare const resolveUpdatedTableRange: (table: TableView, updatedTable: Partial<TableView>, { headerRowAboveIsFree }?: {
+    headerRowAboveIsFree?: boolean;
+}) => GridRange;
+export declare const updateTable: <T extends CellData, S extends Sheet>({ locale, tables, namedRanges, enqueueCalculation, enqueueGraphOperation, getGraphNodes, createHistory, onChangeTables, onChangeSheetData, getFormattedValue, getDependents, generatedNames, sheetData, rowCount, columnCount, cellXfsRegistry, sharedStringRegistry, getSheetName, getActiveCell, enqueueStructureChange, onChangeSheets, onChangeDataValidations, onChangeConditionalFormats, }: Pick<UseOnTableProps<T, S>, "locale" | "tables" | "namedRanges" | "enqueueCalculation" | "getDependents" | "createHistory" | "onChangeTables" | "onChangeSheetData" | "getFormattedValue" | "generatedNames" | "sheetData" | "rowCount" | "columnCount" | "cellXfsRegistry" | "sharedStringRegistry" | "getSheetName" | "getActiveCell" | "enqueueGraphOperation" | "enqueueStructureChange" | "onChangeSheets" | "onChangeDataValidations" | "onChangeConditionalFormats"> & Partial<Pick<UseOnTableProps<T, S>, "getGraphNodes">>) => (sheetId: number, tableId: TableView["id"], updatedTable: Partial<TableView>) => void;
 //# sourceMappingURL=update-table.d.ts.map

package/dist/cjs/interface/update-table.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-table.d.ts","sourceRoot":"","sources":["../../../interface/update-table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAI5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAK7D,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,6IAU9D,IAAI,CACL,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EACnB,QAAQ,GACR,QAAQ,GACR,oBAAoB,GACpB,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,CACnB,MAEG,SAAS,MAAM,EACf,SAAS,SAAS,CAAC,IAAI,CAAC,EACxB,cAAc,OAAO,CAAC,SAAS,CAAC,SA0JnC,CAAC"}
+{"version":3,"file":"update-table.d.ts","sourceRoot":"","sources":["../../../interface/update-table.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAEV,QAAQ,EACR,KAAK,EACL,SAAS,EACV,MAAM,2BAA2B,CAAC;AAOnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAyB7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,GACnC,OAAO,SAAS,EAChB,cAAc,OAAO,CAAC,SAAS,CAAC,EAChC,2BAAkC;IAAE,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAAO,KACxE,SA2BF,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,mYAwB9D,IAAI,CACL,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EACnB,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,oBAAoB,GACpB,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,WAAW,GACX,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,sBAAsB,GACtB,cAAc,GACd,eAAe,GACf,uBAAuB,GACvB,wBAAwB,GACxB,gBAAgB,GAChB,yBAAyB,GACzB,4BAA4B,CAC/B,GACC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,MAEnD,SAAS,MAAM,EACf,SAAS,SAAS,CAAC,IAAI,CAAC,EACxB,cAAc,OAAO,CAAC,SAAS,CAAC,SAmTnC,CAAC"}