@rowsncolumns/spreadsheet-state 28.0.66

package/dist/esm/hooks/use-on-move-table-columns.js

@@ -0,0 +1,235 @@
+import { Direction } from "@rowsncolumns/grid";
+import { iterateCellsInRange } from "@rowsncolumns/utils";
+import { produceWithPatches } from "immer";
+import { useCallback } from "react";
+import { processSideEffectDependentCells } from "../api/dependency";
+import { createSheetDraft } from "../api/immer-utils";
+import { updateRangedRulesOnReorder } from "../api/range-rule-helpers";
+export const useOnMoveTableColumns = ({ rowCount, columnCount, locale, createHistory, onChangeSheetData, onChangeTables, onChangeConditionalFormats, onChangeDataValidations, enqueueGraphOperation, enqueueCalculation, enqueueStructureChange, getDependents, }) => {
+    return useCallback((sheetId, table, columns, referenceColumnIndex) => {
+        const saveHistory = createHistory();
+        const { 0: firstColumn, [columns.length - 1]: lastColumn } = columns;
+        // We need to track this for history. Precedent cells
+        const recalcCells = new Map();
+        // Count
+        const count = columns.length;
+        const direction = referenceColumnIndex <= firstColumn ? Direction.Left : Direction.Right;
+        const delta = (direction === Direction.Right ? -1 : 1) * count;
+        const invalidationStartColumnIndex = Math.max(table.range.startColumnIndex, Math.min(firstColumn, referenceColumnIndex));
+        const invalidationEndColumnIndex = Math.min(table.range.endColumnIndex, Math.max(lastColumn, referenceColumnIndex + count - 1));
+        enqueueStructureChange?.({
+            kind: "invalidate-range",
+            sheetId,
+            startRowIndex: table.range.startRowIndex,
+            endRowIndex: table.range.endRowIndex,
+            startColumnIndex: invalidationStartColumnIndex,
+            endColumnIndex: invalidationEndColumnIndex,
+        });
+        const sourceRange = {
+            ...table.range,
+            startColumnIndex: firstColumn,
+            endColumnIndex: lastColumn,
+        };
+        // When you move columns, the resident columns
+        // gets shifted
+        const shiftedRange = {
+            ...table.range,
+            startColumnIndex: Math.min(referenceColumnIndex + count, firstColumn + count),
+            endColumnIndex: Math.max(referenceColumnIndex - count, firstColumn),
+        };
+        // Remove columns and insert them at referenceColumnIndex
+        // Update sheet data
+        onChangeSheetData?.((prevSheetData) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheetData, (draft) => {
+                // Process formulas of moved columns
+                const movedKeys = new Set();
+                // Update formulas
+                for (const [rowIndex, columnIndex] of iterateCellsInRange(sourceRange)) {
+                    const columnDelta = referenceColumnIndex - firstColumn;
+                    const rowDelta = 0;
+                    // Process dependents
+                    processSideEffectDependentCells({
+                        draft,
+                        rowIndex,
+                        columnIndex,
+                        sheetId,
+                        columnDelta,
+                        enqueueGraphOperation,
+                        enqueueCalculation,
+                        getDependents,
+                        recalcCells,
+                        rowDelta,
+                        sourceRange,
+                        movedKeys,
+                        locale,
+                        rowCount,
+                        columnCount,
+                    });
+                }
+                movedKeys.clear();
+                // Update formulas
+                for (const [rowIndex, columnIndex] of iterateCellsInRange(shiftedRange)) {
+                    const columnDelta = delta;
+                    const rowDelta = 0;
+                    // Process dependents
+                    processSideEffectDependentCells({
+                        draft,
+                        rowIndex,
+                        columnIndex,
+                        sheetId,
+                        columnDelta,
+                        enqueueGraphOperation,
+                        enqueueCalculation,
+                        getDependents,
+                        recalcCells,
+                        rowDelta,
+                        sourceRange: shiftedRange,
+                        movedKeys,
+                        locale,
+                        rowCount,
+                        columnCount,
+                    });
+                }
+                for (let rowIndex = table.range.startRowIndex; rowIndex <= table.range.endRowIndex; rowIndex++) {
+                    const currentSheet = createSheetDraft(draft, sheetId, rowIndex);
+                    // Save columns being moved
+                    const columnValues = columns.map((columnIndex) => currentSheet[rowIndex].values[columnIndex]);
+                    // Remove
+                    currentSheet[rowIndex].values.splice(firstColumn, count);
+                    // Insert
+                    columns.forEach((_, index) => {
+                        currentSheet[rowIndex].values.splice(referenceColumnIndex + index, 0, {});
+                        currentSheet[rowIndex].values[referenceColumnIndex + index] =
+                            columnValues[index];
+                    });
+                }
+            });
+            // Save history
+            saveHistory({
+                sheetData: { patches, inversePatches },
+                recalcCells: { undo: recalcCells, redo: recalcCells },
+                activeCell: {
+                    undo: {
+                        rowIndex: sourceRange.startRowIndex,
+                        columnIndex: firstColumn,
+                    },
+                    redo: {
+                        rowIndex: sourceRange.startRowIndex,
+                        columnIndex: referenceColumnIndex,
+                    },
+                },
+                selections: {
+                    undo: [
+                        {
+                            range: {
+                                ...table.range,
+                                startColumnIndex: firstColumn,
+                                endColumnIndex: lastColumn,
+                            },
+                        },
+                    ],
+                    redo: [
+                        {
+                            range: {
+                                ...table.range,
+                                startColumnIndex: referenceColumnIndex,
+                                endColumnIndex: referenceColumnIndex + count - 1,
+                            },
+                        },
+                    ],
+                },
+            });
+            return nextState;
+        });
+        // Update table
+        // Move tables if necessary
+        onChangeTables?.((prevTables) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevTables, (draft) => {
+                const curTable = draft.find((cur) => cur.id === table.id);
+                if (curTable && curTable.columns) {
+                    // The column that is being moved
+                    const fromIndex = columns[0];
+                    const columnsToMove = curTable.columns?.splice(firstColumn - curTable.range.startColumnIndex, count);
+                    curTable.columns.splice(referenceColumnIndex - curTable.range.startColumnIndex, 0, ...columnsToMove);
+                    // Update sort specs
+                    if (curTable.sortSpecs) {
+                        curTable.sortSpecs = updateSpecs(curTable.sortSpecs, "dimensionIndex", fromIndex, referenceColumnIndex);
+                    }
+                    // Update filter specs
+                    if (curTable.filterSpecs) {
+                        curTable.filterSpecs = updateSpecs(curTable.filterSpecs, "columnIndex", fromIndex, referenceColumnIndex);
+                    }
+                }
+            });
+            // Update table
+            saveHistory({
+                tables: { patches, inversePatches },
+            });
+            return nextState;
+        });
+        // Re-anchor CF / DV ranges that overlap the table's row band.
+        // Outside the band, no cells moved, so the rule's columns
+        // shouldn't shift either — `orthogonalBoundary` carries that.
+        const tableRowBand = {
+            start: table.range.startRowIndex,
+            end: table.range.endRowIndex,
+        };
+        onChangeDataValidations?.((prevValidations) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevValidations, (draft) => {
+                updateRangedRulesOnReorder(draft, "column", firstColumn, lastColumn, referenceColumnIndex, sheetId, tableRowBand);
+            });
+            saveHistory({ dataValidations: { patches, inversePatches } });
+            return nextState;
+        });
+        onChangeConditionalFormats?.((prevConditionalFormats) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevConditionalFormats, (draft) => {
+                updateRangedRulesOnReorder(draft, "column", firstColumn, lastColumn, referenceColumnIndex, sheetId, tableRowBand);
+            });
+            saveHistory({ conditionalFormats: { patches, inversePatches } });
+            return nextState;
+        });
+    }, [
+        rowCount,
+        columnCount,
+        locale,
+        onChangeSheetData,
+        onChangeTables,
+        onChangeConditionalFormats,
+        onChangeDataValidations,
+        createHistory,
+        enqueueGraphOperation,
+        enqueueCalculation,
+        enqueueStructureChange,
+        getDependents,
+    ]);
+};
+/**
+ * Update filter specs
+ * @param specs
+ * @param fromIndex
+ * @param toIndex
+ * @returns
+ */
+const updateSpecs = (specs, dimensionIndex, fromIndex, toIndex) => {
+    return specs.map((spec) => {
+        const columnIndex = spec[dimensionIndex];
+        if (columnIndex === fromIndex) {
+            // Move the column to its new position
+            return { ...spec, [dimensionIndex]: toIndex };
+        }
+        else if (fromIndex < toIndex) {
+            // Moving right
+            if (columnIndex > fromIndex && columnIndex <= toIndex) {
+                return { ...spec, [dimensionIndex]: columnIndex - 1 };
+            }
+        }
+        else if (fromIndex > toIndex) {
+            // Moving left
+            if (columnIndex >= toIndex && columnIndex < fromIndex) {
+                return { ...spec, [dimensionIndex]: columnIndex + 1 };
+            }
+        }
+        // If the column is not affected, return it unchanged
+        return spec;
+    });
+};

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

@@ -0,0 +1,79 @@
+import type { Citation } from "@rowsncolumns/common-types";
+import type { CellInterface, SelectionArea } from "@rowsncolumns/grid";
+import type { CellData, DataValidationRuleRecord, SelectionAttributes, Sheet, TableView } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { GeneratedNames } from "../generated-names";
+import type { useCalculation } from "./use-calculation";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { useSheetProperties } from "./use-sheet-properties";
+import type { useSheetState } from "./use-sheet-state";
+import type { SheetData, UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SharedStringRegistry } from "./use-ss-registry";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+type DestinationRowAssignment = {
+    rowIndex: number;
+    dataRowIndex: number;
+};
+export declare const buildDestinationRowAssignments: (sheetId: number, startRowIndex: number, endRowIndex: number, rowSpan: number, isRowHidden: (sheetId: number, rowIndex: number) => boolean) => DestinationRowAssignment[];
+type UseOnPasteProps<T extends CellData, S extends Sheet> = {
+    rowCount: number;
+    columnCount: number;
+    sheetData?: SheetData<T>;
+    locale?: string;
+    maxRowCount?: number;
+    maxColumnCount?: number;
+    cellXfsRegistry?: CellXfsRegistry;
+    sharedStringRegistry?: SharedStringRegistry;
+    getDataValidationById?: (id: DataValidationRuleRecord["id"]) => DataValidationRuleRecord | undefined;
+    tables?: TableView[];
+    isHiddenByFilterRow: ReturnType<typeof useSheetProperties>["isHiddenByFilterRow"];
+    createHistory: () => (patches: SpreadsheetPatch) => void;
+    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"];
+    onChangeTables: UseSpreadsheetProps<T, S>["onChangeTables"];
+    onChangeEmbeds: UseSpreadsheetProps<T, S>["onChangeEmbeds"];
+    onRequestFonts: UseSpreadsheetProps<T, S>["onRequestFonts"];
+    onChangeDataValidations: UseSpreadsheetProps<T, S>["onChangeDataValidations"];
+    onChangeSelections: ReturnType<typeof useSheetState>["onChangeSelections"];
+    onChangeActiveCell(sheetId: number, cell: CellInterface): void;
+    getDependents: ReturnType<typeof useCalculation>["getDependents"];
+    getActiveCell: () => CellInterface;
+    getSheetName(sheetId: number): string;
+    getUserEnteredValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined;
+    /**
+     * Preserve data formatting on paste operation
+     */
+    preserveFormatting?: boolean;
+    /**
+     * Id creation strategy
+     */
+    idCreationStrategy?: UseSpreadsheetProps<T, S>["idCreationStrategy"];
+    /**
+     * Error handler
+     */
+    onError?: (message: string) => void;
+    /**
+     * Citations array
+     */
+    citations?: Citation[];
+    /**
+     * Callback when citations change
+     */
+    onChangeCitations?: UseSpreadsheetProps<T, S>["onChangeCitations"];
+    /**
+     * Optional HTML sanitizer for clipboard paste operations
+     */
+    sanitizeHtml?: (html: string) => string;
+    /**
+     * Streams the paste as a semantic command so an engine consumer (which holds the full,
+     * windowed document) re-applies the written values and recomputes dependents.
+     */
+    onCommand?: OnCommand;
+    generatedNames?: GeneratedNames;
+};
+export declare const useOnPaste: <T extends CellData, S extends Sheet>({ rowCount, columnCount, locale, sheetData, tables: currentTables, maxRowCount, maxColumnCount, isHiddenByFilterRow, onRequestFonts, idCreationStrategy, createHistory, enqueueCalculation, enqueueStructureChange, enqueueGraphOperation, onChangeSheetData, onChangeSheets, onChangeTables, onChangeEmbeds, onChangeSelections, onChangeActiveCell, getDependents, getActiveCell, getUserEnteredValue, onChangeDataValidations, preserveFormatting, cellXfsRegistry, sharedStringRegistry, getDataValidationById, getSheetName, onError, citations, onChangeCitations, sanitizeHtml, onCommand, generatedNames, }: UseOnPasteProps<T, S>) => (e: ClipboardEvent | undefined, sourceSheetId: number | undefined, destinationSheetId: number, copiedSelections: SelectionArea<SelectionAttributes>[] | undefined, activeCell: CellInterface, selections: SelectionArea<SelectionAttributes>[] | undefined, finalSelections: SelectionArea<SelectionAttributes>[] | undefined, isCutOperation: boolean) => Promise<void>;
+export {};
+//# sourceMappingURL=use-on-paste.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-paste.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-paste.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAc,MAAM,4BAA4B,CAAC;AACvE,OAAO,KAAK,EACV,aAAa,EAEb,aAAa,EACd,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EACV,QAAQ,EACR,wBAAwB,EAGxB,mBAAmB,EACnB,KAAK,EACL,SAAS,EACV,MAAM,2BAA2B,CAAC;AAiCnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAqBzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,KAAK,wBAAwB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,8BAA8B,GACzC,SAAS,MAAM,EACf,eAAe,MAAM,EACrB,aAAa,MAAM,EACnB,SAAS,MAAM,EACf,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,KAC1D,wBAAwB,EAoB1B,CAAC;AAEF,KAAK,eAAe,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,qBAAqB,CAAC,EAAE,CACtB,EAAE,EAAE,wBAAwB,CAAC,IAAI,CAAC,KAC/B,wBAAwB,GAAG,SAAS,CAAC;IAC1C,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,mBAAmB,EAAE,UAAU,CAC7B,OAAO,kBAAkB,CAC1B,CAAC,qBAAqB,CAAC,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACzD,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,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,cAAc,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC5D,uBAAuB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC;IAC9E,kBAAkB,EAAE,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC3E,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC/D,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,aAAa,EAAE,MAAM,aAAa,CAAC;IACnC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC,mBAAmB,EAAE,CACnB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,KAChB,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;IACrE;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IACnE;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,qlBAoC7D,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,SAgCf,cAAc,GAAG,SAAS,iBACd,MAAM,GAAG,SAAS,sBACb,MAAM,oBACR,aAAa,CAAC,mBAAmB,CAAC,EAAE,GAAG,SAAS,cACtD,aAAa,cACb,aAAa,CAAC,mBAAmB,CAAC,EAAE,GAAG,SAAS,mBAC3C,aAAa,CAAC,mBAAmB,CAAC,EAAE,GAAG,SAAS,kBACjD,OAAO,kBA8qC5B,CAAC"}