@rowsncolumns/spreadsheet-state 29.0.0 → 29.1.0

package/dist/cjs/hooks/use-on-sort-column.js

@@ -1,9 +1,10 @@
-import { __read, __spreadArray, __values } from "tslib";
+import { __assign, __read, __spreadArray, __values } from "tslib";
 import { isStaticNode, } from "@rowsncolumns/dag";
 import { getCellUserEnteredValue, getExtendedValueFormula, getStringifiedColor, } from "@rowsncolumns/spreadsheet";
 import { produceWithPatches } from "immer";
 import { useCallback } from "react";
 import { createSheetCellIdentifier } from "../api/formula";
+import { getCellSortValue } from "../api/sort";
 import { createSheetDraft } from "../api/immer-utils";
 import { SheetCell } from "../sheet-cell";
 import { useShowError } from "../atoms/error-state.atom";
@@ -35,7 +36,7 @@ var buildSortValue = function (options, fallbackValue, getEffectiveFormat, theme
  * @returns
  */
 export var useOnSortColumn = function (_a) {
-    var rowCount = _a.rowCount, columnCount = _a.columnCount, locale = _a.locale, sharedStringRegistry = _a.sharedStringRegistry, createHistory = _a.createHistory, enqueueCalculation = _a.enqueueCalculation, enqueueStructureChange = _a.enqueueStructureChange, enqueueGraphOperation = _a.enqueueGraphOperation, onChangeSheetData = _a.onChangeSheetData, isHiddenRow = _a.isHiddenRow, getDependents = _a.getDependents, getFrozenRowCount = _a.getFrozenRowCount, getSheetName = _a.getSheetName, getEffectiveFormat = _a.getEffectiveFormat, theme = _a.theme, enableSortTimingLogs = _a.enableSortTimingLogs, onCommand = _a.onCommand;
+    var rowCount = _a.rowCount, columnCount = _a.columnCount, locale = _a.locale, sharedStringRegistry = _a.sharedStringRegistry, createHistory = _a.createHistory, enqueueCalculation = _a.enqueueCalculation, enqueueStructureChange = _a.enqueueStructureChange, enqueueGraphOperation = _a.enqueueGraphOperation, onChangeSheetData = _a.onChangeSheetData, onChangeSheets = _a.onChangeSheets, getCellData = _a.getCellData, getDataRowCount = _a.getDataRowCount, isHiddenRow = _a.isHiddenRow, isManuallyHiddenRow = _a.isManuallyHiddenRow, getDependents = _a.getDependents, getFrozenRowCount = _a.getFrozenRowCount, getSheetName = _a.getSheetName, getEffectiveFormat = _a.getEffectiveFormat, theme = _a.theme, enableSortTimingLogs = _a.enableSortTimingLogs, onCommand = _a.onCommand;
     var canEditSheet = useCanEditSheet();
     var canPerformSheetAction = useCanPerformSheetAction();
     var showError = useShowError();
@@ -46,6 +47,7 @@ export var useOnSortColumn = function (_a) {
      * column. Omitting this keeps the single-column behavior identical.
      */
     additionalLevels) {
+        var _a, _b;
         if (!canEditSheet(sheetId)) {
             console.debug("This range is protected, users cannot edit this cell range.");
             return;
@@ -75,108 +77,148 @@ export var useOnSortColumn = function (_a) {
             startColumnIndex: 1,
             endColumnIndex: columnCount,
         });
+        var startRowIndex = 1;
+        var startColumnIndex = 1;
+        var isPinnedRow = function (rowIndex) {
+            return isManuallyHiddenRow
+                ? isManuallyHiddenRow(sheetId, rowIndex)
+                : isHiddenRow(sheetId, rowIndex);
+        };
+        var overallStart = now();
+        // Gather the sort keys from the committed cell data. Pinned rows
+        // contribute no entry and are never rewritten.
+        var buildStart = now();
+        var dataRowCount = (_a = getDataRowCount(sheetId)) !== null && _a !== void 0 ? _a : 0;
+        var rowEntries = [];
+        var _loop_1 = function (rowIndex) {
+            var e_1, _c;
+            if (isPinnedRow(rowIndex)) {
+                return "continue";
+            }
+            // Build one sort value per level: the primary column first,
+            // then each "then by" column in order.
+            var buildLevelValue = function (columnIndex, levelOptions) {
+                var sortCell = new SheetCell(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, getCellData(sheetId, rowIndex, columnIndex), { locale: locale, sharedStringRegistry: sharedStringRegistry });
+                var fallbackValue = getCellSortValue(sortCell);
+                return buildSortValue(levelOptions, fallbackValue, getEffectiveFormat, theme, sheetId, rowIndex, columnIndex);
+            };
+            var sortValues = [
+                buildLevelValue(sortedColumnIndex, options),
+            ];
+            try {
+                for (var _d = (e_1 = void 0, __values(additionalLevels !== null && additionalLevels !== void 0 ? additionalLevels : [])), _e = _d.next(); !_e.done; _e = _d.next()) {
+                    var level = _e.value;
+                    sortValues.push(buildLevelValue(level.columnIndex, level));
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_e && !_e.done && (_c = _d.return)) _c.call(_d);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            rowEntries.push({ rowIndex: rowIndex, sortValues: sortValues });
+        };
+        for (var rowIndex = startRowIndex; rowIndex <= dataRowCount; rowIndex++) {
+            _loop_1(rowIndex);
+        }
+        var buildMs = now() - buildStart;
+        // The slots the sorted rows land on, ascending (the sort reorders
+        // `rowEntries` in place).
+        var destRows = rowEntries.map(function (entry) { return entry.rowIndex; });
+        // Sort data
+        var sortStart = now();
+        // Primary spec, then one spec per "then by" level. The order
+        // matches the sortValues built above so the comparator pairs
+        // each value with its spec. `sortedEntries[i]` is the row that
+        // lands on `destRows[i]`.
+        var specs = __spreadArray([
+            {
+                sortOrder: sortOrder,
+                sortBy: (_b = options === null || options === void 0 ? void 0 : options.sortBy) !== null && _b !== void 0 ? _b : "value",
+                // Pre-resolve the target color the same way the cell sort
+                // values are resolved, so sort-rows.ts can compare strings.
+                sortColor: getStringifiedColor(options === null || options === void 0 ? void 0 : options.sortColor, theme),
+                sortIcon: options === null || options === void 0 ? void 0 : options.sortIcon,
+                customList: options === null || options === void 0 ? void 0 : options.customList,
+            }
+        ], __read((additionalLevels !== null && additionalLevels !== void 0 ? additionalLevels : []).map(function (level) {
+            var _a;
+            return ({
+                sortOrder: level.sortOrder,
+                sortBy: (_a = level.sortBy) !== null && _a !== void 0 ? _a : "value",
+                sortColor: getStringifiedColor(level.sortColor, theme),
+                sortIcon: level.sortIcon,
+                customList: level.customList,
+            });
+        })), false);
+        var sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, specs);
+        var sortMs = now() - sortStart;
+        // Carry each row's `hiddenByFilter` flag to the row's destination: a
+        // sort does not re-evaluate the filter, so the hidden set follows the
+        // rows.
+        onChangeSheets === null || onChangeSheets === void 0 ? void 0 : onChangeSheets(function (prevSheets) {
+            var _a = __read(produceWithPatches(prevSheets, function (draft) {
+                var sheet = draft.find(function (sheet) { return sheet.sheetId === sheetId; });
+                if (!sheet) {
+                    return;
+                }
+                var hiddenByFilterAt = function (rowIndex) { var _a, _b; return Boolean((_b = (_a = sheet.rowMetadata) === null || _a === void 0 ? void 0 : _a[rowIndex]) === null || _b === void 0 ? void 0 : _b.hiddenByFilter); };
+                // Read every source flag before writing any destination.
+                var carried = destRows.map(function (rowIndex, index) { var _a, _b; return hiddenByFilterAt((_b = (_a = sortedEntries[index]) === null || _a === void 0 ? void 0 : _a.rowIndex) !== null && _b !== void 0 ? _b : rowIndex); });
+                destRows.forEach(function (rowIndex, index) {
+                    var hiddenByFilter = carried[index];
+                    if (hiddenByFilter === hiddenByFilterAt(rowIndex)) {
+                        return;
+                    }
+                    if (!sheet.rowMetadata) {
+                        sheet.rowMetadata = [];
+                    }
+                    sheet.rowMetadata[rowIndex] = __assign(__assign({}, sheet.rowMetadata[rowIndex]), { hiddenByFilter: hiddenByFilter });
+                });
+            }), 3), nextState = _a[0], patches = _a[1], inversePatches = _a[2];
+            if (!patches.length) {
+                return prevSheets;
+            }
+            saveHistory({ sheets: { patches: patches, inversePatches: inversePatches } });
+            return nextState;
+        });
         // Update sheet data
         onChangeSheetData === null || onChangeSheetData === void 0 ? void 0 : onChangeSheetData(function (prevSheetData) {
-            var overallStart = now();
-            var buildMs = 0;
-            var sortMs = 0;
             var applyMs = 0;
             var _a = __read(produceWithPatches(prevSheetData, function (draft) {
-                var e_1, _a;
-                var _b, _c, _d, _e, _f;
+                var e_2, _a, e_3, _b;
+                var _c, _d, _e;
                 var sheet = createSheetDraft(draft, sheetId);
-                var startRowIndex = 1;
-                var startColumnIndex = 1;
-                var rowCount = sheet.length;
-                var rowEntries = [];
                 var rowSnapshots = new Map();
-                var buildStart = now();
                 var maxColumnCount = 0;
-                var _loop_1 = function (rowIndex) {
-                    var e_2, _g;
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        return "continue";
+                try {
+                    for (var destRows_1 = __values(destRows), destRows_1_1 = destRows_1.next(); !destRows_1_1.done; destRows_1_1 = destRows_1.next()) {
+                        var rowIndex = destRows_1_1.value;
+                        var rowValues = (_d = (_c = sheet[rowIndex]) === null || _c === void 0 ? void 0 : _c.values) !== null && _d !== void 0 ? _d : [];
+                        maxColumnCount = Math.max(maxColumnCount, rowValues.length);
+                        rowSnapshots.set(rowIndex, rowValues.slice());
                     }
-                    var rowValue = sheet[rowIndex];
-                    var columnCount_1 = (_c = (_b = rowValue === null || rowValue === void 0 ? void 0 : rowValue.values) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0;
-                    maxColumnCount = Math.max(maxColumnCount, columnCount_1);
-                    rowSnapshots.set(rowIndex, ((_d = rowValue === null || rowValue === void 0 ? void 0 : rowValue.values) !== null && _d !== void 0 ? _d : []).slice());
-                    // Build one sort value per level: the primary column first,
-                    // then each "then by" column in order.
-                    var buildLevelValue = function (columnIndex, levelOptions) {
-                        var _a, _b;
-                        var sortCellData = (_a = rowValue === null || rowValue === void 0 ? void 0 : rowValue.values) === null || _a === void 0 ? void 0 : _a[columnIndex];
-                        var sortCell = new SheetCell(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, sortCellData, { locale: locale, sharedStringRegistry: sharedStringRegistry });
-                        var fallbackValue = (_b = sortCell.getEffectiveValue()) !== null && _b !== void 0 ? _b : sortCell.formattedValue;
-                        return buildSortValue(levelOptions, fallbackValue, getEffectiveFormat, theme, sheetId, rowIndex, columnIndex);
-                    };
-                    var sortValues = [
-                        buildLevelValue(sortedColumnIndex, options),
-                    ];
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
                     try {
-                        for (var _h = (e_2 = void 0, __values(additionalLevels !== null && additionalLevels !== void 0 ? additionalLevels : [])), _j = _h.next(); !_j.done; _j = _h.next()) {
-                            var level = _j.value;
-                            sortValues.push(buildLevelValue(level.columnIndex, level));
-                        }
+                        if (destRows_1_1 && !destRows_1_1.done && (_a = destRows_1.return)) _a.call(destRows_1);
                     }
-                    catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                    finally {
-                        try {
-                            if (_j && !_j.done && (_g = _h.return)) _g.call(_h);
-                        }
-                        finally { if (e_2) throw e_2.error; }
-                    }
-                    rowEntries.push({ rowIndex: rowIndex, sortValues: sortValues });
-                };
-                for (var rowIndex = startRowIndex; rowIndex <= rowCount; rowIndex++) {
-                    _loop_1(rowIndex);
+                    finally { if (e_2) throw e_2.error; }
                 }
-                buildMs = now() - buildStart;
-                // Sort data
-                var sortStart = now();
-                // Primary spec, then one spec per "then by" level. The order
-                // matches the sortValues built above so the comparator pairs
-                // each value with its spec.
-                var specs = __spreadArray([
-                    {
-                        sortOrder: sortOrder,
-                        sortBy: (_e = options === null || options === void 0 ? void 0 : options.sortBy) !== null && _e !== void 0 ? _e : "value",
-                        // Pre-resolve the target color the same way the cell sort
-                        // values are resolved, so sort-rows.ts can compare strings.
-                        sortColor: getStringifiedColor(options === null || options === void 0 ? void 0 : options.sortColor, theme),
-                        sortIcon: options === null || options === void 0 ? void 0 : options.sortIcon,
-                        customList: options === null || options === void 0 ? void 0 : options.customList,
-                    }
-                ], __read((additionalLevels !== null && additionalLevels !== void 0 ? additionalLevels : []).map(function (level) {
-                    var _a;
-                    return ({
-                        sortOrder: level.sortOrder,
-                        sortBy: (_a = level.sortBy) !== null && _a !== void 0 ? _a : "value",
-                        sortColor: getStringifiedColor(level.sortColor, theme),
-                        sortIcon: level.sortIcon,
-                        customList: level.customList,
-                    });
-                })), false);
-                var sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, specs);
-                sortMs = now() - sortStart;
-                // Counter for how many rows we have skipped
-                var skippedRow = 0;
                 var applyStart = now();
-                for (var rowIndex = startRowIndex; rowIndex <= sortedEntries.length; rowIndex++) {
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        skippedRow++;
-                        continue;
-                    }
-                    var sourceRow = sortedEntries[rowIndex - skippedRow - startRowIndex];
+                for (var index = 0; index < destRows.length; index++) {
+                    var rowIndex = destRows[index];
+                    var sourceRow = sortedEntries[index];
                     if (!sourceRow) {
                         continue;
                     }
                     if (sourceRow.rowIndex === rowIndex) {
                         continue;
                     }
-                    var sourceRowValues = (_f = rowSnapshots.get(sourceRow.rowIndex)) !== null && _f !== void 0 ? _f : [];
+                    var sourceRowValues = (_e = rowSnapshots.get(sourceRow.rowIndex)) !== null && _e !== void 0 ? _e : [];
                     var nextRowValues = [];
                     for (var columnIndex = startColumnIndex; columnIndex <= maxColumnCount; columnIndex++) {
                         // const currentSheet = createSheetDraft(draft, sheetId, rowIndex);
@@ -226,7 +268,7 @@ export var useOnSortColumn = function (_a) {
                         nextRowValues[columnIndex] =
                             sheetCell === null || sheetCell === void 0 ? void 0 : sheetCell.getCellData();
                         try {
-                            for (var dependents_1 = (e_1 = void 0, __values(dependents)), dependents_1_1 = dependents_1.next(); !dependents_1_1.done; dependents_1_1 = dependents_1.next()) {
+                            for (var dependents_1 = (e_3 = void 0, __values(dependents)), dependents_1_1 = dependents_1.next(); !dependents_1_1.done; dependents_1_1 = dependents_1.next()) {
                                 var dependent = dependents_1_1.value;
                                 if (isStaticNode(dependent)) {
                                     continue;
@@ -238,12 +280,12 @@ export var useOnSortColumn = function (_a) {
                                 recalcCells.set(createSheetCellIdentifier(dependent.position.sheetId, dependent.position.rowIndex, dependent.position.columnIndex), dependent.position);
                             }
                         }
-                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        catch (e_3_1) { e_3 = { error: e_3_1 }; }
                         finally {
                             try {
-                                if (dependents_1_1 && !dependents_1_1.done && (_a = dependents_1.return)) _a.call(dependents_1);
+                                if (dependents_1_1 && !dependents_1_1.done && (_b = dependents_1.return)) _b.call(dependents_1);
                             }
-                            finally { if (e_1) throw e_1.error; }
+                            finally { if (e_3) throw e_3.error; }
                         }
                     }
                     var currentSheet = createSheetDraft(draft, sheetId, rowIndex);
@@ -286,7 +328,11 @@ export var useOnSortColumn = function (_a) {
         enqueueStructureChange,
         enqueueGraphOperation,
         onChangeSheetData,
+        onChangeSheets,
+        getCellData,
+        getDataRowCount,
         isHiddenRow,
+        isManuallyHiddenRow,
         getDependents,
         getFrozenRowCount,
         canEditSheet,

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

@@ -1,5 +1,5 @@
 import type { SelectionArea } from "@rowsncolumns/common-types";
-import { type CellData, type SelectionAttributes, type SortOrder, type SpreadsheetTheme } from "@rowsncolumns/spreadsheet";
+import { type CellData, type Sheet, type SelectionAttributes, type SortOrder, type SpreadsheetTheme } from "@rowsncolumns/spreadsheet";
 import type { OnCommand } from "../commands";
 import type { useCalculation } from "./use-calculation";
 import type { useSheetProperties } from "./use-sheet-properties";
@@ -7,7 +7,7 @@ import type { UseSpreadsheetProps } from "./use-spreadsheet-state";
 import type { SharedStringRegistry } from "./use-ss-registry";
 import type { SpreadsheetPatch } from "./use-undo-redo";
 import { type DimensionSortSpec } from "./utils/sort-rows";
-export type UseOnSortRangeProps<T extends CellData> = {
+export type UseOnSortRangeProps<T extends CellData, S extends Sheet = Sheet> = {
     locale?: string;
     sharedStringRegistry?: SharedStringRegistry;
     createHistory(): (patches: SpreadsheetPatch) => void;
@@ -15,7 +15,30 @@ export type UseOnSortRangeProps<T extends CellData> = {
     enqueueGraphOperation: ReturnType<typeof useCalculation>["enqueueGraphOperation"];
     enqueueCalculation: ReturnType<typeof useCalculation>["enqueueCalculation"];
     onChangeSheetData: UseSpreadsheetProps<T>["onChangeSheetData"];
+    /**
+     * Receives each sorted row's `hiddenByFilter` flag at its destination,
+     * in the same undo step as the cell rewrite. Without it filter-hidden
+     * rows still sort, but the hidden set stays on the old row numbers.
+     */
+    onChangeSheets?: UseSpreadsheetProps<T, S>["onChangeSheets"];
+    /**
+     * Committed cell data — the sort keys are gathered from it before the
+     * state updaters run, so one row permutation drives both the sheet data
+     * rewrite and the row-metadata carry-over.
+     */
+    getCellData(sheetId: number, rowIndex: number, columnIndex: number): T | null | undefined;
+    /**
+     * Any hidden row (by the user, a filter, or a collapsed group). Used as
+     * the pin predicate only when `isManuallyHiddenRow` is not supplied.
+     */
     isHiddenRow(sheetId: number, rowIndex: number): boolean;
+    /**
+     * A row the user hid (`hiddenByUser` / a collapsed outline group). These
+     * rows are pinned in place; rows an AutoFilter hid sort along with the
+     * visible ones and keep their `hiddenByFilter` flag at their destination,
+     * like Excel.
+     */
+    isManuallyHiddenRow?(sheetId: number, rowIndex: number): boolean;
     getDependents: ReturnType<typeof useCalculation>["getDependents"];
     getFrozenRowCount(sheetId: number): number;
     getSheetName(sheetId: number): string;
@@ -38,5 +61,5 @@ export type UseOnSortRangeProps<T extends CellData> = {
  * @param param0
  * @returns
  */
-export declare const useOnSortRange: <T extends CellData>({ locale, sharedStringRegistry, createHistory, enqueueStructureChange, enqueueGraphOperation, enqueueCalculation, onChangeSheetData, getDependents, isHiddenRow, getFrozenRowCount, getSheetName, getEffectiveFormat, theme, onCommand, }: UseOnSortRangeProps<T>) => (sheetId: number, selections: SelectionArea<SelectionAttributes>[], sortOrder: SortOrder, specs?: DimensionSortSpec[]) => void;
+export declare const useOnSortRange: <T extends CellData, S extends Sheet = Sheet>({ locale, sharedStringRegistry, createHistory, enqueueStructureChange, enqueueGraphOperation, enqueueCalculation, onChangeSheetData, onChangeSheets, getCellData, getDependents, isHiddenRow, isManuallyHiddenRow, getFrozenRowCount, getSheetName, getEffectiveFormat, theme, onCommand, }: UseOnSortRangeProps<T, S>) => (sheetId: number, selections: SelectionArea<SelectionAttributes>[], sortOrder: SortOrder, specs?: DimensionSortSpec[]) => void;
 //# sourceMappingURL=use-on-sort-range.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"use-on-sort-range.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-sort-range.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE,OAAO,EACL,KAAK,QAAQ,EAIb,KAAK,mBAAmB,EACxB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACtB,MAAM,2BAA2B,CAAC;AAOnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAS7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,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;AACxD,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,QAAQ,IAAI;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,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,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC/D,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACxD,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3C,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAC7B,OAAO,kBAAkB,CAC1B,CAAC,oBAAoB,CAAC,CAAC;IACxB;;;OAGG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,QAAQ,EAAE,2OAehD,mBAAmB,CAAC,CAAC,CAAC,eAMV,MAAM,cACH,aAAa,CAAC,mBAAmB,CAAC,EAAE,aACrC,SAAS,UAQZ,iBAAiB,EAAE,SA8ShC,CAAC"}
+{"version":3,"file":"use-on-sort-range.d.ts","sourceRoot":"","sources":["../../../hooks/use-on-sort-range.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,KAAK,EAIV,KAAK,mBAAmB,EACxB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACtB,MAAM,2BAA2B,CAAC;AAQnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAS7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,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;AACxD,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,KAAK,GAAG,KAAK,IACrB;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,aAAa,IAAI,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACrD,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,kBAAkB,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,oBAAoB,CAAC,CAAC;IAC5E,iBAAiB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAC/D;;;;OAIG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC7D;;;;OAIG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IACxB;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACxD;;;;;OAKG;IACH,mBAAmB,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACjE,aAAa,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3C,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAC7B,OAAO,kBAAkB,CAC1B,CAAC,oBAAoB,CAAC,CAAC;IACxB;;;OAGG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,GAAG,KAAK,EAAE,6RAkBzE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,eAMb,MAAM,cACH,aAAa,CAAC,mBAAmB,CAAC,EAAE,aACrC,SAAS,UAQZ,iBAAiB,EAAE,SA2UhC,CAAC"}

package/dist/cjs/hooks/use-on-sort-range.js

@@ -5,6 +5,7 @@ import { getCellUserEnteredValue, getExtendedValueFormula, getStringifiedColor,
 import { produceWithPatches } from "immer";
 import { useCallback } from "react";
 import { createSheetCellIdentifier } from "../api/formula";
+import { getCellSortValue } from "../api/sort";
 import { createSheetDraft } from "../api/immer-utils";
 import { useShowError } from "../atoms/error-state.atom";
 import { SHEET_PROTECTION_ERROR_TITLE, useCanEditCellRange, useCanPerformSheetAction, } from "./use-can-edit-cellrange";
@@ -17,7 +18,7 @@ import { sortRowEntriesByFrozenState, } from "./utils/sort-rows";
  * @returns
  */
 export var useOnSortRange = function (_a) {
-    var locale = _a.locale, sharedStringRegistry = _a.sharedStringRegistry, createHistory = _a.createHistory, enqueueStructureChange = _a.enqueueStructureChange, enqueueGraphOperation = _a.enqueueGraphOperation, enqueueCalculation = _a.enqueueCalculation, onChangeSheetData = _a.onChangeSheetData, getDependents = _a.getDependents, isHiddenRow = _a.isHiddenRow, getFrozenRowCount = _a.getFrozenRowCount, getSheetName = _a.getSheetName, getEffectiveFormat = _a.getEffectiveFormat, theme = _a.theme, onCommand = _a.onCommand;
+    var locale = _a.locale, sharedStringRegistry = _a.sharedStringRegistry, createHistory = _a.createHistory, enqueueStructureChange = _a.enqueueStructureChange, enqueueGraphOperation = _a.enqueueGraphOperation, enqueueCalculation = _a.enqueueCalculation, onChangeSheetData = _a.onChangeSheetData, onChangeSheets = _a.onChangeSheets, getCellData = _a.getCellData, getDependents = _a.getDependents, isHiddenRow = _a.isHiddenRow, isManuallyHiddenRow = _a.isManuallyHiddenRow, getFrozenRowCount = _a.getFrozenRowCount, getSheetName = _a.getSheetName, getEffectiveFormat = _a.getEffectiveFormat, theme = _a.theme, onCommand = _a.onCommand;
     var canEditCellRange = useCanEditCellRange();
     var canPerformSheetAction = useCanPerformSheetAction();
     var showError = useShowError();
@@ -30,6 +31,7 @@ export var useOnSortRange = function (_a) {
      * legacy uniform-direction behavior is preserved exactly.
      */
     specs) {
+        var _a, _b, _c, _d;
         var activeSheetName = getSheetName(sheetId);
         // We need to track this for history. Precedent cells
         var recalcCells = new Map();
@@ -62,81 +64,122 @@ export var useOnSortRange = function (_a) {
             startColumnIndex: selection.range.startColumnIndex,
             endColumnIndex: selection.range.endColumnIndex,
         });
+        var startRowIndex = selection.range.startRowIndex;
+        var endRowIndex = selection.range.endRowIndex;
+        var startColumnIndex = selection.range.startColumnIndex;
+        var endColumnIndex = selection.range.endColumnIndex;
+        var frozenRowCount = getFrozenRowCount(sheetId);
+        var isPinnedRow = function (rowIndex) {
+            return isManuallyHiddenRow
+                ? isManuallyHiddenRow(sheetId, rowIndex)
+                : isHiddenRow(sheetId, rowIndex);
+        };
+        // Gather the sort keys from the committed cell data. Pinned rows
+        // contribute no entry and are never rewritten.
+        var rowEntries = [];
+        for (var rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
+            if (isPinnedRow(rowIndex)) {
+                continue;
+            }
+            var sortValues = [];
+            for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
+                var sheetCell = new SheetCell(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, getCellData(sheetId, rowIndex, columnIndex), { locale: locale, sharedStringRegistry: sharedStringRegistry });
+                var fallbackValue = getCellSortValue(sheetCell);
+                // When the per-column spec sorts by color/icon, swap the
+                // value for the matching attribute from the cell's
+                // effective format so sort-rows.ts can compare it.
+                var spec = specs === null || specs === void 0 ? void 0 : specs[columnIndex - startColumnIndex];
+                var sortBy = (_a = spec === null || spec === void 0 ? void 0 : spec.sortBy) !== null && _a !== void 0 ? _a : "value";
+                var fmt = sortBy === "cellColor" || sortBy === "fontColor" || sortBy === "icon"
+                    ? getEffectiveFormat === null || getEffectiveFormat === void 0 ? void 0 : getEffectiveFormat(sheetId, rowIndex, columnIndex)
+                    : undefined;
+                var sortValue = sortBy === "cellColor"
+                    ? getStringifiedColor(fmt === null || fmt === void 0 ? void 0 : fmt.backgroundColor, theme)
+                    : sortBy === "fontColor"
+                        ? getStringifiedColor((_b = fmt === null || fmt === void 0 ? void 0 : fmt.textFormat) === null || _b === void 0 ? void 0 : _b.color, theme)
+                        : sortBy === "icon"
+                            ? (fmt === null || fmt === void 0 ? void 0 : fmt.conditionalIcon)
+                                ? {
+                                    iconSet: fmt.conditionalIcon.iconSet,
+                                    iconId: fmt.conditionalIcon.iconId,
+                                }
+                                : undefined
+                            : fallbackValue;
+                sortValues.push(sortValue);
+            }
+            rowEntries.push({ rowIndex: rowIndex, sortValues: sortValues });
+        }
+        // The slots the sorted rows land on, ascending (the sort reorders
+        // `rowEntries` in place).
+        var destRows = rowEntries.map(function (entry) { return entry.rowIndex; });
+        // Sort each column. When per-column specs are provided, use
+        // them as multi-level "then by" specs (pre-resolving any
+        // target colors so sort-rows.ts can compare strings). Otherwise
+        // fall back to the legacy uniform-direction behavior.
+        // `sortedEntries[i]` is the row that lands on `destRows[i]`.
+        var sortSpecs = specs
+            ? specs.map(function (spec) { return (__assign(__assign({}, spec), { sortColor: getStringifiedColor(spec.sortColor, theme) })); })
+            : new Array((_d = (_c = rowEntries[0]) === null || _c === void 0 ? void 0 : _c.sortValues.length) !== null && _d !== void 0 ? _d : 0).fill(sortOrder);
+        var sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, sortSpecs);
+        // Carry each row's `hiddenByFilter` flag to the row's destination: a
+        // sort does not re-evaluate the filter, so the hidden set follows the
+        // rows.
+        onChangeSheets === null || onChangeSheets === void 0 ? void 0 : onChangeSheets(function (prevSheets) {
+            var _a = __read(produceWithPatches(prevSheets, function (draft) {
+                var sheet = draft.find(function (sheet) { return sheet.sheetId === sheetId; });
+                if (!sheet) {
+                    return;
+                }
+                var hiddenByFilterAt = function (rowIndex) { var _a, _b; return Boolean((_b = (_a = sheet.rowMetadata) === null || _a === void 0 ? void 0 : _a[rowIndex]) === null || _b === void 0 ? void 0 : _b.hiddenByFilter); };
+                // Read every source flag before writing any destination.
+                var carried = destRows.map(function (rowIndex, index) { var _a, _b; return hiddenByFilterAt((_b = (_a = sortedEntries[index]) === null || _a === void 0 ? void 0 : _a.rowIndex) !== null && _b !== void 0 ? _b : rowIndex); });
+                destRows.forEach(function (rowIndex, index) {
+                    var hiddenByFilter = carried[index];
+                    if (hiddenByFilter === hiddenByFilterAt(rowIndex)) {
+                        return;
+                    }
+                    if (!sheet.rowMetadata) {
+                        sheet.rowMetadata = [];
+                    }
+                    sheet.rowMetadata[rowIndex] = __assign(__assign({}, sheet.rowMetadata[rowIndex]), { hiddenByFilter: hiddenByFilter });
+                });
+            }), 3), nextState = _a[0], patches = _a[1], inversePatches = _a[2];
+            if (!patches.length) {
+                return prevSheets;
+            }
+            saveHistory({ sheets: { patches: patches, inversePatches: inversePatches } });
+            return nextState;
+        });
         // Update sheet data
         onChangeSheetData === null || onChangeSheetData === void 0 ? void 0 : onChangeSheetData(function (prevSheetData) {
             var _a = __read(produceWithPatches(prevSheetData, function (draft) {
-                var e_1, _a;
-                var _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                var e_1, _a, e_2, _b;
+                var _c, _d, _e, _f;
                 var sheet = createSheetDraft(draft, sheetId);
-                var startRowIndex = selection.range.startRowIndex;
-                var endRowIndex = selection.range.endRowIndex;
-                var startColumnIndex = selection.range.startColumnIndex;
-                var endColumnIndex = selection.range.endColumnIndex;
-                var rowEntries = [];
                 var rowSnapshots = new Map();
-                var frozenRowCount = getFrozenRowCount(sheetId);
-                for (var rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        continue;
-                    }
-                    var rowValue = sheet[rowIndex];
-                    var sortValues = [];
-                    for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
-                        var cellData = (_b = rowValue === null || rowValue === void 0 ? void 0 : rowValue.values) === null || _b === void 0 ? void 0 : _b[columnIndex];
-                        var sheetCell = new SheetCell(sheetId, { rowIndex: rowIndex, columnIndex: columnIndex }, cellData, { locale: locale, sharedStringRegistry: sharedStringRegistry });
-                        var fallbackValue = (_c = sheetCell.getEffectiveValue()) !== null && _c !== void 0 ? _c : sheetCell.formattedValue;
-                        // When the per-column spec sorts by color/icon, swap the
-                        // value for the matching attribute from the cell's
-                        // effective format so sort-rows.ts can compare it.
-                        var spec = specs === null || specs === void 0 ? void 0 : specs[columnIndex - startColumnIndex];
-                        var sortBy = (_d = spec === null || spec === void 0 ? void 0 : spec.sortBy) !== null && _d !== void 0 ? _d : "value";
-                        var fmt = sortBy === "cellColor" ||
-                            sortBy === "fontColor" ||
-                            sortBy === "icon"
-                            ? getEffectiveFormat === null || getEffectiveFormat === void 0 ? void 0 : getEffectiveFormat(sheetId, rowIndex, columnIndex)
-                            : undefined;
-                        var sortValue = sortBy === "cellColor"
-                            ? getStringifiedColor(fmt === null || fmt === void 0 ? void 0 : fmt.backgroundColor, theme)
-                            : sortBy === "fontColor"
-                                ? getStringifiedColor((_e = fmt === null || fmt === void 0 ? void 0 : fmt.textFormat) === null || _e === void 0 ? void 0 : _e.color, theme)
-                                : sortBy === "icon"
-                                    ? (fmt === null || fmt === void 0 ? void 0 : fmt.conditionalIcon)
-                                        ? {
-                                            iconSet: fmt.conditionalIcon.iconSet,
-                                            iconId: fmt.conditionalIcon.iconId,
-                                        }
-                                        : undefined
-                                    : fallbackValue;
-                        sortValues.push(sortValue);
+                try {
+                    for (var destRows_1 = __values(destRows), destRows_1_1 = destRows_1.next(); !destRows_1_1.done; destRows_1_1 = destRows_1.next()) {
+                        var rowIndex = destRows_1_1.value;
+                        rowSnapshots.set(rowIndex, ((_d = (_c = sheet[rowIndex]) === null || _c === void 0 ? void 0 : _c.values) !== null && _d !== void 0 ? _d : []).slice());
                     }
-                    rowSnapshots.set(rowIndex, ((_f = rowValue === null || rowValue === void 0 ? void 0 : rowValue.values) !== null && _f !== void 0 ? _f : []).slice());
-                    rowEntries.push({ rowIndex: rowIndex, sortValues: sortValues });
                 }
-                // Sort each column. When per-column specs are provided, use
-                // them as multi-level "then by" specs (pre-resolving any
-                // target colors so sort-rows.ts can compare strings). Otherwise
-                // fall back to the legacy uniform-direction behavior.
-                var sortSpecs = specs
-                    ? specs.map(function (spec) { return (__assign(__assign({}, spec), { sortColor: getStringifiedColor(spec.sortColor, theme) })); })
-                    : new Array((_h = (_g = rowEntries[0]) === null || _g === void 0 ? void 0 : _g.sortValues.length) !== null && _h !== void 0 ? _h : 0).fill(sortOrder);
-                var sortedEntries = sortRowEntriesByFrozenState(rowEntries, frozenRowCount, sortSpecs);
-                // Counter for how many rows we have skipped
-                var skippedRow = 0;
-                for (var rowIndex = startRowIndex; rowIndex <= endRowIndex; rowIndex++) {
-                    // Ignore hidden rows
-                    if (isHiddenRow(sheetId, rowIndex)) {
-                        skippedRow++;
-                        continue;
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (destRows_1_1 && !destRows_1_1.done && (_a = destRows_1.return)) _a.call(destRows_1);
                     }
-                    var sourceRow = sortedEntries[rowIndex - skippedRow - startRowIndex];
+                    finally { if (e_1) throw e_1.error; }
+                }
+                for (var index = 0; index < destRows.length; index++) {
+                    var rowIndex = destRows[index];
+                    var sourceRow = sortedEntries[index];
                     if (!sourceRow) {
                         continue;
                     }
                     if (sourceRow.rowIndex === rowIndex) {
                         continue;
                     }
-                    var sourceRowValues = (_j = rowSnapshots.get(sourceRow.rowIndex)) !== null && _j !== void 0 ? _j : [];
+                    var sourceRowValues = (_e = rowSnapshots.get(sourceRow.rowIndex)) !== null && _e !== void 0 ? _e : [];
                     var currentSheet = createSheetDraft(draft, sheetId, rowIndex);
                     for (var columnIndex = startColumnIndex; columnIndex <= endColumnIndex; columnIndex++) {
                         var sourceCellData = sourceRowValues[columnIndex];
@@ -145,7 +188,7 @@ export var useOnSortRange = function (_a) {
                         if (sourceCellData && hasFormula) {
                             sheetCell = new SheetCell(sheetId, { rowIndex: sourceRow.rowIndex, columnIndex: columnIndex }, sourceCellData, { locale: locale, sharedStringRegistry: sharedStringRegistry });
                         }
-                        var coords = (_k = sheetCell === null || sheetCell === void 0 ? void 0 : sheetCell.coords) !== null && _k !== void 0 ? _k : {
+                        var coords = (_f = sheetCell === null || sheetCell === void 0 ? void 0 : sheetCell.coords) !== null && _f !== void 0 ? _f : {
                             rowIndex: sourceRow.rowIndex,
                             columnIndex: columnIndex,
                         };
@@ -178,7 +221,7 @@ export var useOnSortRange = function (_a) {
                             });
                         }
                         try {
-                            for (var dependents_1 = (e_1 = void 0, __values(dependents)), dependents_1_1 = dependents_1.next(); !dependents_1_1.done; dependents_1_1 = dependents_1.next()) {
+                            for (var dependents_1 = (e_2 = void 0, __values(dependents)), dependents_1_1 = dependents_1.next(); !dependents_1_1.done; dependents_1_1 = dependents_1.next()) {
                                 var dependent = dependents_1_1.value;
                                 if (isStaticNode(dependent)) {
                                     continue;
@@ -198,12 +241,12 @@ export var useOnSortRange = function (_a) {
                                 recalcCells.set(createSheetCellIdentifier(dependent.position.sheetId, dependent.position.rowIndex, dependent.position.columnIndex), dependent.position);
                             }
                         }
-                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
                         finally {
                             try {
-                                if (dependents_1_1 && !dependents_1_1.done && (_a = dependents_1.return)) _a.call(dependents_1);
+                                if (dependents_1_1 && !dependents_1_1.done && (_b = dependents_1.return)) _b.call(dependents_1);
                             }
-                            finally { if (e_1) throw e_1.error; }
+                            finally { if (e_2) throw e_2.error; }
                         }
                         // Update
                         if (sheetCell) {
@@ -239,7 +282,10 @@ export var useOnSortRange = function (_a) {
         enqueueGraphOperation,
         enqueueCalculation,
         onChangeSheetData,
+        onChangeSheets,
+        getCellData,
         isHiddenRow,
+        isManuallyHiddenRow,
         getFrozenRowCount,
         getSheetName,
         getEffectiveFormat,