@rowsncolumns/spreadsheet-state 28.0.66

package/dist/esm/hooks/use-on-clear-formatting.d.ts

@@ -0,0 +1,17 @@
+import type { CellInterface, SelectionArea } from "@rowsncolumns/common-types";
+import type { CellData, DataValidationRuleRecord, SelectionAttributes } from "@rowsncolumns/spreadsheet";
+import type { Patch } from "immer";
+import type { OnCommand } from "../commands";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnClearFormattingProps<T extends CellData> = {
+    locale?: string;
+    cellXfsRegistry?: CellXfsRegistry;
+    getDataValidationById?: (id: DataValidationRuleRecord["id"]) => DataValidationRuleRecord | undefined;
+    onChangeSheetData: UseSpreadsheetProps<T>["onChangeSheetData"];
+    createHistory: () => (patches: SpreadsheetPatch<Patch>) => void;
+    onCommand?: OnCommand;
+};
+export declare const useOnClearFormatting: <T extends CellData>({ locale, cellXfsRegistry, getDataValidationById, onChangeSheetData, createHistory, onCommand, }: UseOnClearFormattingProps<T>) => (sheetId: number, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+//# sourceMappingURL=use-on-clear-formatting.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-clear-formatting.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-clear-formatting.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,KAAK,EACV,QAAQ,EACR,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAQ7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,qBAAqB,CAAC,EAAE,CACtB,EAAE,EAAE,wBAAwB,CAAC,IAAI,CAAC,KAC/B,wBAAwB,GAAG,SAAS,CAAC;IAC1C,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC/D,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IAChE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,QAAQ,EAAE,kGAOtD,yBAAyB,CAAC,CAAC,CAAC,eAMhB,MAAM,cACH,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,SA2CrD,CAAC"}

package/dist/esm/hooks/use-on-clear-formatting.js

@@ -0,0 +1,45 @@
+import { useCallback } from "react";
+import { clearFormatting } from "../interface/clear-formatting";
+import { useShowError } from "../atoms/error-state.atom";
+import { SHEET_PROTECTION_ERROR_TITLE, useCanEditCellRange, useCanPerformSheetAction, } from "./use-can-edit-cellrange";
+export const useOnClearFormatting = ({ locale, cellXfsRegistry, getDataValidationById, onChangeSheetData, createHistory, onCommand, }) => {
+    const canEditCellRange = useCanEditCellRange();
+    const canPerformSheetAction = useCanPerformSheetAction();
+    const showError = useShowError();
+    return useCallback((sheetId, activeCell, selections) => {
+        if (!canPerformSheetAction(sheetId, "formatCells")) {
+            showError({
+                title: SHEET_PROTECTION_ERROR_TITLE,
+                message: "You can't change formatting on a protected sheet.",
+            });
+            return;
+        }
+        if (!canEditCellRange(sheetId, activeCell)) {
+            console.debug("This range is protected, users cannot edit this cell range.");
+            return;
+        }
+        clearFormatting({
+            locale,
+            cellXfsRegistry,
+            getDataValidationById,
+            onChangeSheetData,
+            createHistory,
+        })(sheetId, activeCell, selections);
+        onCommand?.({
+            command: "clear-formatting",
+            sheetId,
+            activeCell,
+            selections,
+        });
+    }, [
+        locale,
+        cellXfsRegistry,
+        onChangeSheetData,
+        createHistory,
+        canEditCellRange,
+        canPerformSheetAction,
+        showError,
+        getDataValidationById,
+        onCommand,
+    ]);
+};

package/dist/esm/hooks/use-on-collapse-column-group.d.ts

@@ -0,0 +1,11 @@
+import type { CellData, Sheet } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnCollapseColumnGroupProps<T extends CellData, S extends Sheet> = {
+    createHistory(): (patches: SpreadsheetPatch) => void;
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onCommand?: OnCommand;
+};
+export declare const useOnCollapseColumnGroup: <T extends CellData, S extends Sheet>({ createHistory, onChangeSheets, onCommand, }: UseOnCollapseColumnGroupProps<T, S>) => (sheetId: number, summaryColumnIndex: number) => void;
+//# sourceMappingURL=use-on-collapse-column-group.d.ts.map

package/dist/esm/hooks/use-on-collapse-column-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-collapse-column-group.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-collapse-column-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EAER,KAAK,EACN,MAAM,2BAA2B,CAAC;AAMnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,6BAA6B,CACvC,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,KAAK,IACb;IACF,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,+CAI3E,6BAA6B,CAAC,CAAC,EAAE,CAAC,CAAC,eAGxB,MAAM,sBAAsB,MAAM,SAkD/C,CAAC"}

package/dist/esm/hooks/use-on-collapse-column-group.js

@@ -0,0 +1,44 @@
+import { produceWithPatches } from "immer";
+import { useCallback } from "react";
+import { findGroupAtSummary, resolveSummaryRight } from "../api/outline";
+import { useCanEditSheet } from "./use-can-edit-cellrange";
+export const useOnCollapseColumnGroup = ({ createHistory, onChangeSheets, onCommand, }) => {
+    const canEditSheet = useCanEditSheet();
+    return useCallback((sheetId, summaryColumnIndex) => {
+        if (!canEditSheet(sheetId))
+            return;
+        const saveHistory = createHistory();
+        onChangeSheets?.((prevSheets) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheets, (draft) => {
+                const sheet = draft.find((s) => s.sheetId === sheetId);
+                if (sheet) {
+                    if (!sheet.columnMetadata)
+                        sheet.columnMetadata = [];
+                    const summaryRight = resolveSummaryRight(sheet.outlinePr ?? undefined);
+                    const group = findGroupAtSummary(sheet.columnMetadata, summaryColumnIndex, summaryRight);
+                    if (group) {
+                        for (let c = group.startIndex; c <= group.endIndex; c++) {
+                            if (!sheet.columnMetadata[c]) {
+                                sheet.columnMetadata[c] =
+                                    {};
+                            }
+                            sheet.columnMetadata[c].hiddenByGroup = true;
+                        }
+                        if (!sheet.columnMetadata[summaryColumnIndex]) {
+                            sheet.columnMetadata[summaryColumnIndex] =
+                                {};
+                        }
+                        sheet.columnMetadata[summaryColumnIndex].collapsed = true;
+                    }
+                }
+            });
+            saveHistory({ sheets: { patches, inversePatches } });
+            return nextState;
+        });
+        onCommand?.({
+            command: "collapse-column-group",
+            sheetId,
+            summaryColumnIndex,
+        });
+    }, [canEditSheet, createHistory, onChangeSheets, onCommand]);
+};

package/dist/esm/hooks/use-on-collapse-row-group.d.ts

@@ -0,0 +1,18 @@
+import type { CellData, Sheet } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnCollapseRowGroupProps<T extends CellData, S extends Sheet> = {
+    createHistory(): (patches: SpreadsheetPatch) => void;
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onCommand?: OnCommand;
+};
+/**
+ * Collapse the outline group whose summary sits at `summaryRowIndex`.
+ * The summary itself is marked `collapsed=true` (that's where the `+`
+ * button paints); each child row gets `hiddenByGroup=true` so the
+ * render layer skips it. Manual `hiddenByUser` and filter
+ * `hiddenByFilter` stay untouched — they re-emerge on expand.
+ */
+export declare const useOnCollapseRowGroup: <T extends CellData, S extends Sheet>({ createHistory, onChangeSheets, onCommand, }: UseOnCollapseRowGroupProps<T, S>) => (sheetId: number, summaryRowIndex: number) => void;
+//# sourceMappingURL=use-on-collapse-row-group.d.ts.map

package/dist/esm/hooks/use-on-collapse-row-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-collapse-row-group.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-collapse-row-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EAER,KAAK,EACN,MAAM,2BAA2B,CAAC;AAMnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,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,EAAE,CAAC,SAAS,KAAK,IAAI;IAC5E,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,+CAIxE,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,eAGrB,MAAM,mBAAmB,MAAM,SAoD5C,CAAC"}

package/dist/esm/hooks/use-on-collapse-row-group.js

@@ -0,0 +1,54 @@
+import { produceWithPatches } from "immer";
+import { useCallback } from "react";
+import { findGroupAtSummary, resolveSummaryBelow } from "../api/outline";
+import { useCanEditSheet } from "./use-can-edit-cellrange";
+/**
+ * Collapse the outline group whose summary sits at `summaryRowIndex`.
+ * The summary itself is marked `collapsed=true` (that's where the `+`
+ * button paints); each child row gets `hiddenByGroup=true` so the
+ * render layer skips it. Manual `hiddenByUser` and filter
+ * `hiddenByFilter` stay untouched — they re-emerge on expand.
+ */
+export const useOnCollapseRowGroup = ({ createHistory, onChangeSheets, onCommand, }) => {
+    const canEditSheet = useCanEditSheet();
+    return useCallback((sheetId, summaryRowIndex) => {
+        if (!canEditSheet(sheetId))
+            return;
+        const saveHistory = createHistory();
+        onChangeSheets?.((prevSheets) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheets, (draft) => {
+                const sheet = draft.find((s) => s.sheetId === sheetId);
+                if (!sheet) {
+                    return;
+                }
+                if (!sheet.rowMetadata) {
+                    sheet.rowMetadata = [];
+                }
+                const summaryBelow = resolveSummaryBelow(sheet.outlinePr ?? undefined);
+                const group = findGroupAtSummary(sheet.rowMetadata, summaryRowIndex, summaryBelow);
+                if (!group)
+                    return;
+                if (!sheet.rowMetadata)
+                    sheet.rowMetadata = [];
+                for (let r = group.startIndex; r <= group.endIndex; r++) {
+                    if (!sheet.rowMetadata[r]) {
+                        sheet.rowMetadata[r] = {};
+                    }
+                    sheet.rowMetadata[r].hiddenByGroup = true;
+                }
+                if (!sheet.rowMetadata[summaryRowIndex]) {
+                    sheet.rowMetadata[summaryRowIndex] =
+                        {};
+                }
+                sheet.rowMetadata[summaryRowIndex].collapsed = true;
+            });
+            saveHistory({ sheets: { patches, inversePatches } });
+            return nextState;
+        });
+        onCommand?.({
+            command: "collapse-row-group",
+            sheetId,
+            summaryRowIndex,
+        });
+    }, [canEditSheet, createHistory, onChangeSheets, onCommand]);
+};

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

@@ -0,0 +1,49 @@
+import type { CellInterface } from "@rowsncolumns/common-types";
+import { type GridRange, type SelectionArea } from "@rowsncolumns/grid";
+import type { SpreadsheetTheme } from "@rowsncolumns/spreadsheet";
+import type { BandedRange, TableView } from "@rowsncolumns/spreadsheet";
+import { type CellData, type CellFormat, type SelectionAttributes } from "@rowsncolumns/spreadsheet";
+import type { CellXfs, SharedStringValue, SharedStrings } from "../types";
+import type { useSheetProperties } from "./use-sheet-properties";
+type UseOnCopyProps<T extends CellData> = {
+    theme?: SpreadsheetTheme;
+    merges?: GridRange[] | null;
+    tables?: TableView[];
+    bandedRanges?: BandedRange[] | null;
+    getFormattedValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined | null;
+    getCellData(sheetId: number, rowIndex: number, columnIndex: number): T | undefined | null;
+    getColumnWidth(sheetId: number, columnIndex: number): number;
+    getRowHeight(sheetId: number, rowIndex: number): number;
+    cellXfs?: CellXfs | null;
+    sharedStrings?: SharedStrings | null;
+    getEffectiveFormat?: ReturnType<typeof useSheetProperties>["getEffectiveFormat"];
+    isHiddenRow?(sheetId: number, rowIndex: number): boolean;
+    isColumnHidden?(sheetId: number, columnIndex: number): boolean;
+};
+export type EnhancedCellData<T> = {
+    data: T;
+    sourceCell?: CellInterface;
+    rowspan?: number;
+    colspan?: number;
+};
+export type TableViewWithDelta = TableView & {
+    rowDelta?: number;
+    colDelta?: number;
+};
+export type CopySchema<T extends CellData> = {
+    tables?: TableViewWithDelta[];
+    sheetData: EnhancedCellData<T | undefined | null>[][];
+    sharedStrings?: Record<string, SharedStringValue>;
+    cellXfs?: Array<[string | number, CellFormat | undefined | null]>;
+};
+/**
+ * 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 declare const useOnCopy: <T extends CellData>({ theme, merges, tables: sheetTables, bandedRanges, getFormattedValue, getCellData, getColumnWidth, getRowHeight, cellXfs, sharedStrings, getEffectiveFormat, isHiddenRow, isColumnHidden, }: UseOnCopyProps<T>) => (e: ClipboardEvent | undefined, sheetId: number, copiedSelections: SelectionArea<SelectionAttributes>[]) => void;
+export declare const useMergedCellMap: (merges?: GridRange[] | null) => Map<string, [isMasterCell: boolean, readonly [rowspan: number, colspan: number]]>;
+export {};
+//# sourceMappingURL=use-on-copy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-copy.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-copy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAGL,KAAK,SAAS,EACd,KAAK,aAAa,EACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,UAAU,EAGf,KAAK,mBAAmB,EACzB,MAAM,2BAA2B,CAAC;AAYnC,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAUjE,KAAK,cAAc,CAAC,CAAC,SAAS,QAAQ,IAAI;IACxC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,MAAM,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACpC,iBAAiB,EAAE,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAC/B,WAAW,CACT,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IACxB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7D,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IACxD,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACrC,kBAAkB,CAAC,EAAE,UAAU,CAC7B,OAAO,kBAAkB,CAC1B,CAAC,oBAAoB,CAAC,CAAC;IACxB,WAAW,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACzD,cAAc,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAChC,IAAI,EAAE,CAAC,CAAC;IACR,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC3C,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC9B,SAAS,EAAE,gBAAgB,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,GAAG,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;GAMG;AAEH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,QAAQ,EAAE,8LAc3C,cAAc,CAAC,CAAC,CAAC,SAMX,cAAc,GAAG,SAAS,WACpB,MAAM,oBACG,aAAa,CAAC,mBAAmB,CAAC,EAAE,SAyX3D,CAAC;AAGF,eAAO,MAAM,gBAAgB,GAAI,SAAS,SAAS,EAAE,GAAG,IAAI,sFA4B3D,CAAC"}

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

@@ -0,0 +1,302 @@
+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";
+const escapeHtmlAttribute = (value) => 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 const useOnCopy = ({ theme, merges, tables: sheetTables, bandedRanges, getFormattedValue, getCellData, getColumnWidth, getRowHeight, cellXfs, sharedStrings, getEffectiveFormat, isHiddenRow, isColumnHidden, }) => {
+    // Merge cell map
+    const mergedCellMap = useMergedCellMap(merges);
+    return useCallback((e, sheetId, copiedSelections) => {
+        const isRowHidden = isHiddenRow ?? (() => false);
+        const isColHidden = isColumnHidden ?? (() => 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.
+        const bandedCells = theme && bandedRanges?.length
+            ? getBandedCells(bandedRanges, theme, sheetId, (rowIndex) => isRowHidden(sheetId, rowIndex), (columnIndex) => isColHidden(sheetId, columnIndex))
+            : undefined;
+        const csv = [];
+        const plainText = [];
+        const json = [];
+        const tables = [];
+        const copiedSchema = { sheetData: json, tables };
+        const copiedSharedStrings = new Map();
+        const sharedStringIndexMap = new Map();
+        const copiedCellXfs = new Map();
+        const collectSharedString = (key) => {
+            if (!sharedStrings) {
+                return key;
+            }
+            const value = sharedStrings.get(key);
+            if (value == null) {
+                return key;
+            }
+            const existing = sharedStringIndexMap.get(key);
+            if (existing != null) {
+                return existing;
+            }
+            const nextKey = String(copiedSharedStrings.size);
+            copiedSharedStrings.set(nextKey, typeof value === "string"
+                ? value
+                : { text: value.text, runs: value.runs.map((run) => ({ ...run })) });
+            sharedStringIndexMap.set(key, nextKey);
+            return nextKey;
+        };
+        const collectCellXfs = (value) => {
+            if (!cellXfs || !isStyleReference(value)) {
+                return;
+            }
+            const styleId = getStyleId(value);
+            if (!styleId || copiedCellXfs.has(styleId)) {
+                return;
+            }
+            if (cellXfs.has(styleId)) {
+                copiedCellXfs.set(styleId, cellXfs.get(styleId));
+            }
+        };
+        let colGroups = `<colgroup>`;
+        copiedSelections.forEach(({ range }) => {
+            const { startColumnIndex, endColumnIndex } = range;
+            for (let columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                if (isColHidden(sheetId, columnIndex))
+                    continue;
+                const cellWidth = getColumnWidth(sheetId, columnIndex);
+                colGroups += `<col width="${cellWidth}" />`;
+            }
+        });
+        colGroups += `</colgroup>`;
+        let htmlString = `<html xmlns:v="urn:schemas-microsoft-com:vml"
+        xmlns:o="urn:schemas-microsoft-com:office:office"
+        xmlns:x="urn:schemas-microsoft-com:office:excel"
+        xmlns="http://www.w3.org/TR/REC-html40">
+            <meta http-equiv=Content-Type content="text/html; charset=utf-8">
+            <style>
+              <!--table{mso-displayed-decimal-separator:"\."; mso-displayed-thousand-separator:"\,";}tr{mso-height-source:auto;}col{mso-width-source:auto;}-->
+            </style>
+            <style type="text/css"><!--td {border: 1px solid #cccccc;}br {mso-data-placement:same-cell;}--></style><body>
+          <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">${colGroups}<tbody>`;
+        for (const { range } of copiedSelections) {
+            const { startRowIndex, startColumnIndex, endColumnIndex, endRowIndex } = range;
+            /* Check if user is copying a table */
+            const table = sheetTables?.find((table) => areaInsideArea(table.range, range) && table.sheetId === sheetId);
+            if (table) {
+                // We need to set a rowDelta and colDelta
+                const rowDelta = table.range.startRowIndex - range.startRowIndex;
+                const colDelta = table.range.startColumnIndex - range.startColumnIndex;
+                // Add table
+                tables.push({
+                    ...table,
+                    rowDelta,
+                    colDelta,
+                });
+            }
+            /* Iterate over all cells */
+            for (let rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
+                if (isRowHidden(sheetId, rowIndex)) {
+                    continue;
+                }
+                const rowHeight = getRowHeight(sheetId, rowIndex);
+                htmlString += `<tr style="height:${rowHeight}px">`;
+                const csvRow = [];
+                const jsonRow = [];
+                for (let columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                    if (isColHidden(sheetId, columnIndex)) {
+                        continue;
+                    }
+                    const mergedCellInfo = mergedCellMap.get(cellIdentifier(rowIndex, columnIndex));
+                    const isMasterCell = mergedCellInfo ? mergedCellInfo[0] : true;
+                    if (!isMasterCell) {
+                        jsonRow.push({
+                            data: undefined,
+                        });
+                        continue;
+                    }
+                    const [rowspan, colspan] = mergedCellInfo
+                        ? mergedCellInfo[1]
+                        : [1, 1];
+                    const formattedValue = getFormattedValue(sheetId, rowIndex, columnIndex) ?? "";
+                    const cellData = getCellData(sheetId, rowIndex, columnIndex);
+                    let normalizedCellData = cellData;
+                    if (cellData && typeof cellData === "object") {
+                        normalizedCellData = { ...cellData };
+                        if (!isNil(normalizedCellData.ss)) {
+                            normalizedCellData.ss = collectSharedString(String(normalizedCellData.ss));
+                        }
+                        collectCellXfs(normalizedCellData.uf);
+                        collectCellXfs(normalizedCellData.ef);
+                    }
+                    const formula = getExtendedValueFormula(getCellUserEnteredValue(cellData));
+                    const origin = cellToAddress({ rowIndex, columnIndex }) ??
+                        `${rowIndex}:${columnIndex}`;
+                    const formulaAttr = formula
+                        ? ` data-sheets-formula="${escapeHtmlAttribute(formula)}" data-formula="${escapeHtmlAttribute(formula)}" data-sheets-formula-origin="${escapeHtmlAttribute(origin)}" data-formula-origin="${escapeHtmlAttribute(origin)}"`
+                        : "";
+                    const effectiveFormat = getEffectiveFormat?.(sheetId, rowIndex, columnIndex);
+                    const bandedFormat = bandedCells?.get(cellIdentifier(rowIndex, columnIndex));
+                    const numberFormatType = effectiveFormat?.numberFormat?.type;
+                    const numberFormatPattern = effectiveFormat?.numberFormat?.pattern;
+                    const numberFormatAttr = numberFormatType
+                        ? ` data-sheets-numberformat-type="${escapeHtmlAttribute(numberFormatType)}"${numberFormatPattern
+                            ? ` data-sheets-numberformat-pattern="${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.
+                    const horizontalAlignment = effectiveFormat?.horizontalAlignment;
+                    const verticalAlignment = effectiveFormat?.verticalAlignment;
+                    const alignmentAttr = `${horizontalAlignment
+                        ? ` data-sheets-horizontal-alignment="${escapeHtmlAttribute(horizontalAlignment)}"`
+                        : ""}${verticalAlignment
+                        ? ` data-sheets-vertical-alignment="${escapeHtmlAttribute(verticalAlignment)}"`
+                        : ""}`;
+                    // Csv
+                    csvRow.push(formattedValue);
+                    // Style
+                    const isItalic = effectiveFormat?.textFormat?.italic;
+                    const isBold = effectiveFormat?.textFormat?.bold;
+                    const isUnderline = effectiveFormat?.textFormat?.underline;
+                    const isStrikeThrough = effectiveFormat?.textFormat?.strikethrough;
+                    const baselineOffset = effectiveFormat?.textFormat?.baselineOffset;
+                    // Cell-level formatting wins over the banded (table style) layer,
+                    // matching the canvas grid's merge order.
+                    const cellBorders = effectiveFormat?.borders ?? bandedFormat?.borders;
+                    const borderTop = cellBorders?.top;
+                    const borderBottom = cellBorders?.bottom;
+                    const borderLeft = cellBorders?.left;
+                    const borderRight = cellBorders?.right;
+                    const textDecoration = `${isUnderline ? "underline" : ""} ${isStrikeThrough ? "line-through" : ""}`.trim();
+                    const wordWrap = effectiveFormat?.wrapStrategy === "wrap";
+                    const style = theme
+                        ? {
+                            "background-color": getStringifiedColor(effectiveFormat?.backgroundColor ??
+                                bandedFormat?.backgroundColor, theme),
+                            color: getStringifiedColor(effectiveFormat?.textFormat?.color ??
+                                bandedFormat?.textFormat?.color, theme),
+                            padding: "2px 3px 2px 3px",
+                            overflow: "hidden",
+                            "font-weight": isBold ? "700" : "normal",
+                            "font-family": effectiveFormat?.textFormat?.fontFamily,
+                            "font-style": isItalic ? "italic" : "normal",
+                            "text-decoration": textDecoration
+                                ? textDecoration
+                                : undefined,
+                            "font-size": `${effectiveFormat?.textFormat?.fontSize ?? 10}pt`,
+                            "text-align": effectiveFormat?.horizontalAlignment,
+                            "vertical-align": effectiveFormat?.verticalAlignment,
+                            "border-top": borderTop
+                                ? `${borderTop.width}px solid ${getStringifiedColor(borderTop.color, theme)}`
+                                : undefined,
+                            "border-left": borderLeft
+                                ? `${borderLeft.width}px solid ${getStringifiedColor(borderLeft.color, theme)}`
+                                : undefined,
+                            "border-right": borderRight
+                                ? `${borderRight.width}px solid ${getStringifiedColor(borderRight.color, theme)}`
+                                : undefined,
+                            "border-bottom": borderBottom
+                                ? `${borderBottom.width}px solid ${getStringifiedColor(borderBottom.color, theme)}`
+                                : undefined,
+                            "text-wrap": wordWrap ? "wrap" : undefined,
+                        }
+                        : {};
+                    // html
+                    const innerHtml = baselineOffset === "superscript"
+                        ? `<sup>${formattedValue}</sup>`
+                        : baselineOffset === "subscript"
+                            ? `<sub>${formattedValue}</sub>`
+                            : formattedValue;
+                    htmlString +=
+                        `<td${formulaAttr}${numberFormatAttr}${alignmentAttr} ${rowspan > 1 ? `rowspan="${rowspan}"` : ""} ${colspan > 1 ? `colspan="${colspan}"` : ""} style='${Object.entries(style)
+                            .filter(([_, v]) => !isNil(v))
+                            .map(([k, v]) => `${k}:${v}`)
+                            .join(";")}'>` +
+                            innerHtml +
+                            "</td>";
+                    // json
+                    jsonRow.push({
+                        data: normalizedCellData,
+                        sourceCell: { rowIndex, columnIndex },
+                        rowspan,
+                        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>";
+        }
+        const csvStr = csv.join("\n");
+        const 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());
+        }
+        e?.clipboardData?.setData("text/html", htmlString);
+        e?.clipboardData?.setData("text/plain", plainTextStr);
+        e?.clipboardData?.setData("text/csv", csvStr);
+        e?.clipboardData?.setData("application/json", JSON.stringify(copiedSchema));
+    }, [
+        theme,
+        sheetTables,
+        bandedRanges,
+        getFormattedValue,
+        getCellData,
+        getRowHeight,
+        getColumnWidth,
+        getEffectiveFormat,
+        mergedCellMap,
+        cellXfs,
+        sharedStrings,
+        isColumnHidden,
+        isHiddenRow,
+    ]);
+};
+// Merge cell map
+export const useMergedCellMap = (merges) => {
+    return useMemo(() => {
+        const mergedCellMap = new Map();
+        const finalMerges = merges ?? [];
+        for (let i = 0; i < finalMerges.length; i++) {
+            const range = finalMerges[i];
+            const { startRowIndex, startColumnIndex, endColumnIndex, endRowIndex } = range;
+            for (const [rowIndex, columnIndex] of iterateCellsInRange(range)) {
+                const isMasterCell = rowIndex === startRowIndex && columnIndex === startColumnIndex;
+                const spans = isMasterCell
+                    ? [
+                        endRowIndex - startRowIndex + 1,
+                        endColumnIndex - startColumnIndex + 1,
+                    ]
+                    : [1, 1];
+                mergedCellMap.set(cellIdentifier(rowIndex, columnIndex), [
+                    isMasterCell,
+                    spans,
+                ]);
+            }
+        }
+        return mergedCellMap;
+    }, [merges]);
+};

package/dist/esm/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/esm/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/esm/hooks/use-on-create-named-range.js

@@ -0,0 +1,32 @@
+import { useCallback } from "react";
+import { createNamedRange } from "../interface/named-range-operations";
+import { useCanEditSheet } from "./use-can-edit-cellrange";
+export const useOnCreateNamedRange = ({ enqueueCalculation, createHistory, onChangeNamedRanges, onCommand, }) => {
+    const canEditSheet = useCanEditSheet();
+    return useCallback((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,
+            createHistory,
+            onChangeNamedRanges,
+        })(sheetId, namedRange);
+        onCommand?.({
+            command: "create-named-range",
+            sheetId,
+            namedRange,
+        });
+    }, [
+        onChangeNamedRanges,
+        createHistory,
+        enqueueCalculation,
+        onCommand,
+        canEditSheet,
+    ]);
+};

package/dist/esm/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/esm/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"}