@rowsncolumns/spreadsheet-state 28.0.66

package/dist/cjs/hooks/use-spreadsheet-state.d.ts

@@ -0,0 +1,627 @@
+import type { CalculatorConfig } from "@rowsncolumns/calculator";
+import type { IterativeCalculationOptions, SelectionArea, Citation, CellFormat } from "@rowsncolumns/common-types";
+import type { BandedDefinition, BandedRange, CanvasGridProps, CellData, ColorMode, ConditionalFormatRule, DataValidationRuleRecord, EmbeddedChart, EmbeddedObject, NamedRange, PivotTable, ProtectedRange, SelectionAttributes, Sheet, SpreadsheetTheme, TableView, Slicer } from "@rowsncolumns/spreadsheet";
+import type { Patch } from "immer";
+import { getAutoFillValues as defaultGetAutoFillValues } from "../api/fill";
+import type { OnCommand } from "../commands";
+import type { GeneratedNames } from "../generated-names";
+import type { CellXfs, SharedStrings } from "../types";
+import type { UseCalculationProps } from "./use-calculation";
+import type { HistoryType, SpreadsheetPatch } from "./use-undo-redo";
+export type SheetData<T extends CellData = CellData> = Record<string | number, (RowData<T | null> | RowDataWithValue<T | null> | null)[]>;
+export type RowData<T extends CellData | null | undefined> = {
+    values?: T[];
+};
+export type RowDataWithValue<T extends CellData | null | undefined> = {
+    values: T[];
+};
+export type UseSpreadsheetProps<T extends CellData = CellData, S extends Sheet = Sheet> = {
+    /**
+     * List of sheets displayed in the spreadsheet
+     */
+    sheets: S[];
+    /**
+     * Active theme of the spreadsheet
+     */
+    theme?: SpreadsheetTheme;
+    /**
+     * Sheet data
+     */
+    sheetData?: SheetData<T>;
+    /**
+     * Hydrated values
+     */
+    cellXfs?: CellXfs | null;
+    /**
+     * Consolidated per-cell styles keyed by `"sheetId!A1"` (e.g. streamed from an external calc
+     * engine such as the Rust/WASM engine). When provided, an entry takes precedence over the cell's
+     * own `userEnteredFormat`/`cellXfs` style in `getEffectiveFormat`, so engine styles render across
+     * the grid, toolbar, copy, sort, etc.
+     */
+    cellStyles?: Map<string, CellFormat> | null;
+    /**
+     * Shared strings
+     */
+    sharedStrings?: SharedStrings | null;
+    /**
+     * Enable formula protection
+     */
+    protectFormulas?: CanvasGridProps["protectFormulas"];
+    /**
+     * Enabling this trigger onChangeHistory when excel file is imported using drag n drop
+     * @default false
+     */
+    enableExcelImportHistory?: boolean;
+    /**
+     * Flag to enable excel file drag and drop
+     * @default true
+     */
+    enableExcelfileDragDrop?: boolean;
+    /**
+     * Callback when users modifies a sheet
+     */
+    onChangeSheets: React.Dispatch<React.SetStateAction<S[]>>;
+    /**
+     * Callback when user changes sheet data
+     */
+    onChangeSheetData?: React.Dispatch<React.SetStateAction<SheetData<T>>>;
+    /**
+     * Callback when embed state is changed
+     */
+    onChangeEmbeds?: React.Dispatch<React.SetStateAction<EmbeddedObject[]>>;
+    /**
+     * Callback when chart state is changed
+     */
+    onChangeCharts?: React.Dispatch<React.SetStateAction<EmbeddedChart[]>>;
+    /**
+     * Callback when table state is changed
+     */
+    onChangeTables?: React.Dispatch<React.SetStateAction<TableView[]>>;
+    /**
+     * Callback to update named ranges
+     */
+    onChangeNamedRanges?: React.Dispatch<React.SetStateAction<NamedRange[]>>;
+    /**
+     * Callback to update conditional formatting
+     */
+    onChangeConditionalFormats?: React.Dispatch<React.SetStateAction<ConditionalFormatRule[]>>;
+    /**
+     * Callback to update data validations
+     */
+    onChangeDataValidations?: React.Dispatch<React.SetStateAction<DataValidationRuleRecord[]>>;
+    /**
+     * Callback to update conditional formatting
+     */
+    onChangeProtectedRanges?: React.Dispatch<React.SetStateAction<ProtectedRange[]>>;
+    /**
+     * Callback to update conditional formatting
+     */
+    onChangeBandedRanges?: React.Dispatch<React.SetStateAction<BandedRange[]>>;
+    /**
+     * Callback when table state is changed
+     */
+    onChangeTheme?: React.Dispatch<React.SetStateAction<SpreadsheetTheme>>;
+    /**
+     * Callback when cell formatting changes
+     */
+    onChangeCellXfs?: React.Dispatch<React.SetStateAction<CellXfs | undefined | null>>;
+    /**
+     * Callback when cell formatting changes
+     */
+    onChangeSharedStrings?: React.Dispatch<React.SetStateAction<SharedStrings>>;
+    /**
+     * Callback when pivot tables change
+     */
+    onChangePivotTables?: React.Dispatch<React.SetStateAction<PivotTable[]>>;
+    /**
+     * Callback when slicers change
+     */
+    onChangeSlicers?: React.Dispatch<React.SetStateAction<Slicer[]>>;
+    /**
+     * Citations array
+     */
+    citations?: Citation[];
+    /**
+     * Callback when citations change
+     */
+    onChangeCitations?: React.Dispatch<React.SetStateAction<Citation[]>>;
+    /**
+     * Preserve data formatting on paste operation
+     */
+    preserveFormattingOnPaste?: boolean;
+    /**
+     * Conditional formats
+     */
+    conditionalFormats?: ConditionalFormatRule[];
+    /**
+     * Data validation
+     */
+    dataValidations?: DataValidationRuleRecord[];
+    /**
+     * Structured tables
+     */
+    tables?: TableView[];
+    /**
+     * Named ranges
+     */
+    namedRanges?: NamedRange[];
+    /**
+     * Custom functions or named functions
+     */
+    functions?: CalculatorConfig["functions"];
+    /**
+     * Regex pattern for formulas that only execute when operation.force is true
+     */
+    onDemandFormulaPattern?: string;
+    /**
+     * Enable lazy calculation that only processes the active sheet.
+     */
+    enableLazyCalculation?: boolean;
+    /**
+     * Callback when calculator dependency graph changes
+     */
+    onChangeDependencyGraph?: UseCalculationProps["onChangeDependencyGraph"];
+    /**
+     * Callback when spreadsheet changes. Patches can be
+     * used for collaboration
+     * @param patch
+     */
+    onChangeHistory?(patches: [patch: SpreadsheetPatch<Patch>, type?: HistoryType | null][]): void;
+    /**
+     * Callback emitted alongside `onChangeHistory` whenever a high-level user
+     * intent is applied (e.g. cell edit, formatting change, row insert).
+     *
+     * Both callbacks fire for the same operation:
+     * - `onChangeHistory` carries the low-level immer patches.
+     * - `onCommand` carries the semantic intent.
+     *
+     * Forward this to a collaboration layer (e.g. `use-yspreadsheet-v3`) that
+     * applies commands to its own data structures rather than replaying
+     * immer patches.
+     */
+    onCommand?: OnCommand;
+    /**
+     * Callback fired when an error is encountered
+     * in one of the hooks
+     * @param message
+     */
+    onError?(message: string): void;
+    /**
+     * Get Autofill values
+     * Lets user to
+     */
+    getAutoFillValues?: typeof defaultGetAutoFillValues;
+    /**
+     * User-defined autofill lists (Phase 9). When the fill source matches
+     * a contiguous slice of one of these lists, autofill cycles through
+     * the list instead of running the built-in heuristics (weekday,
+     * month, numeric series). Each list is an ordered array of strings.
+     * Excel stores these per-user, not per-workbook — so they don't
+     * round-trip through xlsx, but they persist for the lifetime of the
+     * hosting app's state.
+     */
+    customAutofillLists?: string[][];
+    /**
+     * Get effective value from a structured cell
+     * Used for calculations
+     * @param sheetId
+     * @param rowIndex
+     * @param columnIndex
+     */
+    getEffectiveStructuredValue?(structuredValue: NonNullable<T["effectiveValue"]>["structuredValue"], property?: keyof typeof structuredValue): string | number | boolean | undefined;
+    /**
+     * Id creation strategy
+     * @param type
+     * @returns
+     */
+    idCreationStrategy?: <T extends "embed" | "chart" | "conditional-format" | "data-validation" | "sheet" | "named-range" | "table" | "filter-view" | "protected-range" | "pivot">(type: T) => T extends "sheet" ? number : number | string;
+    /**
+     * Dark theme classname
+     */
+    darkThemeClassName?: string;
+    /**
+     * Initial Color mode
+     */
+    colorMode?: ColorMode;
+    /**
+     * Preloaded list of fonts, Comma separated
+     * Default: 'Arial, Calibri, Consolas'
+     */
+    fonts?: string;
+    /**
+     * Enable drag and drop of CSV and image files
+     */
+    enableDragnDrop?: boolean;
+    /**
+     * Enable undo redo functionality
+     */
+    enabledUndoRedo?: boolean;
+    /**
+     * Current locale
+     * Affects date format and number formatting
+     * Auto detected from Intl.DateTimeFormat().resolvedOptions().locale
+     */
+    locale?: string;
+    /**
+     * Formatters used to customize/localize auto-generated names, e.g. new
+     * sheet titles ("Sheet1"), duplicated sheet titles ("Copy of Sheet1"),
+     * table titles ("Table 1") and generated table column names ("Column1").
+     *
+     * e.g. `{ tableColumn: (index) => `Столбец${index}`,
+     *         sheetCopy: (title) => `Копия ${title}` }`
+     *
+     * Omitted formatters (or formatters returning undefined) fall back to
+     * the English defaults. Inline object/arrow-function literals are safe:
+     * identities are stabilized internally, so a fresh object every render
+     * does not invalidate memoized callbacks.
+     */
+    generatedNames?: GeneratedNames;
+    /**
+     * Treat @-prefixed text as a formula (Excel-style implicit intersection)
+     * @default false
+     */
+    enableAtFormula?: boolean;
+    /**
+     * When a spreadsheet is initially open, A full recalculation is
+     * triggered and all formulas are evaluated.
+     *
+     * If you want to avoid that, since you already have the results evaluated or
+     * you want to do a manual recalc, set this to true
+     */
+    recalculateOnOpen?: boolean;
+    /**
+     * Limit maximum rows in a sheet
+     */
+    maxRowCount?: number;
+    /**
+     * Limit maximum columns in a sheet
+     */
+    maxColumnCount?: number;
+    /**
+     * Limit maximum number of sheets
+     */
+    maxSheetCount?: number;
+    /**
+     * Default file size limit
+     * Default value: 12 * 1024 * 1024, // 12MB Limit
+     */
+    fileSizeLimit?: number;
+    /**
+     * User can provide their own font loader
+     * @param font
+     * @returns
+     */
+    onRequestFonts?: (font: string | string[]) => Promise<void | undefined>;
+    /**
+     * Create calculation worker
+     * @returns
+     */
+    createCalculationWorker?: () => Worker;
+    /**
+     * Calculation mode: 'worker' for web worker-based calculation (default), 'single' for single UI thread calculation (legacy)
+     * @default 'worker'
+     */
+    calculationMode?: "worker" | "single";
+    /**
+     * Enable iterative calculation for circular references (worker mode only).
+     */
+    iterativeCalculation?: IterativeCalculationOptions;
+    /**
+     * Callback when importing a excel file triggers iterative calculation
+     * @param enabled
+     */
+    onIterativeCalculationEnabled?: React.Dispatch<React.SetStateAction<boolean>>;
+    /**
+     * Callback when batch stream starts
+     */
+    onStreamStart?: (streamId: string) => void;
+    /**
+     * Callback when batch stream is in progress
+     */
+    onStreamProgress?: (streamId: string, sheetId: number, lastCellPosition: {
+        rowIndex: number;
+        columnIndex: number;
+    } | null) => void;
+    /**
+     * Callback when batch stream ends
+     */
+    onStreamEnd?: (streamId: string) => void;
+    /**
+     * Custom confirm dialog function for file imports
+     * Used by importExcelFile and onInsertFile
+     */
+    onConfirm?: (message: string, options?: {
+        title?: string;
+        confirmText?: string;
+        cancelText?: string;
+    }) => Promise<boolean>;
+    /**
+     * Custom prompt dialog function for file imports
+     * Used by importExcelFile and onInsertFile for password prompts
+     */
+    onPrompt?: (message: string, options?: {
+        title?: string;
+        inputType?: string;
+        placeholder?: string;
+        confirmText?: string;
+        cancelText?: string;
+    }) => Promise<string | null>;
+    /**
+     * Optional HTML sanitizer for clipboard paste operations.
+     * Called before parsing HTML from clipboard to prevent XSS attacks.
+     * Use with DOMPurify or similar library.
+     * @example
+     * import DOMPurify from 'dompurify';
+     * <Spreadsheet sanitizeHtml={(html) => DOMPurify.sanitize(html)} />
+     */
+    sanitizeHtml?: (html: string) => string;
+};
+/**
+ * Banding for a table whose bandedRange was never materialised. Documents imported
+ * before the importers resolved built-in table style names persist only the theme
+ * name (e.g. "TableStyleMedium2"). Mirrors the importers' resolution: the built-in
+ * palette plus the stripe-toggle trim — row stripes off keeps only the header/total
+ * -row visuals, column stripes off drops the column banding.
+ */
+export declare const deriveBuiltInTableBanding: (table: TableView) => BandedDefinition | undefined;
+/**
+ * Use Spreadsheet Hook
+ * @param param0
+ * @returns
+ */
+export declare const useSpreadsheetState: <T extends CellData = CellData, S extends Sheet = Sheet>({ sheets, onChangeSheets, theme, functions, onDemandFormulaPattern, enableLazyCalculation, conditionalFormats, dataValidations, tables, namedRanges, enableExcelImportHistory, enableExcelfileDragDrop, onChangeTables, onChangeNamedRanges, onChangeCharts, onChangeEmbeds, onChangeProtectedRanges, onChangeConditionalFormats, onChangeDataValidations, onChangeBandedRanges, onChangePivotTables, sheetData, onChangeSheetData, onChangeDependencyGraph, onChangeHistory, onCommand: onCommandProp, onChangeTheme, onError, getAutoFillValues: rawGetAutoFillValues, customAutofillLists, getEffectiveStructuredValue, darkThemeClassName, colorMode, fonts, enableDragnDrop, enabledUndoRedo, locale, generatedNames: generatedNamesProp, enableAtFormula, preserveFormattingOnPaste, recalculateOnOpen, protectFormulas, maxRowCount, maxColumnCount, maxSheetCount, idCreationStrategy, fileSizeLimit, cellXfs, cellStyles, onChangeCellXfs, sharedStrings, onChangeSharedStrings, onRequestFonts, onChangeSlicers, citations, onChangeCitations, createCalculationWorker, calculationMode, iterativeCalculation, onIterativeCalculationEnabled, onStreamStart, onStreamProgress, onStreamEnd, onConfirm, onPrompt, sanitizeHtml, }: UseSpreadsheetProps<T, S>) => {
+    activeCellBySheetId: Record<number, import("@rowsncolumns/grid").CellInterface>;
+    selectionsBySheetId: Record<number, import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]>;
+    activeCell: import("@rowsncolumns/grid").CellInterface;
+    activeSheetId: number;
+    selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[];
+    showGridLines: import("@rowsncolumns/spreadsheet").Maybe<boolean>;
+    showRowColHeaders: import("@rowsncolumns/spreadsheet").Maybe<boolean>;
+    zoomScale: import("@rowsncolumns/spreadsheet").Maybe<number>;
+    rowCount: number;
+    columnCount: number;
+    frozenColumnCount: import("@rowsncolumns/spreadsheet").Maybe<number>;
+    frozenRowCount: import("@rowsncolumns/spreadsheet").Maybe<number>;
+    rowMetadata: import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").DimensionProperties>[]>;
+    columnMetadata: import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").DimensionProperties>[]>;
+    merges: import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/grid").GridRange[]>;
+    bandedRanges: BandedRange[] | undefined;
+    basicFilter: import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").FilterView>;
+    spreadsheetColors: {
+        cellColor?: import("@rowsncolumns/spreadsheet").Maybe<import("@rowsncolumns/spreadsheet").Color>;
+        headerColor?: string | undefined;
+        gridLineColor?: string | undefined;
+        cellBackgroundColor?: string | undefined;
+        headerBackgroundColor?: string | undefined;
+        headerBorderColor?: string | undefined;
+        headerActiveBackgroundColor?: string | undefined;
+        headerTableBackgroundColor?: string | undefined;
+        headerTableActiveBackgroundColor?: string | undefined;
+        chipBackgroundColor?: string | undefined;
+        selectionBorderColor?: string | undefined;
+        selectionBackgroundColor?: string | undefined;
+        selectionDragBorderColor?: string | undefined;
+        tableBorderColor?: string | undefined;
+        filterIconColor?: string | undefined;
+    };
+    isDarkMode: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    getDataRowCount: (sheetId?: number) => number | undefined;
+    getDataColumnCount: (sheetId: number) => number;
+    onRedo: () => void;
+    onUndo: () => void;
+    applyPatch: (patch: SpreadsheetPatch<Patch>) => void;
+    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;
+    getSheetName: (sheetId: number) => string;
+    getSheetId: (sheetname: string) => number;
+    getUserEnteredFormat: (sheetId: number, rowIndex: number, columnIndex: number) => T["uf"] | undefined;
+    getEffectiveFormat: (sheetId: number, rowIndex: number, columnIndex: number) => import("@rowsncolumns/spreadsheet").CellFormat | null | undefined;
+    getSeriesValuesFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange, hiddenDimensionStategy?: import("@rowsncolumns/spreadsheet").HIDDEN_DIMENSION_STRATEGY | null) => (string | number | boolean | undefined)[];
+    getDomainValuesFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange, hiddenDimensionStategy?: import("@rowsncolumns/spreadsheet").HIDDEN_DIMENSION_STRATEGY | null) => (string | null | undefined)[];
+    getUserEnteredValuesFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange, hiddenDimensionStategy?: import("@rowsncolumns/spreadsheet").HIDDEN_DIMENSION_STRATEGY) => (string | undefined)[];
+    getFormattingFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange, hiddenDimensionStategy?: import("@rowsncolumns/spreadsheet").HIDDEN_DIMENSION_STRATEGY) => import("@rowsncolumns/common-types").Maybe<CellFormat | import("@rowsncolumns/common-types").StyleReference>[];
+    getFormulasFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange, hiddenDimensionStategy?: import("@rowsncolumns/spreadsheet").HIDDEN_DIMENSION_STRATEGY) => (string | undefined)[];
+    getEffectiveValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | number | boolean | undefined;
+    getUserEnteredValue: (sheetId: number, rowIndex: number, columnIndex: number) => string | undefined;
+    getFormattedValue: (sheetId: number, rowIndex: number, columnIndex: number) => any;
+    createHistory: (callback?: (() => void) | undefined) => (patches: SpreadsheetPatch<Patch>) => void;
+    onRequestCalculate: (value: string, sheetId: number, rowIndex: number, columnIndex: number, options?: {
+        isArray?: boolean;
+        disablePreview?: boolean;
+        overrides?: Map<string, import("./use-calculation").CalculationResult | undefined | null>;
+        skipOnDemand?: boolean;
+    } | undefined) => Promise<string | import("@rowsncolumns/fast-formula-parser").FormulaResultArray | null | undefined>;
+    enqueueCalculation: ((operation: import("./use-calculation").CalculationOperation) => void) | (() => void);
+    enqueueGraphOperation: ((operation: import("./use-calculation").CalculationOperation) => void) | (() => void);
+    addFormulaToGraph: ((formulaValue: string, position: import("@rowsncolumns/dag").CellCoordinate) => void) | (() => void);
+    calculateNow: (options?: import("./use-calculation-initialize").CalculateNowOptions) => Promise<void>;
+    evaluateConditionalFormatting: (conditionalFormats?: ConditionalFormatRule[], viewport?: import("./use-calculation-initialize").ViewportInfo, disableEvaluation?: boolean) => void;
+    evaluateConditionalFormattingForViewport: (viewport: import("./use-calculation-initialize").ViewportInfo, conditionalFormats?: ConditionalFormatRule[]) => void;
+    evaluateDataValidations: (dataValidations?: DataValidationRuleRecord[], viewport?: import("./use-calculation-initialize").ViewportInfo, disableEvaluation?: boolean) => void;
+    evaluateDataValidationsForViewport: (viewport: import("./use-calculation-initialize").ViewportInfo, dataValidations?: DataValidationRuleRecord[]) => void;
+    clearEvaluatedCellsCache: () => void;
+    onViewPortChange: (viewport: import("./use-calculation-initialize").ViewportInfo) => void;
+    reevaluateDerivationsForCells: (cells: Array<Pick<import("@rowsncolumns/dag").CellCoordinate, "sheetId" | "rowIndex" | "columnIndex">>) => void;
+    onChangeActiveCell: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface) => void;
+    onChangeSelections: (sheetId: number, selections: SelectionArea<SelectionAttributes>[], finishedSelection?: boolean) => void;
+    onChangeActiveSheet: (sheetId: number) => void;
+    onSelectNextSheet: (sheetId: number, e?: React.KeyboardEvent<HTMLDivElement>) => void;
+    onSelectPreviousSheet: (sheetId: number, e?: React.KeyboardEvent<HTMLDivElement>) => void;
+    onChange: (sheetId: number, coords: import("@rowsncolumns/common-types").CellInterface, value: string, textFormatRuns: import("@rowsncolumns/common-types").TextFormatRun[] | undefined | null, previousValue?: string | boolean | undefined, isDirty?: boolean, previousTextFormatRuns?: import("@rowsncolumns/common-types").TextFormatRun[] | undefined | null) => void;
+    onChangeBatch: (sheetId: number, ranges: import("@rowsncolumns/common-types").GridRange[] | import("@rowsncolumns/common-types").GridRange, values: (string | boolean | number | null | undefined)[][] | string | boolean | number | null | undefined, formatting?: CellFormat | (CellFormat | null | undefined)[][] | null | undefined, citations?: (string | undefined | null)[][] | string | null | undefined, changeBatchOptions?: import("../interface/change-batch").ChangeBatchOptions) => void;
+    onChangeBatchStream: (sheetId: number, range: import("@rowsncolumns/common-types").GridRange, stream: import("../types").ChangeBatchStreamInput, options?: import("@rowsncolumns/spreadsheet").ChangeBatchStreamOptions) => Promise<void> | undefined;
+    onChangeFormatting: (...args: [sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], cellFormatOrCellFormatArray: import("@rowsncolumns/spreadsheet").CellFormat | (import("@rowsncolumns/spreadsheet").CellFormat | null | undefined)[][] | null | undefined, options?: import("./use-on-change-formatting").FormattingChangeOptions | undefined] | [sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], type: keyof import("@rowsncolumns/spreadsheet").CellFormat, value: import("@rowsncolumns/spreadsheet").FormattingValue<keyof import("@rowsncolumns/spreadsheet").CellFormat>, options?: import("./use-on-change-formatting").FormattingChangeOptions | undefined]) => void;
+    onRepeatFormatting: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onClearFormatting: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onMergeCells: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[], direction?: import("@rowsncolumns/grid").Direction) => void;
+    onUnMergeCells: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, currentSelections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onResize: (sheetId: number, indexes: number[], dimension: number, axis: import("@rowsncolumns/spreadsheet").AXIS, autoFit?: boolean) => void;
+    onChangeBorder: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], location: import("@rowsncolumns/spreadsheet").BorderLocation, color: import("@rowsncolumns/spreadsheet").Color | undefined, style?: import("@rowsncolumns/spreadsheet").BorderStyle | undefined) => void;
+    onChangeDecimals: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], type: "increment" | "decrement") => void;
+    onChangeSheetTabColor: (sheetId: number, color: import("@rowsncolumns/spreadsheet").Color | undefined) => void;
+    onRenameSheet: (sheetId: number, name: string, oldName: string) => void;
+    onRequestDeleteSheet: (sheetId: number) => void;
+    onDeleteSheet: (sheetId: number) => void;
+    onDelete: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], clearType?: import("..").ClearType) => void;
+    onHideSheet: (sheetId: number) => void;
+    onShowSheet: (sheetId: number) => void;
+    onProtectSheet: (sheetId: number) => void;
+    onUnProtectSheet: (sheetId: number) => void;
+    onMoveSheet: (sheetId: number, currentPosition: number, newPosition: number) => void;
+    onCreateNewSheet: (sheetSpec?: Partial<Sheet> | React.MouseEvent) => S | undefined;
+    onUpdateSheet: (sheetId: number, sheetSpec: Partial<S>) => S | undefined;
+    onDuplicateSheet: (sheetId: number) => void;
+    onHideColumn: (sheetId: number, columnIndexes: number[]) => void;
+    onShowColumn: (sheetId: number, columnIndexes: number[]) => void;
+    onHideRow: (sheetId: number, rowIndexes: number[]) => void;
+    onShowRow: (sheetId: number, rowIndexes: number[]) => void;
+    onGroupRows: (sheetId: number, rowIndexes: number[]) => void;
+    onUngroupRows: (sheetId: number, rowIndexes: number[]) => void;
+    onCollapseRowGroup: (sheetId: number, summaryRowIndex: number) => void;
+    onExpandRowGroup: (sheetId: number, summaryRowIndex: number) => void;
+    onGroupColumns: (sheetId: number, columnIndexes: number[]) => void;
+    onUngroupColumns: (sheetId: number, columnIndexes: number[]) => void;
+    onCollapseColumnGroup: (sheetId: number, summaryColumnIndex: number) => void;
+    onExpandColumnGroup: (sheetId: number, summaryColumnIndex: number) => void;
+    onSetOutlineDepth: (sheetId: number, axis: "row" | "column", depth: number) => void;
+    onFill: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, fillSelection: SelectionArea, selections: SelectionArea<SelectionAttributes>[], fillableSelections?: SelectionArea<SelectionAttributes>[], fillType?: import("../api/fill").AutoFillType) => Promise<void>;
+    onFillRange: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], direction: import("@rowsncolumns/grid").Direction | undefined) => void;
+    onMoveEmbed: (embedId: string | number, sheetId: number, anchorCell: import("@rowsncolumns/grid").CellInterface, offsetXPixels: number, offsetYPixels: number) => void;
+    onResizeEmbed: (embedId: string | number, sheetId: number, anchorCell: import("@rowsncolumns/grid").CellInterface, offsetXPixels: number, offsetYPixels: number, width: number, height: number) => void;
+    onDeleteEmbed: (embedId: string | number) => void;
+    onCreateEmbed: (spec: EmbeddedObject) => void;
+    onRequestEditEmbed: (embed: EmbeddedObject) => void;
+    onMoveSlicer: (slicerId: string | number, sheetId: number, anchorCell: import("@rowsncolumns/grid").CellInterface, offsetXPixels: number, offsetYPixels: number) => void;
+    onResizeSlicer: (slicerId: string | number, sheetId: number, anchorCell: import("@rowsncolumns/grid").CellInterface, offsetXPixels: number, offsetYPixels: number, width: number, height: number) => void;
+    onDeleteSlicer: (slicerId: string | number) => void;
+    onCreateSlicer: (spec: Slicer) => void;
+    onUpdateSlicer: (slicer: Slicer) => void;
+    onRequestEditSlicer: (slicer: Slicer) => void;
+    onDeleteRow: (sheetId: number, rowIndexes: number[]) => void;
+    onDeleteColumn: (sheetId: number, columnIndexes: number[]) => void;
+    onDeleteCellsShiftUp: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onDeleteCellsShiftLeft: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onInsertCellsShiftRight: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onInsertCellsShiftDown: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onInsertRow: (sheetId: number, referenceRowIndex: number, numRows?: number) => void;
+    onInsertColumn: (sheetId: number, referenceColumnIndex: number, numColumns?: number) => void;
+    onMoveColumns: (sheetId: number, columns: number[], referenceColumnIndex: number) => void;
+    onMoveRows: (sheetId: number, rows: number[], referenceRowIndex: number) => void;
+    onMoveSelection: (sheetId: number, from: SelectionArea<SelectionAttributes>, to: SelectionArea<SelectionAttributes>) => void;
+    onSortColumn: (sheetId: number, sortedColumnIndex: number, sortOrder: import("@rowsncolumns/common-types").SortOrder, options?: import("./use-on-sort-column").SortColumnOptions, additionalLevels?: import("./use-on-sort-column").SortColumnLevel[]) => void;
+    onSortTable: import("./use-on-sort-table").OnSortTable;
+    onFilterTable: (sheetId: number, filter: TableView | import("@rowsncolumns/spreadsheet").FilterView, columnIndex: number, conditionType: import("@rowsncolumns/common-types").ConditionType | undefined, conditionValue: import("@rowsncolumns/common-types").ConditionValue[] | undefined, visibleValues: string[] | undefined | null, extras?: import("./use-on-filter-table").FilterTableExtras) => Promise<void>;
+    onDeleteFilter: (sheetId: number, filter: TableView | import("@rowsncolumns/spreadsheet").FilterView, columnIndex: number) => Promise<void>;
+    onResizeTable: (sheetId: number, table: TableView, range: import("@rowsncolumns/grid").GridRange) => void;
+    onInsertTableColumn: (tableView: TableView, dimensionIndex: number, direction: import("@rowsncolumns/grid").Direction.Left | import("@rowsncolumns/grid").Direction.Right) => void;
+    onInsertTableRow: (tableView: TableView, relativeRowIndex?: number, rowData?: Record<string, string | undefined | null>[]) => void;
+    onDeleteTableColumn: (tableView: TableView, dimensionIndex: number) => void;
+    onDeleteTableRow: (tableView: TableView, rowIndexes: number[]) => void;
+    onCopy: (e: ClipboardEvent | undefined, sheetId: number, copiedSelections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onPaste: (e: ClipboardEvent | undefined, sourceSheetId: number | undefined, destinationSheetId: number, copiedSelections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[] | undefined, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[] | undefined, finalSelections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[] | undefined, isCutOperation: boolean) => Promise<void>;
+    onCreateBasicFilter: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[], basicFilterSpec?: Partial<import("@rowsncolumns/spreadsheet").FilterView>) => void;
+    onCreateTable: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[], tableSpec?: Partial<TableView>, theme?: import("@rowsncolumns/spreadsheet").TableTheme, bandedRange?: BandedDefinition) => void;
+    onRemoveTable: (tableView: TableView) => void;
+    onRequestEditTable: (table: TableView) => void;
+    onUpdateTable: (sheetId: number, tableId: TableView["id"], updatedTable: Partial<TableView>) => void;
+    onRequestDefineNamedRange: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onRequestUpdateNamedRange: (sheetId: number, namedRange: NamedRange) => void;
+    onUpdateNamedRange: (sheetId: number, namedRange: NamedRange, previousNamedRange: NamedRange) => void;
+    onCreateNamedRange: (sheetId: number, namedRange: NamedRange) => void;
+    onDeleteNamedRange: (id: NamedRange["namedRangeId"]) => void;
+    onDragOver: (e: React.DragEvent<HTMLDivElement>) => void;
+    onDrop: (e: React.DragEvent<HTMLDivElement>) => Promise<void>;
+    onInsertFile: (file: File, sheetIdToInsert?: number, activeCell?: import("@rowsncolumns/common-types").CellInterface, options?: import("./use-on-drag-n-drop").InsertFileOptions) => Promise<void>;
+    onFreezeColumn: (sheetId: number, columnIndex: number) => void;
+    onFreezeRow: (sheetId: number, rowIndex: number) => void;
+    onChangeSpreadsheetTheme: (theme: SpreadsheetTheme) => Promise<void>;
+    onAddBandedRange: (sheetId: number, bandedRange: BandedRange) => void;
+    onRemoveBandedRange: (sheetId: number, bandedRange: BandedRange) => void;
+    onUpdateNote: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, note?: string) => void;
+    onInsertNote: (sheetId: number, cell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onSortRange: (sheetId: number, selections: SelectionArea<SelectionAttributes>[], sortOrder: import("@rowsncolumns/common-types").SortOrder, specs?: import("./utils/sort-rows").DimensionSortSpec[]) => void;
+    onProtectRange: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[] | undefined) => void;
+    onUnProtectRange: (sheetId: number, protectedRangeId: number | string) => void;
+    getNonEmptyRowCount: (sheetId: number) => number | undefined;
+    getNonEmptyColumnCount: (sheetId: number, rowIndex: number) => number | undefined;
+    getSheetRowCount: (sheetId: number) => number;
+    getSheetColumnCount: (sheetId: number) => number;
+    onIncreaseIndent: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onDecreaseIndent: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onChangeIndent: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[], shouldIncrease: boolean) => void;
+    onRequestResize: (sheetId: number, indexes: number[], axis: import("@rowsncolumns/spreadsheet").AXIS) => void;
+    onAutoResize: (sheetId: number, indexes: number[], axis: import("@rowsncolumns/spreadsheet").AXIS) => void;
+    getColumnarDataFromRange: (sheetRange: import("@rowsncolumns/common-types").SheetRange) => {
+        [key: string]: (string | number | boolean | Date)[];
+    };
+    onInsertTime: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onInsertDate: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onInsertDateTime: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[]) => void;
+    onRequestInsertLink: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onInsertLink: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[] | undefined, url: string, title?: string) => void;
+    onRemoveLink: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections?: SelectionArea<SelectionAttributes>[]) => void;
+    onSelectLink: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, hyperlink: T["hyperlink"]) => void;
+    onRequestInsertImage: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, insertOverCells?: boolean) => void;
+    onInsertImage: (fileOrUrl: File | string, sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, options?: (import("./use-on-drag-n-drop").InsertFileOptions & {
+        embedId?: string | number;
+    }) | undefined) => Promise<void>;
+    onInsertCheckbox: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    onRequestFormatCells: () => void;
+    onRequestConditionalFormat: () => void;
+    onCreateConditionalFormattingRule: (rule: ConditionalFormatRule) => void;
+    onUpdateConditionalFormattingRule: (updatedRule: ConditionalFormatRule, previousRule: ConditionalFormatRule) => void;
+    onDeleteConditionalFormattingRule: (rule: ConditionalFormatRule) => void;
+    onPreviewConditionalFormattingRule: (rule: ConditionalFormatRule) => void;
+    onRequestDataValidation: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, selections: import("@rowsncolumns/grid").SelectionArea<SelectionAttributes>[], initialDataValidationRule?: DataValidationRuleRecord, showEditUI?: boolean) => void;
+    onDeleteDataValidationRules: (rules: DataValidationRuleRecord[]) => void;
+    onDeleteDataValidationRule: (rule: DataValidationRuleRecord) => void;
+    onCreateDataValidationRule: (rule: DataValidationRuleRecord, options?: import("../interface/data-validation-rules").CreateDataValidationRuleOptions) => void;
+    onUpdateDataValidationRule: (rule: DataValidationRuleRecord, previousRule: DataValidationRuleRecord) => void;
+    getDependencyGraph: (() => string) | (() => "[]");
+    updateDependencyGraph: ((nodes: string) => void) | (() => void);
+    onFindReplace: (lookupRanges: import("@rowsncolumns/common-types").SheetRange[], searchStr: string, replaceWith: string | undefined, options?: import("./use-search").SearchOptions) => void;
+    onInsertAutoSum: (sheetId: number, activeCell: import("@rowsncolumns/grid").CellInterface, functionName?: "SUM" | "AVERAGE" | "COUNT" | "MAX" | "MIN") => void;
+    cellXfsRegistry: import("./use-cellxfs-registry").CellXfsRegistry;
+    onChangeCellXfs: import("react").Dispatch<import("react").SetStateAction<CellXfs | null | undefined>> | undefined;
+    sharedStringRegistry: import("./use-ss-registry").SharedStringRegistry;
+    importExcelFile: (file: File | ArrayBuffer, options?: import("./use-on-import-excel").ExcelImportOptions) => Promise<import("./use-on-import-excel").ExcelImportResponse>;
+    isImportingExcelfile: boolean;
+    generateStatePatches: () => Promise<SpreadsheetPatch>;
+    importCSVFile: (file: File, sheetId?: number, activeCell?: import("@rowsncolumns/common-types").CellInterface, options?: import("./use-on-drag-n-drop").InsertFileOptions) => Promise<void>;
+    importCSVFileLegacy: (file: File, sheetId?: number, activeCell?: import("@rowsncolumns/common-types").CellInterface, options?: import("./use-on-drag-n-drop").InsertFileOptions) => Promise<void>;
+    paintFormat: (sourceSheetRange: import("@rowsncolumns/common-types").SheetRange, targetSheetRange: import("@rowsncolumns/common-types").SheetRange) => void;
+    onSavePaintFormat: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections: SelectionArea<SelectionAttributes>[]) => void;
+    isPaintFormatActive: boolean;
+    onApplyPaintFormat: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections?: SelectionArea<SelectionAttributes>[]) => void;
+    getSheetProperties: (sheetId: number) => import("@rowsncolumns/calculator").SheetProperty | undefined;
+    getEffectiveExtendedValue: (sheetId: number, rowIndex: number, columnIndex: number) => T["ev"];
+    getUserEnteredExtendedValue: (sheetId: number, rowIndex: number, columnIndex: number) => T["ue"];
+    getErrorValue: (sheetId: number, rowIndex: number, columnIndex: number) => any;
+    onSplitTextToColumns: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections?: SelectionArea<SelectionAttributes>[], delimiter?: string) => void;
+    onRemoveDuplicates: (sheetId: number, activeCell: import("@rowsncolumns/common-types").CellInterface, selections?: SelectionArea<SelectionAttributes>[]) => import("../interface/remove-duplicates").RemoveDuplicatesResult | undefined;
+    onRequestAddRows: (sheetId: number, additionalRowCount: number) => S | undefined;
+    getDependents: ((source: import("@rowsncolumns/dag").CellCoordinate | import("@rowsncolumns/dag").CellCoordinateRange, includeSource?: boolean) => (import("@rowsncolumns/dag").CellNode | import("@rowsncolumns/dag").StaticNode)[]) | (() => never[]);
+    getPrecedents: ((source: import("@rowsncolumns/dag").CellCoordinate | import("@rowsncolumns/dag").CellCoordinateRange, includeSource?: boolean) => (import("@rowsncolumns/dag").CellNode | import("@rowsncolumns/dag").StaticNode | import("@rowsncolumns/dag").CellRangeNode)[]) | (() => never[]);
+    getDataValidation: (sheetId: number, rowIndex: number, columnIndex: number) => import("@rowsncolumns/common-types").Maybe<import("@rowsncolumns/common-types").DataValidationRule>;
+    arrows: import("react").ReactNode[];
+    onRemoveArrows: () => void;
+    onTraceDependents: (sheetId: number, cell: import("@rowsncolumns/common-types").CellInterface) => void;
+    onTracePrecedents: (sheetId: number, cell: import("@rowsncolumns/common-types").CellInterface) => void;
+    onClearHistory: () => void;
+    onChangeLocale: (newLocale: string, oldLocale?: string) => void;
+    onInsertComment: (sheetId: number, rowIndex: number, columnIndex: number, commentThreadId: string | number | undefined) => void;
+    onRemoveComment: (sheetId: number, rowIndex: number, columnIndex: number) => void;
+    onCreateCitation: (sheetId: number, rowIndex: number, columnIndex: number, citation: Citation) => void;
+    onUpdateCitation: (citationId: string, updates: Partial<Omit<Citation, "id">>) => void;
+    onRemoveCitationFromCell: (sheetId: number, rowIndex: number, columnIndex: number) => void;
+    onDeleteCitation: (citationId: string) => void;
+};
+//# sourceMappingURL=use-spreadsheet-state.d.ts.map