@rowsncolumns/spreadsheet-state 28.0.66

package/dist/cjs/hooks/use-search.js

@@ -0,0 +1,261 @@
+import { __assign, __read, __spreadArray, __values } from "tslib";
+import { useCallbackRef, useIsomorphicLayoutEffect, useSpreadsheet, } from "@rowsncolumns/spreadsheet";
+import { escapeCharacters, getCellEffectiveValue, getCellFormattedValue, getExtendedValueNumber, getExtendedValueString, } from "@rowsncolumns/utils";
+import { useCallback, useMemo, useRef, useState, useTransition } from "react";
+/**
+ * Build the regex used to match cell content. `\b` works for ASCII
+ * word boundaries; that's the same compromise Excel and Sheets ship.
+ * Returns `undefined` when `useRegex` is on and the user-supplied
+ * pattern fails to compile — callers treat that as zero matches.
+ */
+export var buildSearchRegex = function (query, options) {
+    var flags = (options === null || options === void 0 ? void 0 : options.matchCase) ? "g" : "gi";
+    if (options === null || options === void 0 ? void 0 : options.useRegex) {
+        try {
+            return new RegExp(query, flags);
+        }
+        catch (_a) {
+            return undefined;
+        }
+    }
+    var escaped = escapeCharacters(query);
+    var pattern = (options === null || options === void 0 ? void 0 : options.wholeWord) ? "\\b".concat(escaped, "\\b") : escaped;
+    return new RegExp(pattern, flags);
+};
+/**
+ * Raw (effective) cell value as a string, so a search for `3000`
+ * also matches a cell displayed as `3,000`. Numbers use their
+ * canonical `String()` form; booleans mirror the grid's TRUE/FALSE.
+ */
+export var getCellEffectiveValueString = function (cellData) {
+    var _a;
+    var effectiveValue = getCellEffectiveValue(cellData);
+    if (!effectiveValue) {
+        return undefined;
+    }
+    var numberValue = getExtendedValueNumber(effectiveValue);
+    if (numberValue !== undefined && numberValue !== null) {
+        return String(numberValue);
+    }
+    var stringValue = getExtendedValueString(effectiveValue);
+    if (stringValue !== undefined && stringValue !== null) {
+        return stringValue;
+    }
+    var boolValue = (_a = effectiveValue.bv) !== null && _a !== void 0 ? _a : effectiveValue.boolValue;
+    if (boolValue !== undefined && boolValue !== null) {
+        return boolValue ? "TRUE" : "FALSE";
+    }
+    return undefined;
+};
+var testValue = function (regex, value) {
+    if (!value) {
+        return false;
+    }
+    // Global regexes are stateful — reset before every test.
+    regex.lastIndex = 0;
+    return regex.test(value);
+};
+// Default match function — matches on the formatted (displayed) value
+// or the raw effective value, so `3000` finds a cell shown as `3,000`.
+export var defaultMatchPredicate = function (cellData, query, options) {
+    var regex = buildSearchRegex(query, options);
+    if (!regex) {
+        return false;
+    }
+    return (testValue(regex, getCellFormattedValue(cellData)) ||
+        testValue(regex, getCellEffectiveValueString(cellData)));
+};
+var EMPTY_ARRAY = [];
+/**
+ * Use search hook
+ * @param param0
+ * @returns
+ */
+export var useSearch = function (_a) {
+    var sheetId = _a.sheetId, sheets = _a.sheets, searchAllSheets = _a.searchAllSheets, onChangeActiveSheet = _a.onChangeActiveSheet, getNonEmptyRowCount = _a.getNonEmptyRowCount, getNonEmptyColumnCount = _a.getNonEmptyColumnCount, getCellData = _a.getCellData, getFormattedValue = _a.getFormattedValue, _b = _a.matchPredicate, matchPredicate = _b === void 0 ? defaultMatchPredicate : _b, findMatches = _a.findMatches;
+    var _c = __read(useState(false), 2), isVisible = _c[0], setIsVisible = _c[1];
+    var _d = __read(useState(EMPTY_ARRAY), 2), searchResults = _d[0], setSearchResults = _d[1];
+    var _e = __read(useState(0), 2), activeIndex = _e[0], setActiveIndex = _e[1];
+    var searchQueryRef = useRef(undefined);
+    var searchOptionsRef = useRef(undefined);
+    var _f = __read(useTransition(), 2), _ = _f[0], startTransition = _f[1];
+    // focus
+    var scrollToCell = useSpreadsheet().scrollToCell;
+    // Reset search
+    var onResetSearch = useCallback(function () {
+        setSearchResults([]);
+        setActiveIndex(0);
+        setIsVisible(false);
+        searchQueryRef.current = "";
+    }, []);
+    // Focus on a search result
+    var focusResult = useCallback(function (result) {
+        if (result) {
+            if (result.sheetId !== sheetId) {
+                onChangeActiveSheet === null || onChangeActiveSheet === void 0 ? void 0 : onChangeActiveSheet(result.sheetId);
+            }
+            scrollToCell === null || scrollToCell === void 0 ? void 0 : scrollToCell(result);
+        }
+    }, [sheetId, onChangeActiveSheet, scrollToCell]);
+    // Do search
+    var onSearch = useCallbackRef(useCallback(function (query, options, scrollToActiveCell) {
+        if (scrollToActiveCell === void 0) { scrollToActiveCell = true; }
+        var results = [];
+        // Save query + toggles so re-runs (sheet swap, data change)
+        // honour the same match settings.
+        searchQueryRef.current = query;
+        searchOptionsRef.current = options;
+        startTransition(function () {
+            var e_1, _a;
+            var _b, _c, _d;
+            // Only search for queries
+            if (query && findMatches) {
+                // Engine/windowed path: the whole-document scan happens in Rust (the accessor walk below
+                // would only see the loaded viewport). Results already arrive row-major.
+                results.push.apply(results, __spreadArray([], __read(findMatches(query, options)), false));
+            }
+            else if (query) {
+                var finalSheets = searchAllSheets
+                    ? sheets
+                    : [{ sheetId: sheetId }];
+                var regex = buildSearchRegex(query, options);
+                if (!regex) {
+                    setSearchResults([]);
+                    setActiveIndex(0);
+                    return;
+                }
+                try {
+                    for (var finalSheets_1 = __values(finalSheets), finalSheets_1_1 = finalSheets_1.next(); !finalSheets_1_1.done; finalSheets_1_1 = finalSheets_1.next()) {
+                        var sheet = finalSheets_1_1.value;
+                        // Search sheet
+                        if (!searchAllSheets && sheet.sheetId !== sheetId) {
+                            continue;
+                        }
+                        var rowCount = (_b = getNonEmptyRowCount(sheet.sheetId)) !== null && _b !== void 0 ? _b : 1;
+                        for (var rowIndex = 1; rowIndex <= rowCount; rowIndex++) {
+                            var columnCount = (_c = getNonEmptyColumnCount(sheet.sheetId, rowIndex)) !== null && _c !== void 0 ? _c : 1;
+                            for (var columnIndex = 1; columnIndex <= columnCount; columnIndex++) {
+                                var cellData = getCellData(sheet.sheetId, rowIndex, columnIndex);
+                                var formattedValue = (_d = getFormattedValue === null || getFormattedValue === void 0 ? void 0 : getFormattedValue(sheet.sheetId, rowIndex, columnIndex)) !== null && _d !== void 0 ? _d : getCellFormattedValue(cellData);
+                                var matches = testValue(regex, formattedValue) ||
+                                    testValue(regex, getCellEffectiveValueString(cellData));
+                                if (matches) {
+                                    results.push({
+                                        rowIndex: rowIndex,
+                                        columnIndex: columnIndex,
+                                        sheetId: sheet.sheetId,
+                                    });
+                                }
+                            }
+                        }
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (finalSheets_1_1 && !finalSheets_1_1.done && (_a = finalSheets_1.return)) _a.call(finalSheets_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+            }
+            // Update results
+            setSearchResults(results);
+            // Update index
+            setActiveIndex(0);
+            // Scroll to first cell
+            if (scrollToActiveCell && results.length) {
+                var firstResult = results[0];
+                focusResult(firstResult);
+            }
+        });
+    }, [
+        sheets,
+        searchAllSheets,
+        sheetId,
+        focusResult,
+        getCellData,
+        getFormattedValue,
+        getNonEmptyRowCount,
+        getNonEmptyColumnCount,
+        findMatches,
+    ]));
+    // Invoke search again
+    useIsomorphicLayoutEffect(function () {
+        if (searchQueryRef.current && !searchAllSheets) {
+            onSearch(searchQueryRef.current, searchOptionsRef.current, false);
+        }
+    }, [getCellData, sheetId, onSearch, searchAllSheets]);
+    // Create search styles
+    var borderStyles = useMemo(function () {
+        return searchResults.map(function (result, index) {
+            var style = result.sheetId === sheetId
+                ? __assign({ fill: "rgba(109,204,126,0.3)", zIndex: 2 }, (activeIndex === index
+                    ? {
+                        strokeWidth: 2,
+                        stroke: "#145B22",
+                        offset: -1,
+                    }
+                    : {})) : {};
+            return {
+                range: {
+                    startRowIndex: result.rowIndex,
+                    endRowIndex: result.rowIndex,
+                    startColumnIndex: result.columnIndex,
+                    endColumnIndex: result.columnIndex,
+                },
+                id: index * 1000,
+                style: style,
+            };
+        });
+    }, [searchResults, activeIndex, sheetId]);
+    // Jump to next cell
+    var onFocusNextResult = useCallback(function () {
+        var newIndex = activeIndex === searchResults.length - 1
+            ? 0
+            : Math.min(activeIndex + 1, searchResults.length - 1);
+        var result = searchResults[newIndex];
+        setActiveIndex(newIndex);
+        focusResult(result);
+    }, [searchResults, activeIndex, focusResult]);
+    // Jump to prev cell
+    var onFocusPreviousResult = useCallback(function () {
+        var newIndex = activeIndex === 0
+            ? searchResults.length - 1
+            : Math.max(activeIndex - 1, 0);
+        var result = searchResults[newIndex];
+        setActiveIndex(newIndex);
+        focusResult(result);
+    }, [searchResults, activeIndex, focusResult]);
+    var hasNextResult = useMemo(function () {
+        return activeIndex < searchResults.length - 1;
+    }, [searchResults, , activeIndex]);
+    var hasPreviousResult = useMemo(function () {
+        return activeIndex > 0;
+    }, [, activeIndex]);
+    var onRequestSearch = useCallback(function () {
+        setIsVisible(true);
+    }, []);
+    var totalResults = searchResults.length;
+    return {
+        onSearch: onSearch,
+        onResetSearch: onResetSearch,
+        borderStyles: borderStyles,
+        onFocusNextResult: onFocusNextResult,
+        onFocusPreviousResult: onFocusPreviousResult,
+        hasPreviousResult: hasPreviousResult,
+        hasNextResult: hasNextResult,
+        searchQuery: searchQueryRef.current,
+        onRequestSearch: onRequestSearch,
+        isSearchActive: isVisible,
+        currentResult: totalResults === 0 ? 0 : activeIndex + 1,
+        totalResults: totalResults,
+        // Phase 9 Replace flow: the host needs the active match so it can
+        // target a single Replace at that cell. searchResults stays internal.
+        activeResult: searchResults[activeIndex],
+        // Last toggle set the user submitted with. `useOnFindReplace` reads
+        // this so its regex stays in lock-step with whatever
+        // `useSearch.onSearch` matched — otherwise a case-insensitive
+        // search could find a cell that the replace pass fails to match.
+        searchOptions: searchOptionsRef.current,
+    };
+};

package/dist/cjs/hooks/use-select-next-prev-sheet.d.ts

@@ -0,0 +1,11 @@
+import type { Sheet } from "@rowsncolumns/spreadsheet";
+type UseSelectNextPrevSheetProps = {
+    sheets: Sheet[];
+    onChangeActiveSheet: (sheetId: number) => void;
+};
+export declare const useSelectNextPrevSheet: ({ sheets, onChangeActiveSheet, }: UseSelectNextPrevSheetProps) => {
+    onSelectNextSheet: (sheetId: number, e?: React.KeyboardEvent<HTMLDivElement>) => void;
+    onSelectPreviousSheet: (sheetId: number, e?: React.KeyboardEvent<HTMLDivElement>) => void;
+};
+export {};
+//# sourceMappingURL=use-select-next-prev-sheet.d.ts.map

package/dist/cjs/hooks/use-select-next-prev-sheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-select-next-prev-sheet.d.ts","sourceRoot":"","sources":["../../../hooks/use-select-next-prev-sheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAGvD,KAAK,2BAA2B,GAAG;IACjC,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,mBAAmB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,kCAGpC,2BAA2B;iCAGhB,MAAM,MAAM,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;qCAW/C,MAAM,MAAM,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;CAa5D,CAAC"}

package/dist/cjs/hooks/use-select-next-prev-sheet.js

@@ -0,0 +1,22 @@
+import { useCallback } from "react";
+export var useSelectNextPrevSheet = function (_a) {
+    var sheets = _a.sheets, onChangeActiveSheet = _a.onChangeActiveSheet;
+    // Select next sheets
+    var onSelectNextSheet = useCallback(function (sheetId, e) {
+        var index = sheets.findIndex(function (sheet) { return sheet.sheetId === sheetId; });
+        var newSheetId = sheets[Math.min(index + 1, sheets.length - 1)].sheetId;
+        onChangeActiveSheet === null || onChangeActiveSheet === void 0 ? void 0 : onChangeActiveSheet(newSheetId);
+        e === null || e === void 0 ? void 0 : e.preventDefault();
+    }, [sheets, onChangeActiveSheet]);
+    // Select next sheets
+    var onSelectPreviousSheet = useCallback(function (sheetId, e) {
+        var index = sheets.findIndex(function (sheet) { return sheet.sheetId === sheetId; });
+        var newSheetId = sheets[Math.max(index - 1, 0)].sheetId;
+        onChangeActiveSheet === null || onChangeActiveSheet === void 0 ? void 0 : onChangeActiveSheet(newSheetId);
+        e === null || e === void 0 ? void 0 : e.preventDefault();
+    }, [sheets, onChangeActiveSheet]);
+    return {
+        onSelectNextSheet: onSelectNextSheet,
+        onSelectPreviousSheet: onSelectPreviousSheet,
+    };
+};

package/dist/cjs/hooks/use-sheet-observer.d.ts

@@ -0,0 +1,20 @@
+import type { StaticNode } from "@rowsncolumns/dag";
+import { type SheetRange } from "@rowsncolumns/spreadsheet";
+import type { UseSheetObserverProps } from "../atoms/sheet-observer.atom";
+export declare const useSheetObserver: ({ onAddStaticReference, onRemoveStaticReference, }: UseSheetObserverProps) => {
+    sheetObserver: import("../atoms/sheet-observer.atom").SheetObserver;
+    onChangeStaticReference: (nodes: StaticNode[]) => void;
+};
+export declare const useSubscribeToSheet: (id: string | number, sheetRange: SheetRange | undefined | null, callback: (id: string | number, sheetRange: SheetRange) => void) => void;
+/**
+ * Subscribe to multiple sheet ranges for updates.
+ * Useful for charts that depend on data from multiple sources (domains, series, etc.)
+ * across potentially different sheets.
+ *
+ * @param baseId - Base identifier for the subscription (e.g., chartId)
+ * @param ranges - Array of SheetRange objects to subscribe to
+ * @param callback - Function called when any of the subscribed ranges change
+ * @param getSheetName - Optional function to get sheet name from sheetId (for memoization keys)
+ */
+export declare const useSubscribeToMultipleRanges: (baseId: string | number, ranges: SheetRange[], callback: () => void, getSheetNameProp?: (sheetId: number) => string | undefined) => void;
+//# sourceMappingURL=use-sheet-observer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-sheet-observer.d.ts","sourceRoot":"","sources":["../../../hooks/use-sheet-observer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAO7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAyB1E,eAAO,MAAM,gBAAgB,GAAI,oDAG9B,qBAAqB;;qCASZ,UAAU,EAAE;CAYvB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,GAAG,MAAM,EACnB,YAAY,UAAU,GAAG,SAAS,GAAG,IAAI,EACzC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,SA0BhE,CAAC;AAiBF;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,GACvC,QAAQ,MAAM,GAAG,MAAM,EACvB,QAAQ,UAAU,EAAE,EACpB,UAAU,MAAM,IAAI,EACpB,mBAAmB,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,SA+C3D,CAAC"}

package/dist/cjs/hooks/use-sheet-observer.js

@@ -0,0 +1,127 @@
+import { useCallbackRef } from "@rowsncolumns/grid";
+import { useGetSheetName } from "@rowsncolumns/spreadsheet";
+import { useIsomorphicLayoutEffect } from "@rowsncolumns/ui";
+import { selectionToAddress } from "@rowsncolumns/utils";
+import { useCallback, useRef, useMemo } from "react";
+import { debounceTime } from "rxjs";
+import { useSheetObserverValue } from "../atoms/sheet-observer.atom";
+/**
+ * Convert a SheetRange to an A1 address string for memoization.
+ */
+var sheetRangeToKey = function (range, getSheetName) {
+    var _a;
+    var sheetName = (_a = getSheetName === null || getSheetName === void 0 ? void 0 : getSheetName(range.sheetId)) !== null && _a !== void 0 ? _a : String(range.sheetId);
+    var address = selectionToAddress({
+        range: {
+            startRowIndex: range.startRowIndex,
+            startColumnIndex: range.startColumnIndex,
+            endRowIndex: range.endRowIndex,
+            endColumnIndex: range.endColumnIndex,
+        },
+    }, sheetName);
+    return address;
+};
+export var useSheetObserver = function (_a) {
+    var onAddStaticReference = _a.onAddStaticReference, onRemoveStaticReference = _a.onRemoveStaticReference;
+    var sheetObserver = useSheetObserverValue();
+    useIsomorphicLayoutEffect(function () {
+        sheetObserver.onAddStaticReference = onAddStaticReference;
+        sheetObserver.onRemoveStaticReference = onRemoveStaticReference;
+    }, [sheetObserver, onAddStaticReference, onRemoveStaticReference]);
+    var onChangeStaticReference = useCallback(function (nodes) {
+        nodes.forEach(function (node) {
+            sheetObserver.next(node);
+        });
+    }, [sheetObserver]);
+    return {
+        sheetObserver: sheetObserver,
+        onChangeStaticReference: onChangeStaticReference,
+    };
+};
+export var useSubscribeToSheet = function (id, sheetRange, callback) {
+    var sheetObserver = useSheetObserverValue();
+    var callbackRef = useCallbackRef(callback);
+    useIsomorphicLayoutEffect(function () {
+        var _a;
+        var observer;
+        if (sheetRange) {
+            var idString_1 = String(id);
+            (_a = sheetObserver.onAddStaticReference) === null || _a === void 0 ? void 0 : _a.call(sheetObserver, { id: idString_1 }, sheetRange);
+            observer = sheetObserver.pipe(debounceTime(100)).subscribe(function (next) {
+                if (next.key === idString_1) {
+                    callbackRef(id, sheetRange);
+                }
+            });
+        }
+        return function () {
+            var _a;
+            if (observer) {
+                observer.unsubscribe();
+                // Remove static reference
+                (_a = sheetObserver.onRemoveStaticReference) === null || _a === void 0 ? void 0 : _a.call(sheetObserver, { id: String(id) });
+            }
+        };
+    }, [sheetRange, sheetObserver, callbackRef]);
+};
+/**
+ * Compute a stable key from ranges array.
+ * Uses A1 notation for readability and includes all range properties.
+ */
+var computeRangesKey = function (ranges, getSheetName) {
+    if (!ranges.length)
+        return "";
+    return ranges
+        .map(function (range) { return sheetRangeToKey(range, getSheetName); })
+        .sort()
+        .join("|");
+};
+/**
+ * Subscribe to multiple sheet ranges for updates.
+ * Useful for charts that depend on data from multiple sources (domains, series, etc.)
+ * across potentially different sheets.
+ *
+ * @param baseId - Base identifier for the subscription (e.g., chartId)
+ * @param ranges - Array of SheetRange objects to subscribe to
+ * @param callback - Function called when any of the subscribed ranges change
+ * @param getSheetName - Optional function to get sheet name from sheetId (for memoization keys)
+ */
+export var useSubscribeToMultipleRanges = function (baseId, ranges, callback, getSheetNameProp) {
+    var sheetObserver = useSheetObserverValue();
+    var getSheetNameHook = useGetSheetName();
+    var getSheetName = getSheetNameProp !== null && getSheetNameProp !== void 0 ? getSheetNameProp : getSheetNameHook;
+    var callbackRef = useCallbackRef(callback);
+    // Store previous ranges key to avoid unnecessary re-subscriptions
+    var rangesRef = useRef(ranges);
+    // Keep in track
+    rangesRef.current = ranges;
+    // Compute current key and check if it changed
+    var rangeKeys = useMemo(function () { return computeRangesKey(ranges, getSheetName); }, [ranges, getSheetName]);
+    useIsomorphicLayoutEffect(function () {
+        var _a;
+        if (!rangeKeys.length)
+            return;
+        var ids = new Set();
+        // Register each range with a unique ID
+        (_a = rangesRef.current) === null || _a === void 0 ? void 0 : _a.forEach(function (range, index) {
+            var _a;
+            var id = "".concat(baseId, "_range_").concat(index);
+            ids.add(id);
+            (_a = sheetObserver.onAddStaticReference) === null || _a === void 0 ? void 0 : _a.call(sheetObserver, { id: id }, range);
+        });
+        // Subscribe once, trigger callback if any of our IDs match
+        var subscription = sheetObserver
+            .pipe(debounceTime(100))
+            .subscribe(function (next) {
+            if (ids.has(next.key)) {
+                callbackRef();
+            }
+        });
+        return function () {
+            subscription.unsubscribe();
+            ids.forEach(function (id) {
+                var _a;
+                (_a = sheetObserver.onRemoveStaticReference) === null || _a === void 0 ? void 0 : _a.call(sheetObserver, { id: id });
+            });
+        };
+    }, [rangeKeys, sheetObserver, callbackRef, baseId]);
+};

package/dist/cjs/hooks/use-sheet-properties.d.ts

@@ -0,0 +1,105 @@
+import type { SheetProperty } from "@rowsncolumns/calculator";
+import { FormulaError } from "@rowsncolumns/fast-formula-parser";
+import type { CanvasGridProps, CellData, CellFormat, ConditionalFormatRule, DataValidationRuleRecord, HIDDEN_DIMENSION_STRATEGY, Sheet, SheetRange } from "@rowsncolumns/spreadsheet";
+import type { CellNode, CellRangeNode, StaticNode } from "@rowsncolumns/dag";
+import type { CellXfsRegistry } from "./use-cellxfs-registry";
+import type { SheetData, UseSpreadsheetProps } from "./use-spreadsheet-state";
+import { type SharedStrings } from "../types";
+type FormulaPrecedents = (CellNode | CellRangeNode | StaticNode)[];
+type FormulaPosition = {
+    sheetId: number;
+    rowIndex: number;
+    columnIndex: number;
+};
+export type UseSheetPropertiesProps<T extends CellData, S extends Sheet> = {
+    conditionalFormats?: ConditionalFormatRule[];
+    sheets: S[];
+    sheetData?: SheetData<T>;
+    activeSheetId: number;
+    dataValidations?: DataValidationRuleRecord[];
+    protectFormulas?: CanvasGridProps["protectFormulas"];
+    getEffectiveStructuredValue: UseSpreadsheetProps<T, S>["getEffectiveStructuredValue"];
+    cellXfs?: UseSpreadsheetProps<T, S>["cellXfs"];
+    cellXfsRegistry?: CellXfsRegistry;
+    /**
+     * Consolidated per-cell styles keyed by `"sheetId!A1"` (e.g. from an external calc engine).
+     * When present, the entry for a cell takes precedence over its `userEnteredFormat`/`cellXfs`
+     * style in {@link getEffectiveFormat}, so engine-streamed styles render everywhere formats are read.
+     */
+    cellStyles?: Map<string, CellFormat>;
+    sharedStrings?: SharedStrings | null;
+    /**
+     * Locale for number parsing in formula expressions
+     */
+    locale?: string;
+    /**
+     * Use 1900/1904 epoch
+     */
+    use1904?: boolean;
+    /**
+     * Whether to use lenient grouping for numbers (e.g. "1,234,5")
+     */
+    lenientGrouping?: boolean;
+    /**
+     * Precedents lookup for formula cells. Used to derive effective number
+     * format from precedent cells when the formula cell has no
+     * `userEnteredFormat.numberFormat`. Forwarded from `useCalculation` via
+     * a stable callback because that hook initializes after this one.
+     */
+    getPrecedents?: (cell: FormulaPosition) => FormulaPrecedents;
+};
+export declare const useSheetProperties: <T extends CellData = CellData, S extends Sheet = Sheet>({ conditionalFormats, sheetData, sheets, activeSheetId, dataValidations, protectFormulas, getEffectiveStructuredValue, cellXfs, cellXfsRegistry, cellStyles, sharedStrings, locale, use1904, lenientGrouping, getPrecedents, }: UseSheetPropertiesProps<T, S>) => {
+    getDataRowCount: (sheetId?: number) => number | undefined;
+    getNonEmptyRowCount: (sheetId: number) => number | undefined;
+    getNonEmptyColumnCount: (sheetId: number, rowIndex: number) => number | undefined;
+    getSheetId: (sheetname: string) => number;
+    getSheetName: (sheetId: number) => string;
+    getSheetCount: () => number;
+    getSheetIndex: (sheetName?: string) => number | undefined;
+    getSheetProperties: (sheetId: number) => SheetProperty | undefined;
+    getCellData: (sheetId: number, rowIndex: number, columnIndex: number) => T | null | undefined;
+    getMentionsFromCell: (sheetId: number, rowIndex: number, columnIndex: number) => {
+        startIndex: number;
+        endIndex: number;
+        nodeType: "mention";
+        mention: import("@rowsncolumns/common-types").Mention;
+    }[] | undefined;
+    getTextFormatRuns: (sheetId: number, rowIndex: number, columnIndex: number) => import("@rowsncolumns/common-types").TextFormatRun[] | undefined;
+    getUserEnteredValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined;
+    getUserEnteredValueStable: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined;
+    getConditionalFormatFormula: (sheetId: number, rowIndex: number, columnIndex: number, conditionalFormatId: ConditionalFormatRule["id"]) => string | undefined;
+    getDataValidationFormula: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined;
+    getErrorValue: (sheetId: number, rowIndex: number, columnIndex: number) => any;
+    getEffectiveValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | number | boolean | undefined;
+    getEffectiveValueForCalculation: (sheetId: number, rowIndex: number, columnIndex: number, property?: any) => string | number | boolean | FormulaError | import("@rowsncolumns/common-types").Maybe<import("@rowsncolumns/common-types").StructuredResult>;
+    getFormattedValue: (sheetId: number, rowIndex: number, columnIndex: number) => any;
+    getEffectiveFormat: (sheetId: number, rowIndex: number, columnIndex: number) => CellFormat | null | undefined;
+    getActiveSheetId: () => number;
+    getUserEnteredFormat: (sheetId: number, rowIndex: number, columnIndex: number) => T["uf"] | undefined;
+    getSeriesValuesFromRange: (sheetRange: SheetRange, hiddenDimensionStategy?: HIDDEN_DIMENSION_STRATEGY | null) => (string | number | boolean | undefined)[];
+    getDomainValuesFromRange: (sheetRange: SheetRange, hiddenDimensionStategy?: HIDDEN_DIMENSION_STRATEGY | null) => (string | null | undefined)[];
+    getColumnarDataFromRange: (sheetRange: SheetRange) => {
+        [key: string]: (string | number | boolean | Date)[];
+    };
+    getUserEnteredValuesFromRange: (sheetRange: SheetRange, hiddenDimensionStategy?: HIDDEN_DIMENSION_STRATEGY) => (string | undefined)[];
+    getFormattingFromRange: (sheetRange: SheetRange, hiddenDimensionStategy?: HIDDEN_DIMENSION_STRATEGY) => import("@rowsncolumns/common-types").Maybe<import("@rowsncolumns/common-types").CellFormat | import("@rowsncolumns/common-types").StyleReference>[];
+    getFormulasFromRange: (sheetRange: SheetRange, hiddenDimensionStategy?: HIDDEN_DIMENSION_STRATEGY) => (string | undefined)[];
+    isHiddenRow: (sheetId: number, rowIndex: number) => boolean;
+    isHiddenByFilterRow: (sheetId: number, rowIndex: number) => boolean;
+    getSheetRowCount: (sheetId: number) => number;
+    getSheetColumnCount: (sheetId: number) => number;
+    getColumnWidth: (sheetId: number, columnIndex: number) => number;
+    getRowHeight: (sheetId: number, rowIndex: number) => number;
+    isColumnHidden: (sheetId: number, columnIndex: number) => boolean;
+    isRowResizedByUser: (sheetId: number, rowIndex: number) => import("@rowsncolumns/spreadsheet").Maybe<boolean>;
+    getDataColumnCount: (sheetId: number) => number;
+    getActualRowCount: (sheetId: number) => number;
+    getFrozenRowCount: (sheetId: number) => number;
+    getDataValidation: (sheetId: number, rowIndex: number, columnIndex: number) => import("@rowsncolumns/common-types").Maybe<import("@rowsncolumns/common-types").DataValidationRule>;
+    getDataValidationById: (id: DataValidationRuleRecord["id"]) => DataValidationRuleRecord | undefined;
+    getConditionalFormattingById: (id: ConditionalFormatRule["id"]) => ConditionalFormatRule | undefined;
+    getEffectiveExtendedValue: (sheetId: number, rowIndex: number, columnIndex: number) => T["ev"];
+    getUserEnteredExtendedValue: (sheetId: number, rowIndex: number, columnIndex: number) => T["ue"];
+};
+export {};
+//# sourceMappingURL=use-sheet-properties.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-sheet-properties.d.ts","sourceRoot":"","sources":["../../../hooks/use-sheet-properties.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAGjE,OAAO,KAAK,EACV,eAAe,EACf,QAAQ,EACR,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,KAAK,EACL,UAAU,EAEX,MAAM,2BAA2B,CAAC;AA8BnC,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAe7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAElB,KAAK,iBAAiB,GAAG,CAAC,QAAQ,GAAG,aAAa,GAAG,UAAU,CAAC,EAAE,CAAC;AAEnE,KAAK,eAAe,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,KAAK,IAAI;IACzE,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC7C,MAAM,EAAE,CAAC,EAAE,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAC7C,eAAe,CAAC,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC;IACrD,2BAA2B,EAAE,mBAAmB,CAC9C,CAAC,EACD,CAAC,CACF,CAAC,6BAA6B,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;;OAIG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,iBAAiB,CAAC;CAC9D,CAAC;AAoEF,eAAO,MAAM,kBAAkB,GAC7B,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,CAAC,SAAS,KAAK,GAAG,KAAK,EACvB,gOAgBC,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC;;mCAkNlB,MAAM;sCAMN,MAAM,YAAY,MAAM;4BA8EpB,MAAM,KACuB,MAAM;4BATrC,MAAM,KAAwC,MAAM;;gCA4BjD,MAAM;kCAcT,MAAM;2BASR,MAAM,YAAY,MAAM,eAAe,MAAM;mCAU7C,MAAM,YAAY,MAAM,eAAe,MAAM;;;;;;iCAe7C,MAAM,YAAY,MAAM,eAAe,MAAM;mCAqf7C,MAAM,YAAY,MAAM,eAAe,MAAM;yCAA7C,MAAM,YAAY,MAAM,eAAe,MAAM;2CAyB1C,MAAM,YACL,MAAM,eACH,MAAM,uBACE,qBAAqB,CAAC,IAAI,CAAC;wCAkDxC,MAAM,YAAY,MAAM,eAAe,MAAM;6BAhd/C,MAAM,YAAY,MAAM,eAAe,MAAM;iCA7D7C,MAAM,YAAY,MAAM,eAAe,MAAM;+CA2E1C,MAAM,YACL,MAAM,eACH,MAAM,aACR,GAAG;iCA6PR,MAAM,YAAY,MAAM,eAAe,MAAM;kCA9D7C,MAAM,YAAY,MAAM,eAAe,MAAM;;oCAmV7C,MAAM,YAAY,MAAM,eAAe,MAAM;2CAczC,UAAU,2BACE,yBAAyB,GAAG,IAAI;2CAqC5C,UAAU,2BACE,yBAAyB,GAAG,IAAI;2CA+I3C,UAAU;;;gDArEX,UAAU,2BACE,yBAAyB;yCAxCrC,UAAU,2BACE,yBAAyB;uCA0ErC,UAAU,2BACE,yBAAyB;2BAx6BzC,MAAM,YAAY,MAAM;mCASxB,MAAM,YAAY,MAAM;gCA3ExB,MAAM;mCAQN,MAAM;8BArCN,MAAM,eAAe,MAAM;4BAkB3B,MAAM,YAAY,MAAM;8BA+FxB,MAAM,eAAe,MAAM;kCAtG3B,MAAM,YAAY,MAAM;kCAwDxB,MAAM;iCAgBN,MAAM;iCAMN,MAAM;iCAovBN,MAAM,YAAY,MAAM,eAAe,MAAM;gCAr1BlD,wBAAwB,CAAC,IAAI,CAAC;uCAR9B,qBAAqB,CAAC,IAAI,CAAC;yCAgTtB,MAAM,YAAY,MAAM,eAAe,MAAM;2CAiB7C,MAAM,YAAY,MAAM,eAAe,MAAM;CA60B1D,CAAC"}