@rowsncolumns/spreadsheet-state 28.0.66

package/dist/cjs/hooks/use-on-copy.js

@@ -0,0 +1,325 @@
+import { __assign, __read, __values } from "tslib";
+import { areaInsideArea, cellIdentifier, } from "@rowsncolumns/grid";
+import { getBandedCells, getStringifiedColor, } from "@rowsncolumns/spreadsheet";
+import { cellToAddress, getStyleId, getCellUserEnteredValue, getExtendedValueFormula, isNil, iterateCellsInRange, } from "@rowsncolumns/utils";
+import { useCallback, useMemo } from "react";
+import { isStyleReference } from "../sheet-cell";
+var escapeHtmlAttribute = function (value) {
+    return value
+        .replace(/&/g, "&")
+        .replace(/"/g, """)
+        .replace(/'/g, "'")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;");
+};
+/**
+ * Called when user copies a selection from sheet
+ * 1. User can copy from any cell
+ * 2. User can also copy from a different browser tab
+ * @param param0
+ * @returns
+ */
+export var useOnCopy = function (_a) {
+    var theme = _a.theme, merges = _a.merges, sheetTables = _a.tables, bandedRanges = _a.bandedRanges, getFormattedValue = _a.getFormattedValue, getCellData = _a.getCellData, getColumnWidth = _a.getColumnWidth, getRowHeight = _a.getRowHeight, cellXfs = _a.cellXfs, sharedStrings = _a.sharedStrings, getEffectiveFormat = _a.getEffectiveFormat, isHiddenRow = _a.isHiddenRow, isColumnHidden = _a.isColumnHidden;
+    // Merge cell map
+    var mergedCellMap = useMergedCellMap(merges);
+    return useCallback(function (e, sheetId, copiedSelections) {
+        var e_1, _a;
+        var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
+        var isRowHidden = isHiddenRow !== null && isHiddenRow !== void 0 ? isHiddenRow : (function () { return false; });
+        var isColHidden = isColumnHidden !== null && isColumnHidden !== void 0 ? isColumnHidden : (function () { return false; });
+        // Table styling (header fill, banded row/column fills, table borders)
+        // lives in bandedRanges — a render-time layer that never reaches the
+        // cell's userEnteredFormat. Resolve it with the same helper the canvas
+        // grid paints with, so external text/html consumers (Excel, Word) see
+        // what the grid shows.
+        var bandedCells = theme && (bandedRanges === null || bandedRanges === void 0 ? void 0 : bandedRanges.length)
+            ? getBandedCells(bandedRanges, theme, sheetId, function (rowIndex) { return isRowHidden(sheetId, rowIndex); }, function (columnIndex) { return isColHidden(sheetId, columnIndex); })
+            : undefined;
+        var csv = [];
+        var plainText = [];
+        var json = [];
+        var tables = [];
+        var copiedSchema = { sheetData: json, tables: tables };
+        var copiedSharedStrings = new Map();
+        var sharedStringIndexMap = new Map();
+        var copiedCellXfs = new Map();
+        var collectSharedString = function (key) {
+            if (!sharedStrings) {
+                return key;
+            }
+            var value = sharedStrings.get(key);
+            if (value == null) {
+                return key;
+            }
+            var existing = sharedStringIndexMap.get(key);
+            if (existing != null) {
+                return existing;
+            }
+            var nextKey = String(copiedSharedStrings.size);
+            copiedSharedStrings.set(nextKey, typeof value === "string"
+                ? value
+                : { text: value.text, runs: value.runs.map(function (run) { return (__assign({}, run)); }) });
+            sharedStringIndexMap.set(key, nextKey);
+            return nextKey;
+        };
+        var collectCellXfs = function (value) {
+            if (!cellXfs || !isStyleReference(value)) {
+                return;
+            }
+            var styleId = getStyleId(value);
+            if (!styleId || copiedCellXfs.has(styleId)) {
+                return;
+            }
+            if (cellXfs.has(styleId)) {
+                copiedCellXfs.set(styleId, cellXfs.get(styleId));
+            }
+        };
+        var colGroups = "<colgroup>";
+        copiedSelections.forEach(function (_a) {
+            var range = _a.range;
+            var startColumnIndex = range.startColumnIndex, endColumnIndex = range.endColumnIndex;
+            for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                if (isColHidden(sheetId, columnIndex))
+                    continue;
+                var cellWidth = getColumnWidth(sheetId, columnIndex);
+                colGroups += "<col width=\"".concat(cellWidth, "\" />");
+            }
+        });
+        colGroups += "</colgroup>";
+        var htmlString = "<html xmlns:v=\"urn:schemas-microsoft-com:vml\"\n        xmlns:o=\"urn:schemas-microsoft-com:office:office\"\n        xmlns:x=\"urn:schemas-microsoft-com:office:excel\"\n        xmlns=\"http://www.w3.org/TR/REC-html40\">\n            <meta http-equiv=Content-Type content=\"text/html; charset=utf-8\">\n            <style>\n              <!--table{mso-displayed-decimal-separator:\".\"; mso-displayed-thousand-separator:\",\";}tr{mso-height-source:auto;}col{mso-width-source:auto;}-->\n            </style>\n            <style type=\"text/css\"><!--td {border: 1px solid #cccccc;}br {mso-data-placement:same-cell;}--></style><body>\n          <table xmlns=\"http://www.w3.org/1999/xhtml\" cellspacing=\"0\" cellpadding=\"0\" dir=\"ltr\" border=\"1\" style=\"table-layout:fixed;font-size:10pt;font-family:Arial;width:0px;border-collapse:collapse;border:none\">".concat(colGroups, "<tbody>");
+        var _loop_1 = function (range) {
+            var startRowIndex = range.startRowIndex, startColumnIndex = range.startColumnIndex, endColumnIndex = range.endColumnIndex, endRowIndex = range.endRowIndex;
+            /* Check if user is copying a table */
+            var table = sheetTables === null || sheetTables === void 0 ? void 0 : sheetTables.find(function (table) {
+                return areaInsideArea(table.range, range) && table.sheetId === sheetId;
+            });
+            if (table) {
+                // We need to set a rowDelta and colDelta
+                var rowDelta = table.range.startRowIndex - range.startRowIndex;
+                var colDelta = table.range.startColumnIndex - range.startColumnIndex;
+                // Add table
+                tables.push(__assign(__assign({}, table), { rowDelta: rowDelta, colDelta: colDelta }));
+            }
+            /* Iterate over all cells */
+            for (var rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
+                if (isRowHidden(sheetId, rowIndex)) {
+                    continue;
+                }
+                var rowHeight = getRowHeight(sheetId, rowIndex);
+                htmlString += "<tr style=\"height:".concat(rowHeight, "px\">");
+                var csvRow = [];
+                var jsonRow = [];
+                for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                    if (isColHidden(sheetId, columnIndex)) {
+                        continue;
+                    }
+                    var mergedCellInfo = mergedCellMap.get(cellIdentifier(rowIndex, columnIndex));
+                    var isMasterCell = mergedCellInfo ? mergedCellInfo[0] : true;
+                    if (!isMasterCell) {
+                        jsonRow.push({
+                            data: undefined,
+                        });
+                        continue;
+                    }
+                    var _y = __read(mergedCellInfo
+                        ? mergedCellInfo[1]
+                        : [1, 1], 2), rowspan = _y[0], colspan = _y[1];
+                    var formattedValue = (_b = getFormattedValue(sheetId, rowIndex, columnIndex)) !== null && _b !== void 0 ? _b : "";
+                    var cellData = getCellData(sheetId, rowIndex, columnIndex);
+                    var normalizedCellData = cellData;
+                    if (cellData && typeof cellData === "object") {
+                        normalizedCellData = __assign({}, cellData);
+                        if (!isNil(normalizedCellData.ss)) {
+                            normalizedCellData.ss = collectSharedString(String(normalizedCellData.ss));
+                        }
+                        collectCellXfs(normalizedCellData.uf);
+                        collectCellXfs(normalizedCellData.ef);
+                    }
+                    var formula = getExtendedValueFormula(getCellUserEnteredValue(cellData));
+                    var origin_1 = (_c = cellToAddress({ rowIndex: rowIndex, columnIndex: columnIndex })) !== null && _c !== void 0 ? _c : "".concat(rowIndex, ":").concat(columnIndex);
+                    var formulaAttr = formula
+                        ? " data-sheets-formula=\"".concat(escapeHtmlAttribute(formula), "\" data-formula=\"").concat(escapeHtmlAttribute(formula), "\" data-sheets-formula-origin=\"").concat(escapeHtmlAttribute(origin_1), "\" data-formula-origin=\"").concat(escapeHtmlAttribute(origin_1), "\"")
+                        : "";
+                    var effectiveFormat = getEffectiveFormat === null || getEffectiveFormat === void 0 ? void 0 : getEffectiveFormat(sheetId, rowIndex, columnIndex);
+                    var bandedFormat = bandedCells === null || bandedCells === void 0 ? void 0 : bandedCells.get(cellIdentifier(rowIndex, columnIndex));
+                    var numberFormatType = (_d = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.numberFormat) === null || _d === void 0 ? void 0 : _d.type;
+                    var numberFormatPattern = (_e = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.numberFormat) === null || _e === void 0 ? void 0 : _e.pattern;
+                    var numberFormatAttr = numberFormatType
+                        ? " data-sheets-numberformat-type=\"".concat(escapeHtmlAttribute(numberFormatType), "\"").concat(numberFormatPattern
+                            ? " data-sheets-numberformat-pattern=\"".concat(escapeHtmlAttribute(numberFormatPattern), "\"")
+                            : "")
+                        : "";
+                    // Alignment is encoded as data attributes so paste doesn't have
+                    // to trust `getComputedStyle().textAlign`, which fabricates a
+                    // CSS-spec default of `"start"` even when the value was never set.
+                    var horizontalAlignment = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.horizontalAlignment;
+                    var verticalAlignment = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.verticalAlignment;
+                    var alignmentAttr = "".concat(horizontalAlignment
+                        ? " data-sheets-horizontal-alignment=\"".concat(escapeHtmlAttribute(horizontalAlignment), "\"")
+                        : "").concat(verticalAlignment
+                        ? " data-sheets-vertical-alignment=\"".concat(escapeHtmlAttribute(verticalAlignment), "\"")
+                        : "");
+                    // Csv
+                    csvRow.push(formattedValue);
+                    // Style
+                    var isItalic = (_f = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _f === void 0 ? void 0 : _f.italic;
+                    var isBold = (_g = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _g === void 0 ? void 0 : _g.bold;
+                    var isUnderline = (_h = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _h === void 0 ? void 0 : _h.underline;
+                    var isStrikeThrough = (_j = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _j === void 0 ? void 0 : _j.strikethrough;
+                    var baselineOffset = (_k = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _k === void 0 ? void 0 : _k.baselineOffset;
+                    // Cell-level formatting wins over the banded (table style) layer,
+                    // matching the canvas grid's merge order.
+                    var cellBorders = (_l = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.borders) !== null && _l !== void 0 ? _l : bandedFormat === null || bandedFormat === void 0 ? void 0 : bandedFormat.borders;
+                    var borderTop = cellBorders === null || cellBorders === void 0 ? void 0 : cellBorders.top;
+                    var borderBottom = cellBorders === null || cellBorders === void 0 ? void 0 : cellBorders.bottom;
+                    var borderLeft = cellBorders === null || cellBorders === void 0 ? void 0 : cellBorders.left;
+                    var borderRight = cellBorders === null || cellBorders === void 0 ? void 0 : cellBorders.right;
+                    var textDecoration = "".concat(isUnderline ? "underline" : "", " ").concat(isStrikeThrough ? "line-through" : "").trim();
+                    var wordWrap = (effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.wrapStrategy) === "wrap";
+                    var style = theme
+                        ? {
+                            "background-color": getStringifiedColor((_m = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.backgroundColor) !== null && _m !== void 0 ? _m : bandedFormat === null || bandedFormat === void 0 ? void 0 : bandedFormat.backgroundColor, theme),
+                            color: getStringifiedColor((_p = (_o = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _o === void 0 ? void 0 : _o.color) !== null && _p !== void 0 ? _p : (_q = bandedFormat === null || bandedFormat === void 0 ? void 0 : bandedFormat.textFormat) === null || _q === void 0 ? void 0 : _q.color, theme),
+                            padding: "2px 3px 2px 3px",
+                            overflow: "hidden",
+                            "font-weight": isBold ? "700" : "normal",
+                            "font-family": (_r = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _r === void 0 ? void 0 : _r.fontFamily,
+                            "font-style": isItalic ? "italic" : "normal",
+                            "text-decoration": textDecoration
+                                ? textDecoration
+                                : undefined,
+                            "font-size": "".concat((_t = (_s = effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.textFormat) === null || _s === void 0 ? void 0 : _s.fontSize) !== null && _t !== void 0 ? _t : 10, "pt"),
+                            "text-align": effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.horizontalAlignment,
+                            "vertical-align": effectiveFormat === null || effectiveFormat === void 0 ? void 0 : effectiveFormat.verticalAlignment,
+                            "border-top": borderTop
+                                ? "".concat(borderTop.width, "px solid ").concat(getStringifiedColor(borderTop.color, theme))
+                                : undefined,
+                            "border-left": borderLeft
+                                ? "".concat(borderLeft.width, "px solid ").concat(getStringifiedColor(borderLeft.color, theme))
+                                : undefined,
+                            "border-right": borderRight
+                                ? "".concat(borderRight.width, "px solid ").concat(getStringifiedColor(borderRight.color, theme))
+                                : undefined,
+                            "border-bottom": borderBottom
+                                ? "".concat(borderBottom.width, "px solid ").concat(getStringifiedColor(borderBottom.color, theme))
+                                : undefined,
+                            "text-wrap": wordWrap ? "wrap" : undefined,
+                        }
+                        : {};
+                    // html
+                    var innerHtml = baselineOffset === "superscript"
+                        ? "<sup>".concat(formattedValue, "</sup>")
+                        : baselineOffset === "subscript"
+                            ? "<sub>".concat(formattedValue, "</sub>")
+                            : formattedValue;
+                    htmlString +=
+                        "<td".concat(formulaAttr).concat(numberFormatAttr).concat(alignmentAttr, " ").concat(rowspan > 1 ? "rowspan=\"".concat(rowspan, "\"") : "", " ").concat(colspan > 1 ? "colspan=\"".concat(colspan, "\"") : "", " style='").concat(Object.entries(style)
+                            .filter(function (_a) {
+                            var _b = __read(_a, 2), _ = _b[0], v = _b[1];
+                            return !isNil(v);
+                        })
+                            .map(function (_a) {
+                            var _b = __read(_a, 2), k = _b[0], v = _b[1];
+                            return "".concat(k, ":").concat(v);
+                        })
+                            .join(";"), "'>") +
+                            innerHtml +
+                            "</td>";
+                    // json
+                    jsonRow.push({
+                        data: normalizedCellData,
+                        sourceCell: { rowIndex: rowIndex, columnIndex: columnIndex },
+                        rowspan: rowspan,
+                        colspan: colspan,
+                    });
+                }
+                /* Join with ',' for csv */
+                csv.push(csvRow.join(","));
+                // Plain text
+                plainText.push(csvRow.join("\t"));
+                // html
+                htmlString += "</tr>";
+                // json
+                json.push(jsonRow);
+            }
+            htmlString += "<tbody></table></body></html>";
+        };
+        try {
+            for (var copiedSelections_1 = __values(copiedSelections), copiedSelections_1_1 = copiedSelections_1.next(); !copiedSelections_1_1.done; copiedSelections_1_1 = copiedSelections_1.next()) {
+                var range = copiedSelections_1_1.value.range;
+                _loop_1(range);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (copiedSelections_1_1 && !copiedSelections_1_1.done && (_a = copiedSelections_1.return)) _a.call(copiedSelections_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        var csvStr = csv.join("\n");
+        var plainTextStr = plainText.join("\n");
+        if (copiedSharedStrings.size) {
+            // Convert Map to plain object for JSON serialization
+            copiedSchema.sharedStrings = Object.fromEntries(copiedSharedStrings);
+        }
+        if (copiedCellXfs.size) {
+            copiedSchema.cellXfs = Array.from(copiedCellXfs.entries());
+        }
+        (_u = e === null || e === void 0 ? void 0 : e.clipboardData) === null || _u === void 0 ? void 0 : _u.setData("text/html", htmlString);
+        (_v = e === null || e === void 0 ? void 0 : e.clipboardData) === null || _v === void 0 ? void 0 : _v.setData("text/plain", plainTextStr);
+        (_w = e === null || e === void 0 ? void 0 : e.clipboardData) === null || _w === void 0 ? void 0 : _w.setData("text/csv", csvStr);
+        (_x = e === null || e === void 0 ? void 0 : e.clipboardData) === null || _x === void 0 ? void 0 : _x.setData("application/json", JSON.stringify(copiedSchema));
+    }, [
+        theme,
+        sheetTables,
+        bandedRanges,
+        getFormattedValue,
+        getCellData,
+        getRowHeight,
+        getColumnWidth,
+        getEffectiveFormat,
+        mergedCellMap,
+        cellXfs,
+        sharedStrings,
+        isColumnHidden,
+        isHiddenRow,
+    ]);
+};
+// Merge cell map
+export var useMergedCellMap = function (merges) {
+    return useMemo(function () {
+        var e_2, _a;
+        var mergedCellMap = new Map();
+        var finalMerges = merges !== null && merges !== void 0 ? merges : [];
+        for (var i = 0; i < finalMerges.length; i++) {
+            var range = finalMerges[i];
+            var startRowIndex = range.startRowIndex, startColumnIndex = range.startColumnIndex, endColumnIndex = range.endColumnIndex, endRowIndex = range.endRowIndex;
+            try {
+                for (var _b = (e_2 = void 0, __values(iterateCellsInRange(range))), _c = _b.next(); !_c.done; _c = _b.next()) {
+                    var _d = __read(_c.value, 2), rowIndex = _d[0], columnIndex = _d[1];
+                    var isMasterCell = rowIndex === startRowIndex && columnIndex === startColumnIndex;
+                    var spans = isMasterCell
+                        ? [
+                            endRowIndex - startRowIndex + 1,
+                            endColumnIndex - startColumnIndex + 1,
+                        ]
+                        : [1, 1];
+                    mergedCellMap.set(cellIdentifier(rowIndex, columnIndex), [
+                        isMasterCell,
+                        spans,
+                    ]);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        }
+        return mergedCellMap;
+    }, [merges]);
+};

package/dist/cjs/hooks/use-on-create-named-range.d.ts

@@ -0,0 +1,13 @@
+import type { CellData, NamedRange } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { useCalculation } from "./use-calculation";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnCreateNamedRangeProps<T extends CellData> = {
+    enqueueCalculation: ReturnType<typeof useCalculation>["enqueueCalculation"];
+    onChangeNamedRanges: UseSpreadsheetProps<T>["onChangeNamedRanges"];
+    createHistory(): (patches: SpreadsheetPatch) => void;
+    onCommand?: OnCommand;
+};
+export declare const useOnCreateNamedRange: <T extends CellData>({ enqueueCalculation, createHistory, onChangeNamedRanges, onCommand, }: UseOnCreateNamedRangeProps<T>) => (sheetId: number, namedRange: NamedRange) => void;
+//# sourceMappingURL=use-on-create-named-range.d.ts.map

package/dist/cjs/hooks/use-on-create-named-range.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-create-named-range.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-create-named-range.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAGtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC3D,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IACnE,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,QAAQ,EAAE,wEAKvD,0BAA0B,CAAC,CAAC,CAAC,eAGlB,MAAM,cAAc,UAAU,SA+B3C,CAAC"}

package/dist/cjs/hooks/use-on-create-named-range.js

@@ -0,0 +1,33 @@
+import { useCallback } from "react";
+import { createNamedRange } from "../interface/named-range-operations";
+import { useCanEditSheet } from "./use-can-edit-cellrange";
+export var useOnCreateNamedRange = function (_a) {
+    var enqueueCalculation = _a.enqueueCalculation, createHistory = _a.createHistory, onChangeNamedRanges = _a.onChangeNamedRanges, onCommand = _a.onCommand;
+    var canEditSheet = useCanEditSheet();
+    return useCallback(function (sheetId, namedRange) {
+        // Protection — defer to host policy via canEditSheet. Sheet-
+        // scoped names belong to the sheet identified by `sheetId`;
+        // workbook-scoped names are typically authored from a sheet
+        // context too, so the same gate applies.
+        if (!canEditSheet(sheetId)) {
+            console.debug("Cannot create named range — sheet is protected.");
+            return;
+        }
+        createNamedRange({
+            enqueueCalculation: enqueueCalculation,
+            createHistory: createHistory,
+            onChangeNamedRanges: onChangeNamedRanges,
+        })(sheetId, namedRange);
+        onCommand === null || onCommand === void 0 ? void 0 : onCommand({
+            command: "create-named-range",
+            sheetId: sheetId,
+            namedRange: namedRange,
+        });
+    }, [
+        onChangeNamedRanges,
+        createHistory,
+        enqueueCalculation,
+        onCommand,
+        canEditSheet,
+    ]);
+};

package/dist/cjs/hooks/use-on-create-sheet.d.ts

@@ -0,0 +1,23 @@
+import type { CellData, Sheet } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { GeneratedNames } from "../generated-names";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnCreateSheetProps<T extends CellData, S extends Sheet> = {
+    sheetId: number;
+    maxSheetCount?: number;
+    sheets?: S[];
+    maxRowCount?: number;
+    maxColumnCount?: number;
+    /**
+     * Id creation strategy
+     */
+    idCreationStrategy?: UseSpreadsheetProps<T, S>["idCreationStrategy"];
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onChangeActiveSheet(sheetId: number): void;
+    createHistory(): (patches: SpreadsheetPatch) => void;
+    onCommand?: OnCommand;
+    generatedNames?: GeneratedNames;
+};
+export declare const useOnCreateNewSheet: <T extends CellData, S extends Sheet = Sheet>({ sheetId, maxSheetCount, sheets, maxRowCount, maxColumnCount, idCreationStrategy, onChangeSheets, onChangeActiveSheet, createHistory, onCommand, generatedNames, }: UseOnCreateSheetProps<T, S>) => (sheetSpec?: Partial<Sheet> | React.MouseEvent) => S | undefined;
+//# sourceMappingURL=use-on-create-sheet.d.ts.map

package/dist/cjs/hooks/use-on-create-sheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-create-sheet.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-create-sheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAKjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IACvE,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;IACrE,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,KAAK,GAAG,KAAK,EACvB,qKAYC,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,kBAIb,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,UAAU,kBA2DjD,CAAC"}

package/dist/cjs/hooks/use-on-create-sheet.js

@@ -0,0 +1,66 @@
+import { isNil } from "@rowsncolumns/utils";
+import { useCallback } from "react";
+import { useShowError } from "../atoms/error-state.atom";
+import { sanitizeSheetSpecTitle } from "../helpers/sheet-title";
+import { createNewSheet } from "../interface/new-sheet";
+import { useCanEditWorkbook } from "./use-can-edit-cellrange";
+export var useOnCreateNewSheet = function (_a) {
+    var sheetId = _a.sheetId, maxSheetCount = _a.maxSheetCount, sheets = _a.sheets, maxRowCount = _a.maxRowCount, maxColumnCount = _a.maxColumnCount, idCreationStrategy = _a.idCreationStrategy, onChangeSheets = _a.onChangeSheets, onChangeActiveSheet = _a.onChangeActiveSheet, createHistory = _a.createHistory, onCommand = _a.onCommand, generatedNames = _a.generatedNames;
+    var showError = useShowError();
+    var canEditWorkbook = useCanEditWorkbook();
+    return useCallback(function (sheetSpec) {
+        var _a;
+        // Workbook-level structural protection — adding a sheet
+        // changes workbook structure, refuse when the workbook is
+        // protected even if individual sheets are unlocked.
+        if (!canEditWorkbook()) {
+            console.debug("Workbook is structurally protected, cannot add a new sheet.");
+            return;
+        }
+        if (!isNil(maxSheetCount) && ((_a = sheets === null || sheets === void 0 ? void 0 : sheets.length) !== null && _a !== void 0 ? _a : 0) + 1 > maxSheetCount) {
+            showError({
+                title: "New sheets cannot be added.",
+                message: "You have reached the maximum number of sheets.",
+            });
+            return;
+        }
+        var nextSheetSpec;
+        if (sheetSpec && "currentTarget" in sheetSpec) {
+            nextSheetSpec = undefined;
+        }
+        else if (sheetSpec) {
+            nextSheetSpec = sanitizeSheetSpecTitle(sheetSpec);
+        }
+        var result = createNewSheet({
+            sheetId: sheetId,
+            maxSheetCount: maxSheetCount,
+            sheets: sheets,
+            maxRowCount: maxRowCount,
+            maxColumnCount: maxColumnCount,
+            idCreationStrategy: idCreationStrategy,
+            onChangeSheets: onChangeSheets,
+            onChangeActiveSheet: onChangeActiveSheet,
+            createHistory: createHistory,
+            generatedNames: generatedNames,
+        })(nextSheetSpec);
+        onCommand === null || onCommand === void 0 ? void 0 : onCommand({
+            command: "create-sheet",
+            sheetSpec: nextSheetSpec,
+        });
+        return result;
+    }, [
+        idCreationStrategy,
+        onChangeSheets,
+        createHistory,
+        onChangeActiveSheet,
+        showError,
+        maxSheetCount,
+        sheets,
+        sheetId,
+        maxRowCount,
+        maxColumnCount,
+        canEditWorkbook,
+        onCommand,
+        generatedNames,
+    ]);
+};

package/dist/cjs/hooks/use-on-delete-cells-shift-left.d.ts

@@ -0,0 +1,28 @@
+import { type CellInterface, type SelectionArea } from "@rowsncolumns/grid";
+import type { CellData, SelectionAttributes, Sheet } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { SharedStringRegistry } from "./use-ss-registry";
+import type { useCalculation } from "./use-calculation";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnDeleteCellsShiftLeftProps<T extends CellData, S extends Sheet> = {
+    columnCount: number;
+    rowCount: number;
+    locale?: string;
+    cellXfsRegistry?: CellXfsRegistry;
+    sharedStringRegistry?: SharedStringRegistry;
+    getActiveCell: () => CellInterface;
+    getSelections(): SelectionArea<SelectionAttributes>[];
+    createHistory: () => (patches: SpreadsheetPatch) => void;
+    getDependents: ReturnType<typeof useCalculation>["getDependents"];
+    enqueueCalculation: ReturnType<typeof useCalculation>["enqueueCalculation"];
+    enqueueStructureChange?: ReturnType<typeof useCalculation>["enqueueStructureChange"];
+    enqueueGraphOperation: ReturnType<typeof useCalculation>["enqueueGraphOperation"];
+    onChangeSheetData: UseSpreadsheetProps<T, S>["onChangeSheetData"];
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onChangeCitations?: UseSpreadsheetProps<T, S>["onChangeCitations"];
+    onCommand?: OnCommand;
+};
+export declare const useOnDeleteCellsShiftLeft: <T extends CellData, S extends Sheet>({ rowCount, columnCount, locale, cellXfsRegistry, sharedStringRegistry, getActiveCell, getSelections, getDependents, createHistory, enqueueGraphOperation, enqueueCalculation, enqueueStructureChange, onChangeSheetData, onChangeSheets, onChangeCitations, onCommand, }: UseOnDeleteCellsShiftLeftProps<T, S>) => (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+//# sourceMappingURL=use-on-delete-cells-shift-left.d.ts.map

package/dist/cjs/hooks/use-on-delete-cells-shift-left.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-delete-cells-shift-left.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-delete-cells-shift-left.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EACV,QAAQ,EACR,mBAAmB,EACnB,KAAK,EACN,MAAM,2BAA2B,CAAC;AAGnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,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;AAOxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,8BAA8B,CACxC,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,KAAK,IACb;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,aAAa,EAAE,MAAM,aAAa,CAAC;IACnC,aAAa,IAAI,aAAa,CAAC,mBAAmB,CAAC,EAAE,CAAC;IACtD,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACzD,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,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,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAClE,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,2QAiB5E,8BAA8B,CAAC,CAAC,EAAE,CAAC,CAAC,eAMxB,MAAM,cACH,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,SA8DrD,CAAC"}

package/dist/cjs/hooks/use-on-delete-cells-shift-left.js

@@ -0,0 +1,66 @@
+import { useCallback } from "react";
+import { deleteCellsShiftLeft } from "../interface/delete-cells-shift-left";
+import { useShowError } from "../atoms/error-state.atom";
+import { SHEET_PROTECTION_ERROR_TITLE, useCanEditCellRange, useCanPerformSheetAction, } from "./use-can-edit-cellrange";
+export var useOnDeleteCellsShiftLeft = function (_a) {
+    var rowCount = _a.rowCount, columnCount = _a.columnCount, locale = _a.locale, cellXfsRegistry = _a.cellXfsRegistry, sharedStringRegistry = _a.sharedStringRegistry, getActiveCell = _a.getActiveCell, getSelections = _a.getSelections, getDependents = _a.getDependents, createHistory = _a.createHistory, enqueueGraphOperation = _a.enqueueGraphOperation, enqueueCalculation = _a.enqueueCalculation, enqueueStructureChange = _a.enqueueStructureChange, onChangeSheetData = _a.onChangeSheetData, onChangeSheets = _a.onChangeSheets, onChangeCitations = _a.onChangeCitations, onCommand = _a.onCommand;
+    var canEditCellRange = useCanEditCellRange();
+    var canPerformSheetAction = useCanPerformSheetAction();
+    var showError = useShowError();
+    return useCallback(function (sheetId, activeCell, selections) {
+        if (!canPerformSheetAction(sheetId, "deleteColumns")) {
+            showError({
+                title: SHEET_PROTECTION_ERROR_TITLE,
+                message: "You can't delete cells on a protected sheet.",
+            });
+            return;
+        }
+        if (!canEditCellRange(sheetId, activeCell)) {
+            console.debug("This range is protected, users cannot edit this cell range.");
+            return;
+        }
+        deleteCellsShiftLeft({
+            rowCount: rowCount,
+            columnCount: columnCount,
+            locale: locale,
+            cellXfsRegistry: cellXfsRegistry,
+            sharedStringRegistry: sharedStringRegistry,
+            getActiveCell: getActiveCell,
+            getSelections: getSelections,
+            getDependents: getDependents,
+            createHistory: createHistory,
+            enqueueGraphOperation: enqueueGraphOperation,
+            enqueueCalculation: enqueueCalculation,
+            enqueueStructureChange: enqueueStructureChange,
+            onChangeSheetData: onChangeSheetData,
+            onChangeSheets: onChangeSheets,
+            onChangeCitations: onChangeCitations,
+        })(sheetId, activeCell, selections);
+        onCommand === null || onCommand === void 0 ? void 0 : onCommand({
+            command: "delete-cells-shift-left",
+            sheetId: sheetId,
+            activeCell: activeCell,
+            selections: selections,
+        });
+    }, [
+        columnCount,
+        rowCount,
+        locale,
+        cellXfsRegistry,
+        sharedStringRegistry,
+        getActiveCell,
+        getSelections,
+        onChangeSheetData,
+        onChangeSheets,
+        onChangeCitations,
+        createHistory,
+        getDependents,
+        enqueueGraphOperation,
+        enqueueCalculation,
+        enqueueStructureChange,
+        canEditCellRange,
+        canPerformSheetAction,
+        showError,
+        onCommand,
+    ]);
+};

package/dist/cjs/hooks/use-on-delete-cells-shift-up.d.ts

@@ -0,0 +1,28 @@
+import { type CellInterface, type SelectionArea } from "@rowsncolumns/grid";
+import type { CellData, SelectionAttributes, Sheet } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { SharedStringRegistry } from "./use-ss-registry";
+import type { useCalculation } from "./use-calculation";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnDeleteCellsShiftUpProps<T extends CellData, S extends Sheet> = {
+    rowCount: number;
+    columnCount: number;
+    locale?: string;
+    cellXfsRegistry?: CellXfsRegistry;
+    sharedStringRegistry?: SharedStringRegistry;
+    getActiveCell: () => CellInterface;
+    getSelections(): SelectionArea<SelectionAttributes>[];
+    createHistory: () => (patches: SpreadsheetPatch) => void;
+    getDependents: ReturnType<typeof useCalculation>["getDependents"];
+    enqueueCalculation: ReturnType<typeof useCalculation>["enqueueCalculation"];
+    enqueueStructureChange?: ReturnType<typeof useCalculation>["enqueueStructureChange"];
+    enqueueGraphOperation: ReturnType<typeof useCalculation>["enqueueGraphOperation"];
+    onChangeSheetData: UseSpreadsheetProps<T, S>["onChangeSheetData"];
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onChangeCitations?: UseSpreadsheetProps<T, S>["onChangeCitations"];
+    onCommand?: OnCommand;
+};
+export declare const useOnDeleteCellsShiftUp: <T extends CellData, S extends Sheet>({ rowCount, columnCount, locale, cellXfsRegistry, sharedStringRegistry, getActiveCell, getSelections, getDependents, createHistory, enqueueGraphOperation, enqueueCalculation, enqueueStructureChange, onChangeSheetData, onChangeSheets, onChangeCitations, onCommand, }: UseOnDeleteCellsShiftUpProps<T, S>) => (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+//# sourceMappingURL=use-on-delete-cells-shift-up.d.ts.map

package/dist/cjs/hooks/use-on-delete-cells-shift-up.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-delete-cells-shift-up.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-delete-cells-shift-up.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EACV,QAAQ,EACR,mBAAmB,EACnB,KAAK,EACN,MAAM,2BAA2B,CAAC;AAGnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,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;AAOxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,4BAA4B,CACtC,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,KAAK,IACb;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,aAAa,EAAE,MAAM,aAAa,CAAC;IACnC,aAAa,IAAI,aAAa,CAAC,mBAAmB,CAAC,EAAE,CAAC;IACtD,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACzD,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,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,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAClE,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,2QAiB1E,4BAA4B,CAAC,CAAC,EAAE,CAAC,CAAC,eAMtB,MAAM,cACH,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,SA8DrD,CAAC"}