@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/sheet/_CopyUtils.d.ts

@@ -0,0 +1,33 @@
+import { IRange } from '@sheetxl/primitives';
+import { IMovable } from '../movable';
+import { ICellRange, ICellHeaderRange } from '../cellRange';
+import { ISheet } from './ISheet';
+import { Sheet } from './Sheet';
+/**
+ * The pasted images of `areas` (absolute ranges within the marked source `coordFrom`):
+ * each area's offset within the source, tiled across the fitted destination `rangeTo` with
+ * the source's period, transposed when the paste is, and clipped to the destination.
+ * Adjacent tile images coalesce into single rectangles.
+ *
+ * @remarks
+ * This is the anchored-model (conditional format / data validation) counterpart of the
+ * spatial maps' `createCopiedEntries` tiling: the destination `_copyFrom` hands to `copyTo`
+ * is already LCM-expanded or clipped, so tiling here is a pure function of the two ranges.
+ */
+export declare function tileMarkedAreas(areas: readonly IRange.Coords[], coordFrom: Readonly<IRange.Coords>, rangeTo: Readonly<IRange.Coords>, transpose?: boolean): IRange.Coords[];
+/**
+ * Converts a header snapshot to sheet.
+ */
+export declare function headerToSheetSnapshot(rangeMark: ICellHeaderRange, coordMark: IRange.Coords, optionsMark: ICellHeaderRange.CopyOptions): Partial<ICellRange.ISnapshot>;
+/**
+ * Wraps a copySheetTo function into a ISheet.ISnapshot.
+ * * This will error if snapshot is a cut and called a second.
+ * @internal
+ */
+export declare function callbackToSheetSnapshot(sheetFrom: ISheet, sheetMark: ISheet, coordsFrom: readonly IRange.Coords[], description: string, optionsMark: ICellRange.CopyOptions, copySheetTo: (sheetRange: ICellRange, options?: ICellRange.CopyOptions) => Promise<IRange.Coords> | IRange.Coords): ICellRange.ISnapshot;
+/**
+ * Converts an array of Snapshots into a single snapshot.
+ */
+export declare function arrToSheetSnapshot(snapshots: Partial<ICellRange.ISnapshot>[], sheet: ISheet, sheetMark: ISheet, coordsMark: IRange.Coords, optionsMark: ICellRange.CopyOptions, descriptionMark: string, snapshotNative?: ICellRange.ISnapshot | null): ICellRange.ISnapshot;
+export declare function movablesToSheetSnapshot(sheetMark: Sheet, coordsMark: readonly IRange.Coords[], movablesSelectionMark: readonly IMovable[], markOptions: ICellRange.CopyOptions): ICellRange.ISnapshot<ISheet> | null;
+//# sourceMappingURL=_CopyUtils.d.ts.map

package/types/src/sheet/_CopyUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_CopyUtils.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_CopyUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAS3C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAUtE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAC/B,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAChC,SAAS,GAAE,OAAa,GACvB,MAAM,CAAC,MAAM,EAAE,CA4CjB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,gBAAgB,EAC3B,SAAS,EAAE,MAAM,CAAC,MAAM,EACxB,WAAW,EAAE,gBAAgB,CAAC,WAAW,GACxC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CA0C/B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EACpC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,UAAU,CAAC,WAAW,EACnC,WAAW,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,GAChH,UAAU,CAAC,SAAS,CAkEtB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAC1C,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,CAAC,MAAM,EACzB,WAAW,EAAE,UAAU,CAAC,WAAW,EACnC,eAAe,EAAE,MAAM,EACvB,cAAc,GAAE,UAAU,CAAC,SAAS,GAAG,IAAS,GAC/C,UAAU,CAAC,SAAS,CAsEtB;AAGD,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,KAAK,EAChB,UAAU,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EACpC,qBAAqB,EAAE,SAAS,QAAQ,EAAE,EAC1C,WAAW,EAAE,UAAU,CAAC,WAAW,GAClC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CA8KrC"}

package/types/src/sheet/_InvalidSheetRange.d.ts

@@ -0,0 +1,70 @@
+import { IRange, Scalar, IRangeStats } from '@sheetxl/primitives';
+import { IListener } from '../listener';
+import { IStyle } from '../style';
+import { ICell } from '../cell';
+import { ISheet } from './ISheet';
+import { ICellRange, ICellRegions, ICellRanges, ICellHeaderRanges } from '../cellRange';
+import { SheetRanges, SheetRangesOptions } from './SheetRanges';
+export declare function RETURN_FALSE(): boolean;
+export declare function RETURN_TRUE(): boolean;
+export declare function RETURN_NULL(): any;
+export declare function getInvalidCell(sheet: ISheet | null): ICell;
+/**
+ * This is for 0 size ranges.
+ * @internal
+ */
+export declare const InvalidSheetRange: ICellRange;
+export declare class InvalidSheetRanges extends SheetRanges {
+    constructor(sheet: any, options?: SheetRangesOptions);
+    getMerges(): IRange.Coords[];
+    getStyle(): IStyle;
+    find(): Iterator<ICell>;
+    [Symbol.iterator](): IterableIterator<Scalar>;
+    entries(): IterableIterator<ICellRange.Entry>;
+    calculate(): this;
+    clear(): this;
+    merge(): this;
+    unmerge(): this;
+    insert(): this;
+    delete(): this;
+    insertFrom(): Promise<this | null>;
+    getSnapshot(): ICellRange.ISnapshot;
+    copyFrom(): Promise<this | null>;
+    getEntireRows(): this;
+    getEntireColumns(): this;
+    getRowHeaders(): ICellHeaderRanges;
+    getColumnHeaders(): ICellHeaderRanges;
+    getDefaultShiftAxis(): IRange.Axis;
+    getFlattened(): this;
+    getVisible(): this | null;
+    getAddress(): string;
+    getStats(): IRangeStats;
+    getCounts(): ICellRange.Counts;
+    getRegions(): ICellRegions;
+    getDirectPrecedents(): ICellRanges | null;
+    getDirectDependents(): ICellRanges | null;
+    getPrecedents(): ICellRanges | null;
+    getDependents(): ICellRanges | null;
+    isContentful(): boolean;
+    getRowCount(): number;
+    getColumnCount(): number;
+    isReadOnly(): boolean;
+    isOverlapping(): boolean;
+    isEntireRows(): boolean;
+    isEntireRowsAny(): boolean;
+    isEntireColumns(): boolean;
+    isEntireColumnsAny(): boolean;
+    isInvalidAny(): boolean;
+    isSingleCell(): boolean;
+    isEqual(): boolean;
+    getFixed(): this;
+    getCount(): number;
+    at(): ICellRange;
+    doBatch<R>(): R | Promise<R>;
+    getCoords(): readonly Readonly<IRange.FixableCoords>[];
+    isInvalid(): boolean;
+    toString(): string;
+    select(): Promise<this>;
+    addListener(): IListener.Remove;
+}
+//# sourceMappingURL=_InvalidSheetRange.d.ts.map

package/types/src/sheet/_InvalidSheetRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_InvalidSheetRange.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_InvalidSheetRange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAG7F,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAmB,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAU5G,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAWrE,wBAAgB,YAAY,IAAI,OAAO,CAEtC;AACD,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAED,wBAAgB,WAAW,IAAI,GAAG,CAEjC;AAoFD,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAQ1D;AAgBD;;;GAGG;AAGH,eAAO,MAAM,iBAAiB,EAAE,UA8I/B,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,WAAW;gBAE/C,KAAK,EAAE,GAAG,EACV,OAAO,CAAC,EAAE,kBAAkB;IAK9B,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE;IAC5B,QAAQ,IAAI,MAAM;IAElB,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC;IACvB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAC7C,OAAO,IAAI,gBAAgB,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7C,SAAS,IAAI,IAAI;IACjB,KAAK,IAAI,IAAI;IACb,KAAK,IAAI,IAAI;IACb,OAAO,IAAI,IAAI;IACf,MAAM,IAAI,IAAI;IACd,MAAM,IAAI,IAAI;IACd,UAAU,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAClC,WAAW,IAAI,UAAU,CAAC,SAAS;IACnC,QAAQ,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAChC,aAAa,IAAI,IAAI;IACrB,gBAAgB,IAAI,IAAI;IACxB,aAAa,IAAI,iBAAiB;IAClC,gBAAgB,IAAI,iBAAiB;IACrC,mBAAmB,IAAI,MAAM,CAAC,IAAI;IAClC,YAAY,IAAI,IAAI;IACpB,UAAU,IAAI,IAAI,GAAG,IAAI;IACzB,UAAU,IAAI,MAAM;IACpB,QAAQ,IAAI,WAAW;IACvB,SAAS,IAAI,UAAU,CAAC,MAAM;IAC9B,UAAU,IAAI,YAAY;IAC1B,mBAAmB,IAAI,WAAW,GAAG,IAAI;IACzC,mBAAmB,IAAI,WAAW,GAAG,IAAI;IACzC,aAAa,IAAI,WAAW,GAAG,IAAI;IACnC,aAAa,IAAI,WAAW,GAAG,IAAI;IACnC,YAAY,IAAI,OAAO;IACvB,WAAW,IAAI,MAAM;IACrB,cAAc,IAAI,MAAM;IACxB,UAAU,IAAI,OAAO;IACrB,aAAa,IAAI,OAAO;IACxB,YAAY,IAAI,OAAO;IACvB,eAAe,IAAI,OAAO;IAC1B,eAAe,IAAI,OAAO;IAC1B,kBAAkB,IAAI,OAAO;IAC7B,YAAY,IAAI,OAAO;IACvB,YAAY,IAAI,OAAO;IACvB,OAAO,IAAI,OAAO;IAClB,QAAQ,IAAI,IAAI;IAChB,QAAQ,IAAI,MAAM;IAElB,EAAE,IAAI,UAAU;IAChB,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAC5B,SAAS,IAAI,SAAS,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;IACtD,SAAS,IAAI,OAAO;IACpB,QAAQ,IAAI,MAAM;IAClB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IACvB,WAAW,IAAI,SAAS,CAAC,MAAM;CAChC"}

package/types/src/sheet/_SheetAutoFitUtils.d.ts

@@ -0,0 +1,18 @@
+import { IRange } from '@sheetxl/primitives';
+import { ICellRange } from '../cellRange';
+import { Sheet } from './Sheet';
+/**
+ * Automatically adjusts row heights and column widths to fit cell content and styles.
+ * - Merges and sorts input ranges for efficient processing.
+ * - Measures both style and content to determine optimal sizes.
+ * - Handles merged cells, wrapped text, and special alignments.
+ * - Updates header sizes in a single transaction for undo/redo support.
+ * - Optimized for large sheets, but can be further improved for extreme cases.
+ *
+ * @param sheet The sheet to fit.
+ * @param ranges Ranges to autofit.
+ * @param options AutoFit options (axis, expandOnly, skipCustomSize, etc).
+ * @internal
+ */
+export declare function doAutoFit(sheet: Sheet, ranges: readonly IRange.Coords[], options?: ICellRange.AutoFitOptions): void;
+//# sourceMappingURL=_SheetAutoFitUtils.d.ts.map

package/types/src/sheet/_SheetAutoFitUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetAutoFitUtils.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetAutoFitUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,MAAM,EAA6B,MAAM,qBAAqB,CAAC;AAQpF,OAAO,EAAE,KAAK,UAAU,EAAyB,MAAM,cAAc,CAAC;AAkBtE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAq7BrC;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAChC,OAAO,CAAC,EAAE,UAAU,CAAC,cAAc,GAClC,IAAI,CAmKN"}

package/types/src/sheet/_SheetCoords.d.ts

@@ -0,0 +1,54 @@
+import { IRange } from '@sheetxl/primitives';
+import { ICell } from '../cell';
+import { ICellRange, ICellRanges } from '../cellRange';
+import { ISheetProtection } from '../sheetProtection';
+import { SheetCoordContext } from './Sheet';
+/**
+ * Coordinate/address resolution for a {@link Sheet}: parses addresses into coords, validates bounds,
+ * runs protection checks, and constructs the `ICellRange`/`ICellRanges` handles. Functions take a
+ * {@link SheetCoordContext} (the caches/options/collections they read) rather than the sheet
+ * instance; `Sheet` keeps thin delegators. See `private-assets/design/SHEET-SPLIT-DESIGN.md` §5.
+ * @internal
+ */
+/**
+ * A callback that, given the parsed coords of an operation, returns the protection keys the operation
+ * requires. Passed to {@link rangesToCoords} / {@link rangeToCoords} / {@link protectionCheck} so the
+ * parsed range is visible to the check.
+ * @internal
+ */
+export interface ProtectionCheck {
+    (coords?: IRange.Coords[]): ISheetProtection.PropertyKeys[];
+}
+/** @internal */
+export declare function createRange(ctx: SheetCoordContext, coords: Readonly<IRange.FixableCoords> | string, getOptions?: ICellRange.GetRangeOptions, readOnly?: string | null): ICellRange;
+/** @internal */
+export declare function createRanges(ctx: SheetCoordContext, coords: readonly (IRange.Coords | string | ICellRange)[], getOptions?: ICellRange.GetRangeOptions, readOnly?: string | null): ICellRanges;
+/** @internal */
+export declare function cellToCoords(ctx: SheetCoordContext, address: ICell.Address): IRange.CellCoords;
+/** @internal */
+export declare function validateCoords(ctx: SheetCoordContext, coords: IRange.Coords, oobMessage?: string, allowOutOfBounds?: boolean): void;
+/** @internal */
+export declare function createRangeError(address: ICellRanges.Address): Error;
+/** @internal */
+export declare function protectionCheck(ctx: SheetCoordContext, check?: ProtectionCheck | null, coords?: Readonly<IRange.Coords> | readonly IRange.Coords[] | null, action?: string | null): void;
+/**
+ * Returns an array of ranges.
+ *
+ * @param address
+ * @param protectionCheckFn
+ *
+ * @remarks
+ * Defaults to maxCoords.
+ * Returns an error if the address is unparsable.
+ * @internal
+ */
+export declare function rangesToCoords(ctx: SheetCoordContext, address: ICellRanges.Address, protectionCheckFn?: ProtectionCheck | null | undefined, lookupNames?: boolean, requireSameSheet?: boolean, allowOutOfBounds?: boolean): IRange.Coords[];
+/**
+ * Returns exactly 1 range.
+ *
+ * @remarks
+ * This does not default address to maxCoords and fill error if anything other than 1 range is returned.
+ * @internal
+ */
+export declare function rangeToCoords(ctx: SheetCoordContext, address: ICellRange.Address, protectionCheckFn?: ProtectionCheck | null, lookupNames?: boolean): IRange.Coords;
+//# sourceMappingURL=_SheetCoords.d.ts.map

package/types/src/sheet/_SheetCoords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetCoords.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetCoords.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAW3D,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEjD;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,YAAY,EAAE,CAAC;CAC7D;AAED,gBAAgB;AAChB,wBAAgB,WAAW,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,eAAe,EAAE,QAAQ,GAAE,MAAM,GAAG,IAAS,GAAG,UAAU,CAiDtL;AAED,gBAAgB;AAChB,wBAAgB,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,eAAe,EAAE,QAAQ,GAAE,MAAM,GAAG,IAAS,GAAG,WAAW,CAajM;AAED,gBAAgB;AAChB,wBAAgB,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAe9F;AAED,gBAAgB;AAChB,wBAAgB,cAAc,CAC5B,GAAG,EAAE,iBAAiB,EACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EACrB,UAAU,GAAE,MAAgC,EAC5C,gBAAgB,GAAE,OAAe,GAChC,IAAI,CAmBN;AAED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,KAAK,CAKpE;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,GAAG,EAAE,iBAAiB,EACtB,KAAK,GAAE,eAAe,GAAG,IAAS,EAClC,MAAM,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,IAAS,EACtE,MAAM,GAAE,MAAM,GAAG,IAAS,GACzB,IAAI,CA4BN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,iBAAiB,EACtB,OAAO,EAAE,WAAW,CAAC,OAAO,EAC5B,iBAAiB,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC1D,WAAW,GAAE,OAAY,EACzB,gBAAgB,GAAE,OAAa,EAC/B,gBAAgB,GAAE,OAAa,GAC9B,MAAM,CAAC,MAAM,EAAE,CAwDjB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAE,eAAe,GAAG,IAAS,EAAE,WAAW,GAAE,OAAY,GAAG,MAAM,CAAC,MAAM,CAW3K"}

package/types/src/sheet/_SheetFilterUtils.d.ts

@@ -0,0 +1,9 @@
+import { IRange } from '@sheetxl/primitives';
+import { ITransaction } from '../transaction';
+import { ICondition } from '../condition';
+import { Sheet } from './Sheet';
+/**
+ * Sheet specific filter utils. Mirrors `_SheetSortUtils.doSort`.
+ */
+export declare function doFilter(sheet: Sheet, coords: Readonly<IRange.Coords>, condition: ICondition.Input | ICondition.RangeOptions, options?: ITransaction.OperationOptions): Promise<IRange.Coords>;
+//# sourceMappingURL=_SheetFilterUtils.d.ts.map

package/types/src/sheet/_SheetFilterUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetFilterUtils.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetFilterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAM/C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,wBAAsB,QAAQ,CAC5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAC/B,SAAS,EAAE,UAAU,CAAC,KAAK,GAAG,UAAU,CAAC,YAAY,EACrD,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAkDxB"}

package/types/src/sheet/_SheetMessages.d.ts

@@ -0,0 +1,11 @@
+export declare const ERROR_READONLY_SHEET: (description?: string) => string;
+export declare const ERROR_PROTECTED_FIELD: (description?: string) => string;
+export declare const ERROR_INVALID_SCOPED_RANGE_ADDRESS: (address: any, scope: string) => string;
+export declare const ERROR_UNSUPPORTED_FLOATING_TYPE: (type: string) => string;
+export declare const ERROR_ITEM_OVERLAPPING: (type: string) => string;
+export declare const ERROR_PASTE: (message: string) => string;
+export declare const ERROR_AUTOFILL_INVALID_DESTINATION: (template: string, destination: string) => string;
+export declare const ERROR_AUTOFILL_MULTIPLE: (modulus: number) => string;
+export declare const ERROR_MAX_VALUES: (max: number) => string;
+export declare const ERROR_UNIQUE_NAME: (name: string) => string;
+//# sourceMappingURL=_SheetMessages.d.ts.map

package/types/src/sheet/_SheetMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetMessages.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetMessages.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,oBAAoB,GAAI,cAAa,MAA8B,WACf,CAAC;AAElE,eAAO,MAAM,qBAAqB,GAAI,cAAa,MAA8B,WACf,CAAC;AAEnE,eAAO,MAAM,kCAAkC,GAAI,SAAS,GAAG,EAAE,OAAO,MAAM,WAEnB,CAAC;AAE5D,eAAO,MAAM,+BAA+B,GAAI,MAAM,MAAM,WACR,CAAC;AAErD,eAAO,MAAM,sBAAsB,GAAI,MAAM,MAAM,WACP,CAAC;AAC7C,eAAO,MAAM,WAAW,GAAI,SAAS,MAAM,WACN,CAAC;AACtC,eAAO,MAAM,kCAAkC,GAAI,UAAU,MAAM,EAAE,aAAa,MAAM,WAChB,CAAC;AACzE,eAAO,MAAM,uBAAuB,GAAI,SAAS,MAAM,WACP,CAAC;AACjD,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,WACP,CAAC;AAGtC,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,WACP,CAAC"}

package/types/src/sheet/_SheetMutations.d.ts

@@ -0,0 +1,137 @@
+import { IRange } from '@sheetxl/primitives';
+import { CoordUtils } from '@sheetxl/utils';
+import { ITransaction } from '../transaction';
+import { Tuple, ISpatialMap } from '../collections';
+import { ICellRange } from '../cellRange';
+import { ICell } from '../cell';
+import { IComment } from '../comment';
+import { IHyperlink } from '../hyperlink';
+import { IStyle } from '../style';
+import { IAutoFill } from '../autoFill';
+import { InternalTupleUpdate } from './_SheetStateTypes';
+import { SheetMutationContext } from './Sheet';
+/**
+ * The shared insert/delete engine (see SHEET-SPLIT-DESIGN §6e). Shifts every state map (values,
+ * spills, styles, merges, hyperlinks, comments, movables, tables, listeners, calc, …) one range at
+ * a time in the shift direction, adjusts headers and freeze panes, then commits. Insert shifts
+ * down/right (positive) and validates bounds; delete shifts up/left (negative) and needs none.
+ * @internal
+ */
+export declare function shiftCells(ctx: SheetMutationContext, ranges: readonly IRange.Coords[], options: IRange.Axis | ICellRange.InsertOptions | ICellRange.DeleteOptions | undefined, isInsert: boolean, coordValidator?: CoordUtils.CoordValidator): void;
+/**
+ * Replace the comments over each range with the given comment (or clear when `comments === null`).
+ * Writes a fresh `commentsSpatial` and commits with auto-select. See SHEET-SPLIT-DESIGN §5.4.
+ * @internal
+ */
+export declare function setComments(ctx: SheetMutationContext, ranges: readonly ISpatialMap.Entry<IComment.Properties>[], comments?: IComment.JSON | null, // we do this because updateTuples may update each
+options?: ITransaction.OperationOptions): void;
+/**
+ * Set (or clear when the resolved update is `null`) the hyperlink over each range, applying the
+ * built-in `Hyperlink` style and writing the display text into the cell. See SHEET-SPLIT-DESIGN §5.4.
+ *
+ * Hyperlink styling is a WHOLE-style update ("flatten the prior named style's non-font formatting into
+ * direct, drop font, set `named = Hyperlink`") — so it is routed through {@link updateStyles}'
+ * function-form path, the single site that owns the compose/rederive round-trip. `setHyperlinks` no
+ * longer composes/re-derives the per-feature maps itself.
+ * @internal
+ */
+export declare function setHyperlinks(ctx: SheetMutationContext, ranges: readonly ISpatialMap.Entry<IHyperlink.Update>[], defaultUpdate?: IHyperlink.Update, // we do this because updateTuples may update each
+options?: ITransaction.OperationOptions): void;
+/**
+ * The single style write choke point. Partitions each `IStyle.Update` by category (border / fill /
+ * content) and writes each per-feature map directly (DISCRETE — no merged blob); the function-form
+ * branch is the one surviving write-side compose. Re-derives the content-derived side maps
+ * (continuousFill + dateFormat) over the touched region. See SHEET-STYLE-SPLIT step 4/5.
+ * @internal
+ */
+export declare function updateStyles(ctx: SheetMutationContext, ranges: readonly ISpatialMap.Entry<IStyle.Update>[], defaultUpdate?: IStyle.Update, // we do this because updateTuples may update each
+options?: IStyle.UpdateOptions, calcedNumberFormat?: boolean): void;
+/**
+ * Merge each range into a single cell: relocates/keeps a lone value at the top-left (discarding the
+ * rest, or throwing on multiple values unless `discardMultipleValues`), unifies the style over the
+ * region while preserving the outer border edges, and indexes the merges. Toggling an already-merged
+ * range unmerges it. See SHEET-SPLIT-DESIGN §5.4 and the SHEET-STYLE-SPLIT step-5 note.
+ * @internal
+ */
+export declare function merge(ctx: SheetMutationContext, ranges: readonly IRange.Coords[], options?: IRange.AxisSelection | ICellRange.MergeOptions | null): void;
+/**
+ * Unmerge each range (must fully contain the merges it touches). Removes the merge index entries and
+ * commits; a no-op when nothing is merged. See SHEET-SPLIT-DESIGN §5.4.
+ * @internal
+ */
+export declare function unmerge(ctx: SheetMutationContext, ranges: readonly IRange.Coords[], options?: ITransaction.OperationOptions): void;
+/**
+ * The central cell-write path: iterates the incoming `ICell.Update` tuples, resolves each cell
+ * (parsing text, applying merges/spills), splits out style / hyperlink / formula side-updates, writes
+ * values + contentful + calc grids, and delegates the side-updates to {@link updateStyles} /
+ * {@link setHyperlinks} / {@link merge}. See SHEET-SPLIT-DESIGN §5.4.
+ * @internal
+ */
+export declare function updateTuples(ctx: SheetMutationContext, boundedTuples: Tuple.BoundedTuples<ICell.Update> | null, options?: ICellRange.UpdateCellsOptions, coordValidator?: CoordUtils.CoordValidator | null | undefined, internalOptions?: InternalTupleUpdate | null): void;
+/**
+ * Clear the given content category (values/formats/comments/hyperlinks, or all) over each range:
+ * delegates styles/hyperlinks/comments to their ops, deletes values + spills + calc, and drops tables
+ * / auto-tables inside the cleared area (unless `excludeSorts`). See SHEET-SPLIT-DESIGN §5.4.
+ * @internal
+ */
+export declare function clear(ctx: SheetMutationContext, ranges: readonly IRange.Coords[], applyTo?: ICell.Content | null, options?: ITransaction.OperationOptions, excludeSorts?: boolean, isCut?: boolean): void;
+/**
+ * Resolve a raw destination to the nearest destination {@link autoFill} accepts — what
+ * {@link ICellRange.AutoFillOptions.snap} runs before the fill.
+ * @internal
+ */
+export declare function autoFillRange(ctx: SheetMutationContext, template: IRange.Coords, destination: IRange.Coords): IRange.Coords;
+/**
+ * What an `autoFill` run with `preview` hands back instead of committing: the destination plus a
+ * cell-level projection of the fill that *would* happen. `SheetRange` wraps this in a read-only
+ * `ICellRange` — see {@link ICellRange.autoFill}.
+ * @internal
+ */
+export interface AutoFillProjection {
+    /** The destination the projection covers. */
+    coords: IRange.Coords;
+    /**
+     * The projected (uncommitted) cell at these coords. Cells the fill does not touch read straight from
+     * the sheet; filled cells are derived — value, style and, when the template tiles a merge across the
+     * fill, the merge itself (so `getRange`/`getSpans`/`getExtrusions` report the projected block, and a
+     * coord inside one resolves to that block's anchor, where the value lives).
+     */
+    getCellAt(rowIndex: number, colIndex: number): ICell;
+}
+/**
+ * The single-entry series memo behind `autoFill({ preview })` — the "last autofill".
+ *
+ * @remarks
+ * A drag previews the same template in the same direction over and over, changing only the destination;
+ * the series does not depend on the destination, so scanning it once serves the whole drag. Held on the
+ * sheet (one entry) and validated against `state` identity: the transaction store rebuilds the state
+ * object on every real change (reference-equal *is* its "nothing changed" signal), so any mutation,
+ * undo or redo drops the memo without anything having to invalidate it explicitly.
+ * @internal
+ */
+export interface AutoFillPreviewCache {
+    /** The sheet state the series was read from. */
+    state: unknown;
+    template: IRange.Coords;
+    isForward: boolean;
+    filler: IAutoFill.Filler;
+    /** The caller's `fillerOptions` **by reference** — a caller that rebuilds it simply misses the memo. */
+    fillerOptions: IAutoFill.Options | undefined;
+    /** Series per line of the opposite axis; `null` marks a line that produced nothing to fill. */
+    seriesByLine: Map<number, IAutoFill.FillAt | null>;
+}
+/**
+ * Fill the template's series/pattern into the destination (outward drag of the fill handle). Handles
+ * merges (tiles them, never splits), date series, previewing, table extension, and copies the
+ * per-feature style maps into the filled range. Delegates a negative (inward) fill to
+ * {@link autoFillShrink}. See SHEET-SPLIT-DESIGN §5.4.
+ * @internal
+ */
+export declare function autoFill(ctx: SheetMutationContext, template: IRange.Coords, destination: IRange.Coords, options?: ICellRange.AutoFillOptions): boolean | AutoFillProjection;
+/**
+ * An inward fill — Excel's drag of the fill handle back over the source range. The strip of the
+ * template beyond the destination edge is vacated: its cells are cleared, not filled.
+ * @internal
+ */
+export declare function autoFillShrink(ctx: SheetMutationContext, template: IRange.Coords, destination: IRange.Coords, direction: IRange.Direction, options?: ICellRange.AutoFillOptions): boolean;
+//# sourceMappingURL=_SheetMutations.d.ts.map

package/types/src/sheet/_SheetMutations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetMutations.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetMutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,MAAM,EAAU,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAA+B,UAAU,EAA8D,MAAM,gBAAgB,CAAC;AAIrI,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,KAAK,WAAW,EAAoC,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAoB,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAyB,MAAM,UAAU,CAAC;AAKzD,OAAO,EAAY,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAgCvD,OAAO,EAA+F,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC3J,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAiCpD;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,oBAAoB,EACzB,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAChC,OAAO,EAAE,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,GAAG,SAAS,EACtF,QAAQ,EAAE,OAAO,EACjB,cAAc,CAAC,EAAE,UAAU,CAAC,cAAc,GACzC,IAAI,CA+YN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,oBAAoB,EACzB,MAAM,EAAE,SAAS,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,EACzD,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,EAAE,kDAAkD;AACnF,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,IAAI,CA+DN;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,oBAAoB,EACzB,MAAM,EAAE,SAAS,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EACvD,aAAa,CAAC,EAAE,UAAU,CAAC,MAAM,EAAE,kDAAkD;AACrF,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,IAAI,CA4IN;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,oBAAoB,EACzB,MAAM,EAAE,SAAS,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EACnD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kDAAkD;AACjF,OAAO,CAAC,EAAE,MAAM,CAAC,aAAa,EAC9B,kBAAkB,GAAE,OAAe,GAClC,IAAI,CAqLN;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,OAAO,GAAE,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,YAAY,GAAG,IAAS,GAAG,IAAI,CAgU5J;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAiDlI;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,oBAAoB,EACzB,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,EACvD,OAAO,CAAC,EAAE,UAAU,CAAC,kBAAkB,EACvC,cAAc,GAAE,UAAU,CAAC,cAAc,GAAG,IAAI,GAAG,SAAmB,EACtE,eAAe,GAAE,mBAAmB,GAAG,IAAS,GAC/C,IAAI,CAikBN;AA6FD;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,GAAG,EAAE,oBAAoB,EACzB,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAChC,OAAO,GAAE,KAAK,CAAC,OAAO,GAAG,IAAS,EAClC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,EACvC,YAAY,GAAE,OAAa,EAC3B,KAAK,GAAE,OAAa,GACnB,IAAI,CAoON;AA6DD;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,oBAAoB,EACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EACvB,WAAW,EAAE,MAAM,CAAC,MAAM,GACzB,MAAM,CAAC,MAAM,CAiCf;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;CACtD;AAeD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;IACzB,wGAAwG;IACxG,aAAa,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC;IAC7C,+FAA+F;IAC/F,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACpD;AAgID;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,GAAG,EAAE,oBAAoB,EACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAC1B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GACnC,OAAO,GAAG,kBAAkB,CAsZ9B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,oBAAoB,EACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAC1B,SAAS,EAAE,MAAM,CAAC,SAAS,EAC3B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GACnC,OAAO,CAkET"}

package/types/src/sheet/_SheetSortUtils.d.ts

@@ -0,0 +1,9 @@
+import { IRange } from '@sheetxl/primitives';
+import { ITransaction } from '../transaction';
+import { ISort } from '../sort';
+import { Sheet } from './Sheet';
+/**
+ * Sheet specific sort utils.
+ */
+export declare function doSort(sheet: Sheet, coords: Readonly<IRange.Coords>, options?: boolean | ISort.Options[] | ISort.RangeOptions & ITransaction.OperationOptions): IRange.Coords;
+//# sourceMappingURL=_SheetSortUtils.d.ts.map

package/types/src/sheet/_SheetSortUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetSortUtils.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetSortUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAIzD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAerC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AAMH,wBAAgB,MAAM,CACpB,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,gBAAgB,GACvF,MAAM,CAAC,MAAM,CAsXf"}

package/types/src/sheet/_SheetStateReader.d.ts

@@ -0,0 +1,161 @@
+import { IRange, Scalar } from '@sheetxl/primitives';
+import { ISpatialQuery, ISpatialMap } from '../collections';
+import { IProperties } from '../type';
+import { ICell } from '../cell';
+import { IStyle } from '../style';
+import { ICellRange, ICellHeaderRange } from '../cellRange';
+import { ISheetHeader } from '../sheetHeader';
+import { IStringCollection } from '../string';
+import { RangeState, CellState, State } from './_SheetStateTypes';
+import { SheetCellOptions } from './SheetCell';
+/** @internal */
+export interface ViewEdgeEntry {
+    rowIndex: number;
+    colIndex: number;
+    continuous: IProperties.ICellRanged<IStyle.Properties> | null | undefined;
+    leftIndex: number;
+    rightIndex: number;
+    overflow: ICell.HorizontalOverflow | null;
+    intersection: RangeState.Intersection;
+    scalar: Scalar | null;
+    style: IStyle | null;
+}
+/** @internal */
+export interface OverFlowsAndStops {
+    overflows: ViewEdgeEntry[] | undefined;
+    stops: ViewEdgeEntry[] | undefined;
+}
+/**
+ * Everything the read engine needs from a {@link Sheet}, bundled so functions take one `ctx` arg
+ * instead of a long parameter list. `Sheet` provides it via `_getReadCtx()`. Callers can spread to
+ * override a portion for a scoped read — e.g. `{ ...ctx, cellOptions: temp }` for a temporary cell,
+ * or `{ ...ctx, state: clonedState }` to query a snapshot. See SHEET-SPLIT-DESIGN §5.2.
+ * @internal
+ */
+export interface SheetReadContext {
+    readonly state: Readonly<State>;
+    readonly rowHeaders: ISheetHeader;
+    readonly columnHeaders: ISheetHeader;
+    readonly cellOptions: SheetCellOptions;
+    readonly strings: IStringCollection;
+    getEntireCoords(): IRange.Coords;
+    getUsedCoords(options?: ICellRange.GetRangeOptions): IRange.Coords | null;
+    /**
+     * The RECONCILED error-VALUE spatial (`RangeState.Type.Error`) — current values are the truth,
+     * not `state.errorSpatial` (write-path only; stale for formula cells after a recalc). Calling
+     * this may lazily build the view (a value scan, cached per state version) — which is why
+     * `Type.Error` is opt-in only and never part of the all-types sweep.
+     */
+    getErrorSpatial(): ISpatialMap<boolean>;
+}
+/**
+ * The read engine for a {@link Sheet}'s versioned state.
+ *
+ * These are stateless free functions: they take the pieces of sheet state they need explicitly
+ * (spatial maps, headers) and never reach back into the `Sheet` instance. `Sheet` keeps thin
+ * delegators that forward its internal fields here (see `_getRangedEntries`). Extracting the logic
+ * this way keeps it testable in isolation and lets the state re-key / feature-map reworks touch a
+ * small, self-contained surface. See `private-assets/design/SHEET-SPLIT-DESIGN.md` §5.2.
+ * @internal
+ */
+/** Header iterator options that walk only the visible spans (used for the ignore-hidden paths). */
+export declare const OptionRangeIteratorVisibleOnly: ICellHeaderRange.IteratorOptions;
+export interface GetTypedRangeOptions<T = any, E = any> {
+    /**
+     * If 'true' will not return ranges that are hidden.
+     * If partially hidden the 'fullContained' is applied.
+     */
+    ignoreHidden?: boolean | IRange.Axis;
+    /**
+     * Only return ranges that are completely contained with the search range.
+     *
+     * @defaultValue false
+    */
+    fullyContained?: boolean;
+    sort?: {
+        axis?: IRange.Axis;
+        reverse?: boolean;
+    };
+    /**
+     * Whether the underlying spatial-index search returns its results pre-sorted.
+     *
+     * @remarks
+     * Distinct from {@link sort}: `sort` is a post-search comparator applied to the final results,
+     * whereas `spatialSort` is a hint passed into the spatial index's own `search`.
+     * @defaultValue false
+     */
+    spatialSort?: boolean;
+    /**
+     * Similar to onEntry but this will return the visible range.
+     *
+     * @remarks
+     * Useful when needing the same result multiple time but with search bounds.
+     * (i.e. contentful search)
+     */
+    onFound?: (entry: ISpatialMap.Entry<T>, visibleRange: IRange.Coords) => T | void;
+    /**
+     * Called before return to massage the results.
+     *
+     * @returns The result for this entry, `null` to drop it, or `undefined` to take the entry's own
+     * value unchanged. Dropping is `null` — a callback that maps entries to models cannot signal a
+     * skip with `undefined` without handing back the raw entry it was there to unwrap.
+     */
+    onEntry?: (value: E, entry: ISpatialMap.Entry<T>) => T | null | void;
+    noCache?: boolean;
+}
+/**
+ * Search a spatial map for entries intersecting the given ranges.
+ *
+ * @remarks
+ * Can exclude hidden rows/columns (per {@link GetTypedRangeOptions.ignoreHidden}) by walking the
+ * visible header spans. `rowHeaders`/`columnHeaders` are only consulted for the ignore-hidden paths.
+ * @internal
+ */
+export declare function getRangedEntries<T, E = T>(ctx: SheetReadContext, spatial: ISpatialQuery, ranges: readonly IRange.Coords[], options?: GetTypedRangeOptions<T, E>): T[];
+/**
+ * Whether the spatial map at `state[key]` has any entry intersecting `range`.
+ * @internal
+ */
+export declare function hasRangedEntries(ctx: SheetReadContext, key: keyof State, range: IRange.Coords): boolean;
+/**
+ * Reduce `coords` to only the visible portions (subtracting hidden rows/columns) per the requested
+ * axes. Consults the sheet headers for hidden spans.
+ * @internal
+ */
+export declare function getVisible(ctx: SheetReadContext, coords: readonly IRange.Coords[], options?: ICellRange.GetVisibleOptions): readonly IRange.Coords[];
+/**
+ * Collect all range-typed intersections (merges, styles, tables, hyperlinks, conditionals, …) that
+ * overlap `queryCoords`, appending them to `rangesByType`. `searchTypes` selects which types (or
+ * `true` for all); `injectReferences` supplies extra out-of-state references (e.g. export).
+ *
+ * @remarks
+ * `state` defaults to `ctx.state` but can be overridden for a scoped query against a snapshot.
+ * @internal
+ */
+export declare function collectRanges(ctx: SheetReadContext, queryCoords: IRange.Coords, rangesByType?: ISpatialMap.Entry<RangeState.Intersection>[], searchTypes?: boolean | RangeState.SearchTypes | null, injectReferences?: IRange.JSONReference<any>[][], state?: Readonly<State>, containedBounds?: IRange.Coords): void;
+/**
+ * Iterate the non-overlapping range-state intersections over the bounded region.
+ *
+ * @remarks
+ * Walks the (optionally visible-only) header spans, collects range types per span via
+ * {@link collectRanges}, then flattens overlaps into a non-overlapping sequence.
+ * @internal
+ */
+export declare function rangeStateIterator(ctx: SheetReadContext, options: RangeState.IteratorOptions): RangeState.Iterator;
+/**
+ * Find horizontal text overflow "edges" that reach into `bounds` from contentful cells outside it,
+ * and classify each as an overflow (spills into bounds) or a stop.
+ *
+ * @remarks
+ * Walks the visible range-state to the left/right of `bounds` (out to `maxDistance` if given),
+ * resolves each candidate cell's direct style, and computes its text overflow.
+ * @internal
+ */
+export declare function overflowAndStops(ctx: SheetReadContext, bounds: IRange.Coords, maxDistance?: number): OverFlowsAndStops | null;
+/**
+ * The core cell iterator: merges the cell-values grid with the range-state intersections (and, when
+ * `includeMergeOverflow`, the overflow edges) into a single ordered stream of {@link CellState.Entry}.
+ * @internal
+ */
+export declare function cellStateIterator(ctx: SheetReadContext, options?: CellState.IteratorOptions): CellState.Iterator;
+//# sourceMappingURL=_SheetStateReader.d.ts.map

package/types/src/sheet/_SheetStateReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_SheetStateReader.d.ts","sourceRoot":"","sources":["../../../../src/sheet/_SheetStateReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAc,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGtE,OAAO,EAAgC,KAAK,aAAa,EAAE,KAAK,WAAW,EAAc,MAAM,gBAAgB,CAAC;AAGhH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAKnD,OAAO,EAAE,UAAU,EAA2D,KAAK,SAAS,EAAE,KAAK,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAErI,OAAO,EAAE,KAAK,gBAAgB,EAA6B,MAAM,aAAa,CAAC;AAW/E,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAC1E,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAC1C,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACtC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;CACpC;AAOD;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC;IAClC,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC;IACrC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC;IACjC,aAAa,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IAC1E;;;;;OAKG;IACH,eAAe,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;CACzC;AAED;;;;;;;;;GASG;AAEH,mGAAmG;AACnG,eAAO,MAAM,8BAA8B,EAAE,gBAAgB,CAAC,eAG7D,CAAC;AAEF,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG;IAChD;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC;IACrC;;;;MAIE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAA;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC;IAEjF;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;IAErE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,GAAC,CAAC,EACrC,GAAG,EAAE,gBAAgB,EACrB,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAChC,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GACnC,CAAC,EAAE,CA2IL;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,gBAAgB,EACrB,GAAG,EAAE,MAAM,KAAK,EAChB,KAAK,EAAE,MAAM,CAAC,MAAM,GACnB,OAAO,CAUT;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,gBAAgB,EACrB,MAAM,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,EAChC,OAAO,CAAC,EAAE,UAAU,CAAC,iBAAiB,GACrC,SAAS,MAAM,CAAC,MAAM,EAAE,CA0D1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,gBAAgB,EACrB,WAAW,EAAE,MAAM,CAAC,MAAM,EAC1B,YAAY,GAAE,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,EAAO,EAC/D,WAAW,GAAE,OAAO,GAAG,UAAU,CAAC,WAAW,GAAG,IAAS,EACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,EAChD,KAAK,GAAE,QAAQ,CAAC,KAAK,CAAW,EAChC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,GAC9B,IAAI,CAwHN;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,gBAAgB,EACrB,OAAO,EAAE,UAAU,CAAC,eAAe,GAClC,UAAU,CAAC,QAAQ,CA+GrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,gBAAgB,EACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EACrB,WAAW,CAAC,EAAE,MAAM,GACnB,iBAAiB,GAAG,IAAI,CA4J1B;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,SAAS,CAAC,eAAe,GAClC,SAAS,CAAC,QAAQ,CA2RpB"}