@rowsncolumns/spreadsheet-state 28.0.66

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-move-rows.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-move-rows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAa,MAAM,4BAA4B,CAAC;AAE3E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAUtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,KAAK,kBAAkB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,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,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IACtE,0BAA0B,CAAC,EAAE,mBAAmB,CAC9C,CAAC,EACD,CAAC,CACF,CAAC,4BAA4B,CAAC,CAAC;IAChC,uBAAuB,CAAC,EAAE,mBAAmB,CAC3C,CAAC,EACD,CAAC,CACF,CAAC,yBAAyB,CAAC,CAAC;IAC7B,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,eAAe,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAC3E,sBAAsB,CAAC,EAAE,UAAU,CACjC,OAAO,kBAAkB,CAC1B,CAAC,wBAAwB,CAAC,CAAC;IAC5B,aAAa,EAAE,MAAM,aAAa,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,+RAiBhE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,eAGb,MAAM,QAAQ,MAAM,EAAE,qBAAqB,MAAM,SA2U9D,CAAC"}

package/dist/esm/hooks/use-on-move-rows.js

@@ -0,0 +1,264 @@
+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 { moveMergedCells } from "../api/merges";
+import { updateRangedRulesOnReorder } from "../api/range-rule-helpers";
+import { shiftTableMovingRows } from "../api/table";
+import { useCanEditSheet } from "./use-can-edit-cellrange";
+export const useOnMoveRows = ({ rowCount, columnCount, locale, createHistory, onChangeSheetData, onChangeSheets, onChangeTables, onChangeConditionalFormats, onChangeDataValidations, enqueueGraphOperation, enqueueCalculation, enqueueStructureChange, getDependents, getNonEmptyColumnCount, getActiveCell, onCommand, }) => {
+    const canEditSheet = useCanEditSheet();
+    return useCallback((sheetId, rows, referenceRowIndex) => {
+        if (!canEditSheet(sheetId)) {
+            console.debug("This range is protected, users cannot edit this cell range.");
+            return;
+        }
+        if (!rows.length) {
+            return;
+        }
+        const saveHistory = createHistory();
+        const { 0: firstRow, [rows.length - 1]: lastRow } = rows;
+        // We need to track this for history. Precedent cells
+        const recalcCells = new Map();
+        // Count
+        const count = rows.length;
+        const direction = referenceRowIndex <= firstRow ? Direction.Left : Direction.Right;
+        const delta = (direction === Direction.Right ? -1 : 1) * count;
+        const invalidationStartRowIndex = Math.max(1, Math.min(firstRow, referenceRowIndex));
+        const invalidationEndRowIndex = Math.min(rowCount, Math.max(lastRow, referenceRowIndex + count - 1));
+        enqueueStructureChange?.({
+            kind: "invalidate-range",
+            sheetId,
+            startRowIndex: invalidationStartRowIndex,
+            endRowIndex: invalidationEndRowIndex,
+            startColumnIndex: 1,
+            endColumnIndex: columnCount,
+        });
+        // Update sheets
+        onChangeSheets?.((prevSheets) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheets, (draft) => {
+                const sheet = draft.find((sheet) => sheet.sheetId === sheetId);
+                if (sheet) {
+                    if (!sheet.rowMetadata) {
+                        sheet.rowMetadata = [];
+                    }
+                    if (sheet.merges) {
+                        sheet.merges = moveMergedCells(sheet.merges, "row-insert", referenceRowIndex);
+                    }
+                    // Check if basicFilter needs to be moved
+                    if (sheet.basicFilter) {
+                        /**
+                         * Scenarios
+                         * 1. User is moving the entire table
+                         * 2. User is moving a row out of table => Not allowed
+                         * 3. User is moving a row inside a table
+                         * 4. User is moving a row from the bottom to top of the table => No changes to table required
+                         */
+                        shiftTableMovingRows(sheet.basicFilter, rows, referenceRowIndex);
+                    }
+                    const rowMetadatas = rows.map((columnIndex) => {
+                        return sheet.rowMetadata?.[columnIndex] ?? null;
+                    });
+                    // Remove
+                    sheet.rowMetadata.splice(firstRow, count);
+                    // Insert
+                    rows.forEach((_, index) => {
+                        // Fixes a bug when u drag a column adjacent to modified column
+                        // Modify A size, and drag it before G
+                        sheet.rowMetadata.splice(referenceRowIndex + index, 0, {});
+                        sheet.rowMetadata[referenceRowIndex + index] =
+                            rowMetadatas[index];
+                    });
+                }
+            });
+            // Save history
+            saveHistory({
+                sheets: { patches, inversePatches },
+            });
+            return nextState;
+        });
+        // Remove columns and insert them at referenceRowIndex
+        // Update sheet data
+        onChangeSheetData?.((prevSheetData) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevSheetData, (draft) => {
+                const currentSheet = createSheetDraft(draft, sheetId, referenceRowIndex);
+                const sourceRange = {
+                    startColumnIndex: 1,
+                    endColumnIndex: columnCount,
+                    startRowIndex: firstRow,
+                    endRowIndex: lastRow,
+                };
+                // Process formulas of moved columns
+                const movedKeys = new Set();
+                // Update formulas
+                for (const [rowIndex, columnIndex] of iterateCellsInRange({
+                    ...sourceRange,
+                    endColumnIndex: (rowIndex) => getNonEmptyColumnCount?.(sheetId, rowIndex) ?? columnCount,
+                })) {
+                    const rowDelta = referenceRowIndex - firstRow;
+                    const columnDelta = 0;
+                    // Process dependents
+                    processSideEffectDependentCells({
+                        draft,
+                        rowIndex,
+                        columnIndex,
+                        sheetId,
+                        columnDelta,
+                        enqueueGraphOperation,
+                        enqueueCalculation,
+                        getDependents,
+                        recalcCells,
+                        rowDelta,
+                        sourceRange,
+                        movedKeys,
+                        locale,
+                        rowCount,
+                        columnCount,
+                    });
+                }
+                // When you move columns, the resident columns
+                // gets shifted
+                const shiftedRange = {
+                    startColumnIndex: 1,
+                    endColumnIndex: columnCount,
+                    startRowIndex: Math.min(referenceRowIndex + count, firstRow),
+                    endRowIndex: Math.max(referenceRowIndex - count, firstRow),
+                };
+                // Update formulas
+                for (const [rowIndex, columnIndex] of iterateCellsInRange({
+                    ...shiftedRange,
+                    endColumnIndex: (rowIndex) => getNonEmptyColumnCount?.(sheetId, rowIndex) ?? columnCount,
+                })) {
+                    const rowDelta = delta;
+                    const columnDelta = 0;
+                    // Process dependents
+                    processSideEffectDependentCells({
+                        draft,
+                        rowIndex,
+                        columnIndex,
+                        sheetId,
+                        columnDelta,
+                        enqueueGraphOperation,
+                        enqueueCalculation,
+                        getDependents,
+                        recalcCells,
+                        rowDelta,
+                        sourceRange: shiftedRange,
+                        movedKeys,
+                        locale,
+                        rowCount,
+                        columnCount,
+                    });
+                }
+                // Array mututation
+                const rowValues = rows.map((rowIndex) => currentSheet[rowIndex]);
+                // Remove
+                currentSheet.splice(firstRow, count);
+                // Insert
+                rows.forEach((_, index) => {
+                    currentSheet.splice(referenceRowIndex + index, 0, { values: [] });
+                    currentSheet[referenceRowIndex + index] = rowValues[index];
+                });
+            });
+            // Save history
+            saveHistory({
+                sheetData: { patches, inversePatches },
+                recalcCells: { undo: recalcCells, redo: recalcCells },
+                activeCell: {
+                    undo: getActiveCell(),
+                    redo: { ...getActiveCell(), rowIndex: referenceRowIndex },
+                },
+                selections: {
+                    undo: [
+                        {
+                            range: {
+                                startRowIndex: firstRow,
+                                endRowIndex: lastRow,
+                                startColumnIndex: 1,
+                                endColumnIndex: columnCount,
+                            },
+                        },
+                    ],
+                    redo: [
+                        {
+                            range: {
+                                startRowIndex: referenceRowIndex,
+                                endRowIndex: referenceRowIndex + count - 1,
+                                startColumnIndex: 1,
+                                endColumnIndex: columnCount,
+                            },
+                        },
+                    ],
+                },
+            });
+            return nextState;
+        });
+        // Update move tables if user is moving rows
+        onChangeTables?.((prevTables) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevTables, (draft) => {
+                for (const table of draft) {
+                    if (table.sheetId !== sheetId) {
+                        continue;
+                    }
+                    /**
+                     * Scenarios
+                     * 1. User is moving the entire table
+                     * 2. User is moving a row out of table => Not allowed
+                     * 3. User is moving a row inside a table
+                     * 4. User is moving a row from the bottom to top of the table => No changes to table required
+                     */
+                    shiftTableMovingRows(table, rows, referenceRowIndex);
+                }
+            });
+            saveHistory({
+                tables: {
+                    patches,
+                    inversePatches,
+                },
+            });
+            return nextState;
+        });
+        // Re-anchor CF / DV ranges to follow the moved rows. Matches
+        // Excel's cell-tracking semantics for single-range rules.
+        onChangeDataValidations?.((prevValidations) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevValidations, (draft) => {
+                updateRangedRulesOnReorder(draft, "row", firstRow, lastRow, referenceRowIndex, sheetId);
+            });
+            saveHistory({ dataValidations: { patches, inversePatches } });
+            return nextState;
+        });
+        onChangeConditionalFormats?.((prevConditionalFormats) => {
+            const [nextState, patches, inversePatches] = produceWithPatches(prevConditionalFormats, (draft) => {
+                updateRangedRulesOnReorder(draft, "row", firstRow, lastRow, referenceRowIndex, sheetId);
+            });
+            saveHistory({ conditionalFormats: { patches, inversePatches } });
+            return nextState;
+        });
+        onCommand?.({
+            command: "move-rows",
+            sheetId,
+            rows,
+            referenceRowIndex,
+        });
+    }, [
+        rowCount,
+        columnCount,
+        locale,
+        getActiveCell,
+        getNonEmptyColumnCount,
+        onChangeSheetData,
+        onChangeSheets,
+        createHistory,
+        onChangeTables,
+        onChangeConditionalFormats,
+        onChangeDataValidations,
+        enqueueGraphOperation,
+        enqueueCalculation,
+        enqueueStructureChange,
+        getDependents,
+        canEditSheet,
+        onCommand,
+    ]);
+};

package/dist/esm/hooks/use-on-move-selection.d.ts

@@ -0,0 +1,35 @@
+import type { CellInterface, SelectionArea } from "@rowsncolumns/common-types";
+import type { CellData, SelectionAttributes, Sheet, TableView } from "@rowsncolumns/spreadsheet";
+import type { OnCommand } from "../commands";
+import type { CalculationOperation, useCalculation } from "./use-calculation";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { useSheetProperties } from "./use-sheet-properties";
+import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
+import type { SharedStringRegistry } from "./use-ss-registry";
+import type { SpreadsheetPatch } from "./use-undo-redo";
+export type UseOnMoveSelectionProps<T extends CellData, S extends Sheet> = {
+    rowCount: number;
+    columnCount: number;
+    tables?: TableView[];
+    locale?: string;
+    cellXfsRegistry?: CellXfsRegistry;
+    sharedStringRegistry?: SharedStringRegistry;
+    getDataValidationById?: ReturnType<typeof useSheetProperties>["getDataValidationById"];
+    createHistory: () => (patches: SpreadsheetPatch) => void;
+    enqueueCalculation: ReturnType<typeof useCalculation>["enqueueCalculation"];
+    enqueueStructureChange?: ReturnType<typeof useCalculation>["enqueueStructureChange"];
+    enqueueGraphOperation: ReturnType<typeof useCalculation>["enqueueGraphOperation"];
+    isArrayFormula(position: CalculationOperation["position"]): boolean;
+    onChangeSheetData: UseSpreadsheetProps<T, S>["onChangeSheetData"];
+    onChangeTables: UseSpreadsheetProps<T, S>["onChangeTables"];
+    onChangeSheets: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    onChangeNamedRanges: UseSpreadsheetProps<T, S>["onChangeNamedRanges"];
+    onChangeDataValidations?: UseSpreadsheetProps<T, S>["onChangeDataValidations"];
+    onChangeConditionalFormats?: UseSpreadsheetProps<T, S>["onChangeConditionalFormats"];
+    onChangePivotTables?: UseSpreadsheetProps<T, S>["onChangePivotTables"];
+    getDependents: ReturnType<typeof useCalculation>["getDependents"];
+    getActiveCell: () => CellInterface;
+    onCommand?: OnCommand;
+};
+export declare const useOnMoveSelection: <T extends CellData, S extends Sheet>({ rowCount, columnCount, tables, locale, cellXfsRegistry, sharedStringRegistry, getDependents, getActiveCell, onChangeTables, onChangeSheets, onChangeNamedRanges, onChangeDataValidations, onChangeConditionalFormats, onChangePivotTables, onChangeSheetData, createHistory, enqueueGraphOperation, enqueueCalculation, enqueueStructureChange, isArrayFormula, getDataValidationById, onCommand, }: UseOnMoveSelectionProps<T, S>) => (sheetId: number, from: SelectionArea<SelectionAttributes>, to: SelectionArea<SelectionAttributes>) => void;
+//# sourceMappingURL=use-on-move-selection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-on-move-selection.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-move-selection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE/E,OAAO,KAAK,EACV,QAAQ,EACR,mBAAmB,EACnB,KAAK,EACL,SAAS,EACV,MAAM,2BAA2B,CAAC;AAcnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAQ7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,qBAAqB,CAAC,EAAE,UAAU,CAChC,OAAO,kBAAkB,CAC1B,CAAC,uBAAuB,CAAC,CAAC;IAC3B,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,cAAc,CAAC,QAAQ,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;IACpE,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,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IACtE,uBAAuB,CAAC,EAAE,mBAAmB,CAC3C,CAAC,EACD,CAAC,CACF,CAAC,yBAAyB,CAAC,CAAC;IAC7B,0BAA0B,CAAC,EAAE,mBAAmB,CAC9C,CAAC,EACD,CAAC,CACF,CAAC,4BAA4B,CAAC,CAAC;IAChC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IACvE,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,aAAa,EAAE,MAAM,aAAa,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,EAAE,uYAuBrE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,eAkBjB,MAAM,QACT,aAAa,CAAC,mBAAmB,CAAC,MACpC,aAAa,CAAC,mBAAmB,CAAC,SA6f3C,CAAC"}