@pixerate/editor 0.22.0 → 0.24.0

package/dist/{controller-B7GIybc4.d.cts → controller-BhLLAoi8.d.cts}

@@ -13,6 +13,13 @@ interface SpreadsheetColumn {
     binding?: ColumnBinding;
     formula?: string;
     format?: CellFormat;
+    /**
+     * Number format code for the column's cells (e.g. `#,##0.00`,
+     * `"$"#,##0.00;[Red]("$"#,##0.00)`, `m/d/yyyy`). Cells without an explicit
+     * code of their own use it instead of the automatic one chosen for typed
+     * input. See `SpreadsheetController.setColumnNumberFormat`.
+     */
+    numberFormat?: string;
     readOnly?: boolean;
     hidden?: boolean;
 }
@@ -39,11 +46,30 @@ interface CellRange {
 }
 interface CellData {
     raw: string;
+    /**
+     * Evaluated value. Typed (non-formula) input is parsed: `"120"` → 120,
+     * `"TRUE"` → true, `"3/4/2026"` → `"2026-03-04"` (dates are ISO text),
+     * `"10:30"` → 0.4375 (a time alone is a fraction of a day); `'120` forces
+     * the text `"120"`. Formulas store their result.
+     */
     value: any;
     error?: string;
     /** Why the formula failed, e.g. `Argument 2 of SUMIF must be a range.` Set alongside `error`. */
     errorMessage?: string;
     format?: CellFormat;
+    /**
+     * Excel number format code used to display the value (see
+     * `formatCellDisplay`). Set explicitly (`explicitNumberFormat`), inherited
+     * from the column's `numberFormat`, or chosen automatically for typed input,
+     * e.g. `"$"#,##0.00` for `$1,200.50`, `0%` for `10%`, `#,##0` for `1,234`,
+     * `m/d/yyyy` for `3/4/2026`, `h:mm` for `10:30`. Absent for General.
+     */
+    numberFormat?: string;
+    /**
+     * True when `numberFormat` was set explicitly (`setCellNumberFormat`):
+     * typing into the cell keeps it instead of choosing an automatic format.
+     */
+    explicitNumberFormat?: boolean;
     readOnly?: boolean;
     /**
      * Set (only) on cells showing a value spilled from a dynamic array: the
@@ -225,14 +251,34 @@ declare class FormulaParser {
 }
 declare function parseFormula(formula: string): ASTNode;
 
-/**
- * Value helpers shared by the formula evaluator and the built-in functions:
- * error values, spreadsheet coercion rules, comparisons, ranges and dates.
- */
 /** Spreadsheet error values. They propagate through operators and functions. */
 declare const FORMULA_ERRORS: Set<string>;
 type FormulaErrorCode = '#DIV/0!' | '#VALUE!' | '#REF!' | '#NAME?' | '#N/A' | '#NUM!' | '#CYCLE!' | '#ERROR!' | '#SPILL!' | '#CALC!';
 declare function isFormulaError(value: unknown): value is string;
+/**
+ * Number to text as Excel converts it in `&` and General display: up to 15
+ * significant digits, scientific for very large or very small magnitudes.
+ */
+declare function numberToText(n: number): string;
+/**
+ * Compares numbers the way Excel does: both are rounded to 15 significant
+ * digits first, so binary noise such as `0.1+0.2` versus `0.3` counts as equal.
+ */
+declare function compareNumbers(a: number, b: number): number;
+/**
+ * Excel's comparison for the `=`, `<>`, `<`… operators: numbers < text <
+ * booleans < errors, numbers compared at 15 significant digits, text
+ * case-insensitively. A blank acts as 0, "" or FALSE depending on the other
+ * side. Dates are ISO text: two ISO dates compare chronologically
+ * ("2026-1-5" is before "2026-01-10"), and an ISO date against a number
+ * compares as its serial number.
+ */
+declare function compareValues(left: unknown, right: unknown): number;
+/**
+ * Sort order (ascending): numbers, text, booleans, errors, then blanks last.
+ * Errors are equal to each other, so sorting keeps their order.
+ */
+declare function sortCompareValues(left: unknown, right: unknown): number;
 declare function colNameToIndex(col: string): number;
 declare function indexToColName(index: number): string;
 /**
@@ -483,6 +529,8 @@ declare const SPREADSHEET_CLIPBOARD_MIME = "application/x.pixerate.spreadsheet+j
 interface SpreadsheetClipboardCell {
     raw: string;
     value: unknown;
+    /** Display text for `text/plain` and `text/html` (e.g. `10%` for 0.1); defaults to the value as text. Not stored in the JSON payload. */
+    text?: string;
 }
 interface SpreadsheetClipboardPayload {
     type: 'pixerate-spreadsheet';
@@ -622,6 +670,12 @@ interface SpreadsheetControllerOptions {
     onDocumentChange?: (doc: SpreadsheetDocument) => void;
     onSelectionChange?: (activeCell: CellCoordinate | null, range: CellRange | null) => void;
     onCellCommit?: (rowId: string, colId: string, raw: string, value: any) => void;
+    /**
+     * Approximate memory budget for undo/redo snapshots, in bytes (UTF-16 size of
+     * the serialized documents). The oldest undo steps beyond it are dropped, but
+     * the most recent one is always kept. Defaults to 64 MiB; 0 = unlimited.
+     */
+    maxHistoryBytes?: number;
 }
 declare class SpreadsheetController {
     document: SpreadsheetDocument;
@@ -639,6 +693,7 @@ declare class SpreadsheetController {
     private undoStack;
     private redoStack;
     private isApplyingHistory;
+    private readonly maxHistoryBytes;
     private batching;
     private pendingCommits;
     private evaluatingRowIndex;
@@ -649,6 +704,35 @@ declare class SpreadsheetController {
     private spillChanges;
     constructor(options?: SpreadsheetControllerOptions);
     loadDocument(document: SpreadsheetDocument): void;
+    /**
+     * Re-parses the value of every stored typed (non-formula) cell from its
+     * `raw` input, so documents saved before typed input was parsed (whose
+     * values are text such as `"120"`) compare and sort as numbers. Cells of
+     * bound columns in record rows keep their value: it belongs to the data
+     * source.
+     */
+    private rederiveTypedValues;
+    /**
+     * Value of typed (non-formula) input: a number, boolean, ISO date, error
+     * or text (see `parseCellInput`), its automatic number format, and the
+     * `CellFormat` to use: the automatic one (currency, percentage, date,
+     * number) when `format` is unset or `text` (the default of new columns).
+     */
+    private typedCell;
+    /**
+     * The number format a cell keeps whatever is typed into it: its explicit
+     * one, else its column's. Undefined lets typed input choose one.
+     */
+    private fixedNumberFormat;
+    /** `numberFormat` / `explicitNumberFormat` fields for a formula, bound or spilled cell. */
+    private fixedNumberFormatFields;
+    /**
+     * Typed input for a bound field, coerced by the field's declared type:
+     * number, boolean and date fields get a number, boolean or ISO date when
+     * the input parses as one; string and enum fields (and unknown fields)
+     * keep the text exactly as typed.
+     */
+    private boundInputValue;
     registerDataSource(ds: SpreadsheetDataSource): void;
     setPrimaryDataSource(dataSourceId: string | undefined): void;
     syncWithDataSource(): void;
@@ -822,6 +906,27 @@ declare class SpreadsheetController {
     /** Keeps the first `count` columns visible while scrolling. 0 unfreezes. */
     setFrozenColumnCount(count: number): void;
     private setTableCount;
+    /**
+     * Sets an explicit number format code (e.g. `0.00`, `"$"#,##0.00`,
+     * `m/d/yyyy`, `[Red]0;[Blue]-0`) on every cell in `range`, including blank
+     * cells, so values typed later keep it. `null` removes explicit formats: the
+     * cells go back to their column's format or the one chosen for typed input.
+     * Undoable as one step. Returns false when there is no range.
+     */
+    setCellNumberFormat(range: CellRange | null, code: string | null): boolean;
+    /**
+     * Sets the number format code of a column (`null` or `General` clears it).
+     * Its cells without an explicit format of their own use it, including
+     * values typed later; when cleared they go back to the format chosen for
+     * typed input. Undoable.
+     */
+    setColumnNumberFormat(colId: string, code: string | null): void;
+    /** The column's format, or the one typed input chose (typed cells only). */
+    private implicitNumberFormat;
+    /** A copy of `cell` with `numberFormat` set, or removed when undefined. */
+    private withNumberFormat;
+    /** Re-applies the stored cell's (or the column's) format to a spilled value shown there. */
+    private refreshSpilledNumberFormat;
     hideRows(indices: number[]): void;
     unhideRows(indices: number[]): void;
     hideColumns(indices: number[]): void;
@@ -878,9 +983,18 @@ declare class SpreadsheetController {
      */
     getViewModel(): SpreadsheetViewModel;
     private recordSnapshot;
+    /** Drops the oldest snapshots beyond `maxHistoryBytes`, always keeping the newest. */
+    private trimHistory;
+    /** Approximate bytes held by the undo/redo snapshots (UTF-16 size). */
+    getHistoryByteSize(): number;
+    /** Number of undo / redo snapshots currently held. */
+    getHistoryDepth(): {
+        undo: number;
+        redo: number;
+    };
     undo(): void;
     redo(): void;
     private notifyChange;
 }
 
-export { type SpreadsheetDataSource as $, type ASTNode as A, type BinaryOpNode as B, type CellCoordinate as C, DEFAULT_COLUMN_WIDTH as D, type EvaluationContext as E, FORMULA_ERRORS as F, type GroupAggregate as G, type NewFilterRule as H, type PropertyRefNode as I, type RowType as J, SPREADSHEET_CLIPBOARD_MIME as K, type LiteralNode as L, MAX_FORMULA_ARRAY_SIZE as M, type NameNode as N, type SortDirection as O, type ParsedSpreadsheetClipboard as P, type SortKey as Q, type RangeNode as R, SpreadsheetController as S, type SpillRefNode as T, type SpreadsheetCellSpan as U, type SpreadsheetClipboardCell as V, type SpreadsheetClipboardData as W, type SpreadsheetClipboardPayload as X, type SpreadsheetClipboardSource as Y, type SpreadsheetColumn as Z, type SpreadsheetControllerOptions as _, type CellData as a, type SpreadsheetDataSourceField as a0, type SpreadsheetDocument as a1, type SpreadsheetFilterState as a2, type SpreadsheetGrouping as a3, type SpreadsheetRow as a4, type SpreadsheetRowGroup as a5, type SpreadsheetRowSection as a6, type SpreadsheetSpill as a7, type SpreadsheetTableSettings as a8, type SpreadsheetViewColumn as a9, serializeHtmlTable as aA, shiftFormulaReferences as aB, tokenizeFormula as aC, type SpreadsheetViewModel as aa, type SpreadsheetViewRow as ab, type StructuralChange as ac, type UnaryOpNode as ad, WHOLE_COLUMN_END_ROW as ae, buildSpreadsheetView as af, colNameToIndex as ag, columnDependencyKey as ah, computeRowGroups as ai, createSpreadsheetClipboardData as aj, describeFormulaError as ak, extractCellDependencies as al, getRowSection as am, getTableSections as an, indexToColName as ao, isFormulaError as ap, mapFormulaReferences as aq, offsetFormulaReferences as ar, parseCellReference as as, parseFormula as at, parseHtmlTable as au, parseRange as av, readSpreadsheetClipboard as aw, rebaseClipboardRows as ax, remapFormulaReferences as ay, rowPassesFilters as az, type CellDep as b, type CellFormat as c, type CellPosition as d, type CellRange as e, type CellRefNode as f, type CellValueReader as g, type ColumnBinding as h, type ColumnType as i, type CsvExportOptions as j, type CsvImportOptions as k, DEFAULT_ROW_HEIGHT as l, DataSourceBinder as m, DependencyGraph as n, type FilterOperator as o, type FilterRule as p, type FormulaDiagnostic as q, type FormulaErrorCode as r, type FormulaEvaluationResult as s, FormulaEvaluator as t, FormulaParser as u, type FormulaRange as v, type FormulaToken as w, type FormulaTokenType as x, type FunctionCallNode as y, type GroupSummary as z };
+export { type SpreadsheetDataSource as $, type ASTNode as A, type BinaryOpNode as B, type CellCoordinate as C, DEFAULT_COLUMN_WIDTH as D, type EvaluationContext as E, FORMULA_ERRORS as F, type GroupAggregate as G, type NewFilterRule as H, type PropertyRefNode as I, type RowType as J, SPREADSHEET_CLIPBOARD_MIME as K, type LiteralNode as L, MAX_FORMULA_ARRAY_SIZE as M, type NameNode as N, type SortDirection as O, type ParsedSpreadsheetClipboard as P, type SortKey as Q, type RangeNode as R, SpreadsheetController as S, type SpillRefNode as T, type SpreadsheetCellSpan as U, type SpreadsheetClipboardCell as V, type SpreadsheetClipboardData as W, type SpreadsheetClipboardPayload as X, type SpreadsheetClipboardSource as Y, type SpreadsheetColumn as Z, type SpreadsheetControllerOptions as _, type CellData as a, type SpreadsheetDataSourceField as a0, type SpreadsheetDocument as a1, type SpreadsheetFilterState as a2, type SpreadsheetGrouping as a3, type SpreadsheetRow as a4, type SpreadsheetRowGroup as a5, type SpreadsheetRowSection as a6, type SpreadsheetSpill as a7, type SpreadsheetTableSettings as a8, type SpreadsheetViewColumn as a9, rebaseClipboardRows as aA, remapFormulaReferences as aB, rowPassesFilters as aC, serializeHtmlTable as aD, shiftFormulaReferences as aE, sortCompareValues as aF, tokenizeFormula as aG, type SpreadsheetViewModel as aa, type SpreadsheetViewRow as ab, type StructuralChange as ac, type UnaryOpNode as ad, WHOLE_COLUMN_END_ROW as ae, buildSpreadsheetView as af, colNameToIndex as ag, columnDependencyKey as ah, compareNumbers as ai, compareValues as aj, computeRowGroups as ak, createSpreadsheetClipboardData as al, describeFormulaError as am, extractCellDependencies as an, getRowSection as ao, getTableSections as ap, indexToColName as aq, isFormulaError as ar, mapFormulaReferences as as, numberToText as at, offsetFormulaReferences as au, parseCellReference as av, parseFormula as aw, parseHtmlTable as ax, parseRange as ay, readSpreadsheetClipboard as az, type CellDep as b, type CellFormat as c, type CellPosition as d, type CellRange as e, type CellRefNode as f, type CellValueReader as g, type ColumnBinding as h, type ColumnType as i, type CsvExportOptions as j, type CsvImportOptions as k, DEFAULT_ROW_HEIGHT as l, DataSourceBinder as m, DependencyGraph as n, type FilterOperator as o, type FilterRule as p, type FormulaDiagnostic as q, type FormulaErrorCode as r, type FormulaEvaluationResult as s, FormulaEvaluator as t, FormulaParser as u, type FormulaRange as v, type FormulaToken as w, type FormulaTokenType as x, type FunctionCallNode as y, type GroupSummary as z };

package/dist/{controller-B7GIybc4.d.ts → controller-BhLLAoi8.d.ts}

@@ -13,6 +13,13 @@ interface SpreadsheetColumn {
     binding?: ColumnBinding;
     formula?: string;
     format?: CellFormat;
+    /**
+     * Number format code for the column's cells (e.g. `#,##0.00`,
+     * `"$"#,##0.00;[Red]("$"#,##0.00)`, `m/d/yyyy`). Cells without an explicit
+     * code of their own use it instead of the automatic one chosen for typed
+     * input. See `SpreadsheetController.setColumnNumberFormat`.
+     */
+    numberFormat?: string;
     readOnly?: boolean;
     hidden?: boolean;
 }
@@ -39,11 +46,30 @@ interface CellRange {
 }
 interface CellData {
     raw: string;
+    /**
+     * Evaluated value. Typed (non-formula) input is parsed: `"120"` → 120,
+     * `"TRUE"` → true, `"3/4/2026"` → `"2026-03-04"` (dates are ISO text),
+     * `"10:30"` → 0.4375 (a time alone is a fraction of a day); `'120` forces
+     * the text `"120"`. Formulas store their result.
+     */
     value: any;
     error?: string;
     /** Why the formula failed, e.g. `Argument 2 of SUMIF must be a range.` Set alongside `error`. */
     errorMessage?: string;
     format?: CellFormat;
+    /**
+     * Excel number format code used to display the value (see
+     * `formatCellDisplay`). Set explicitly (`explicitNumberFormat`), inherited
+     * from the column's `numberFormat`, or chosen automatically for typed input,
+     * e.g. `"$"#,##0.00` for `$1,200.50`, `0%` for `10%`, `#,##0` for `1,234`,
+     * `m/d/yyyy` for `3/4/2026`, `h:mm` for `10:30`. Absent for General.
+     */
+    numberFormat?: string;
+    /**
+     * True when `numberFormat` was set explicitly (`setCellNumberFormat`):
+     * typing into the cell keeps it instead of choosing an automatic format.
+     */
+    explicitNumberFormat?: boolean;
     readOnly?: boolean;
     /**
      * Set (only) on cells showing a value spilled from a dynamic array: the
@@ -225,14 +251,34 @@ declare class FormulaParser {
 }
 declare function parseFormula(formula: string): ASTNode;
 
-/**
- * Value helpers shared by the formula evaluator and the built-in functions:
- * error values, spreadsheet coercion rules, comparisons, ranges and dates.
- */
 /** Spreadsheet error values. They propagate through operators and functions. */
 declare const FORMULA_ERRORS: Set<string>;
 type FormulaErrorCode = '#DIV/0!' | '#VALUE!' | '#REF!' | '#NAME?' | '#N/A' | '#NUM!' | '#CYCLE!' | '#ERROR!' | '#SPILL!' | '#CALC!';
 declare function isFormulaError(value: unknown): value is string;
+/**
+ * Number to text as Excel converts it in `&` and General display: up to 15
+ * significant digits, scientific for very large or very small magnitudes.
+ */
+declare function numberToText(n: number): string;
+/**
+ * Compares numbers the way Excel does: both are rounded to 15 significant
+ * digits first, so binary noise such as `0.1+0.2` versus `0.3` counts as equal.
+ */
+declare function compareNumbers(a: number, b: number): number;
+/**
+ * Excel's comparison for the `=`, `<>`, `<`… operators: numbers < text <
+ * booleans < errors, numbers compared at 15 significant digits, text
+ * case-insensitively. A blank acts as 0, "" or FALSE depending on the other
+ * side. Dates are ISO text: two ISO dates compare chronologically
+ * ("2026-1-5" is before "2026-01-10"), and an ISO date against a number
+ * compares as its serial number.
+ */
+declare function compareValues(left: unknown, right: unknown): number;
+/**
+ * Sort order (ascending): numbers, text, booleans, errors, then blanks last.
+ * Errors are equal to each other, so sorting keeps their order.
+ */
+declare function sortCompareValues(left: unknown, right: unknown): number;
 declare function colNameToIndex(col: string): number;
 declare function indexToColName(index: number): string;
 /**
@@ -483,6 +529,8 @@ declare const SPREADSHEET_CLIPBOARD_MIME = "application/x.pixerate.spreadsheet+j
 interface SpreadsheetClipboardCell {
     raw: string;
     value: unknown;
+    /** Display text for `text/plain` and `text/html` (e.g. `10%` for 0.1); defaults to the value as text. Not stored in the JSON payload. */
+    text?: string;
 }
 interface SpreadsheetClipboardPayload {
     type: 'pixerate-spreadsheet';
@@ -622,6 +670,12 @@ interface SpreadsheetControllerOptions {
     onDocumentChange?: (doc: SpreadsheetDocument) => void;
     onSelectionChange?: (activeCell: CellCoordinate | null, range: CellRange | null) => void;
     onCellCommit?: (rowId: string, colId: string, raw: string, value: any) => void;
+    /**
+     * Approximate memory budget for undo/redo snapshots, in bytes (UTF-16 size of
+     * the serialized documents). The oldest undo steps beyond it are dropped, but
+     * the most recent one is always kept. Defaults to 64 MiB; 0 = unlimited.
+     */
+    maxHistoryBytes?: number;
 }
 declare class SpreadsheetController {
     document: SpreadsheetDocument;
@@ -639,6 +693,7 @@ declare class SpreadsheetController {
     private undoStack;
     private redoStack;
     private isApplyingHistory;
+    private readonly maxHistoryBytes;
     private batching;
     private pendingCommits;
     private evaluatingRowIndex;
@@ -649,6 +704,35 @@ declare class SpreadsheetController {
     private spillChanges;
     constructor(options?: SpreadsheetControllerOptions);
     loadDocument(document: SpreadsheetDocument): void;
+    /**
+     * Re-parses the value of every stored typed (non-formula) cell from its
+     * `raw` input, so documents saved before typed input was parsed (whose
+     * values are text such as `"120"`) compare and sort as numbers. Cells of
+     * bound columns in record rows keep their value: it belongs to the data
+     * source.
+     */
+    private rederiveTypedValues;
+    /**
+     * Value of typed (non-formula) input: a number, boolean, ISO date, error
+     * or text (see `parseCellInput`), its automatic number format, and the
+     * `CellFormat` to use: the automatic one (currency, percentage, date,
+     * number) when `format` is unset or `text` (the default of new columns).
+     */
+    private typedCell;
+    /**
+     * The number format a cell keeps whatever is typed into it: its explicit
+     * one, else its column's. Undefined lets typed input choose one.
+     */
+    private fixedNumberFormat;
+    /** `numberFormat` / `explicitNumberFormat` fields for a formula, bound or spilled cell. */
+    private fixedNumberFormatFields;
+    /**
+     * Typed input for a bound field, coerced by the field's declared type:
+     * number, boolean and date fields get a number, boolean or ISO date when
+     * the input parses as one; string and enum fields (and unknown fields)
+     * keep the text exactly as typed.
+     */
+    private boundInputValue;
     registerDataSource(ds: SpreadsheetDataSource): void;
     setPrimaryDataSource(dataSourceId: string | undefined): void;
     syncWithDataSource(): void;
@@ -822,6 +906,27 @@ declare class SpreadsheetController {
     /** Keeps the first `count` columns visible while scrolling. 0 unfreezes. */
     setFrozenColumnCount(count: number): void;
     private setTableCount;
+    /**
+     * Sets an explicit number format code (e.g. `0.00`, `"$"#,##0.00`,
+     * `m/d/yyyy`, `[Red]0;[Blue]-0`) on every cell in `range`, including blank
+     * cells, so values typed later keep it. `null` removes explicit formats: the
+     * cells go back to their column's format or the one chosen for typed input.
+     * Undoable as one step. Returns false when there is no range.
+     */
+    setCellNumberFormat(range: CellRange | null, code: string | null): boolean;
+    /**
+     * Sets the number format code of a column (`null` or `General` clears it).
+     * Its cells without an explicit format of their own use it, including
+     * values typed later; when cleared they go back to the format chosen for
+     * typed input. Undoable.
+     */
+    setColumnNumberFormat(colId: string, code: string | null): void;
+    /** The column's format, or the one typed input chose (typed cells only). */
+    private implicitNumberFormat;
+    /** A copy of `cell` with `numberFormat` set, or removed when undefined. */
+    private withNumberFormat;
+    /** Re-applies the stored cell's (or the column's) format to a spilled value shown there. */
+    private refreshSpilledNumberFormat;
     hideRows(indices: number[]): void;
     unhideRows(indices: number[]): void;
     hideColumns(indices: number[]): void;
@@ -878,9 +983,18 @@ declare class SpreadsheetController {
      */
     getViewModel(): SpreadsheetViewModel;
     private recordSnapshot;
+    /** Drops the oldest snapshots beyond `maxHistoryBytes`, always keeping the newest. */
+    private trimHistory;
+    /** Approximate bytes held by the undo/redo snapshots (UTF-16 size). */
+    getHistoryByteSize(): number;
+    /** Number of undo / redo snapshots currently held. */
+    getHistoryDepth(): {
+        undo: number;
+        redo: number;
+    };
     undo(): void;
     redo(): void;
     private notifyChange;
 }
 
-export { type SpreadsheetDataSource as $, type ASTNode as A, type BinaryOpNode as B, type CellCoordinate as C, DEFAULT_COLUMN_WIDTH as D, type EvaluationContext as E, FORMULA_ERRORS as F, type GroupAggregate as G, type NewFilterRule as H, type PropertyRefNode as I, type RowType as J, SPREADSHEET_CLIPBOARD_MIME as K, type LiteralNode as L, MAX_FORMULA_ARRAY_SIZE as M, type NameNode as N, type SortDirection as O, type ParsedSpreadsheetClipboard as P, type SortKey as Q, type RangeNode as R, SpreadsheetController as S, type SpillRefNode as T, type SpreadsheetCellSpan as U, type SpreadsheetClipboardCell as V, type SpreadsheetClipboardData as W, type SpreadsheetClipboardPayload as X, type SpreadsheetClipboardSource as Y, type SpreadsheetColumn as Z, type SpreadsheetControllerOptions as _, type CellData as a, type SpreadsheetDataSourceField as a0, type SpreadsheetDocument as a1, type SpreadsheetFilterState as a2, type SpreadsheetGrouping as a3, type SpreadsheetRow as a4, type SpreadsheetRowGroup as a5, type SpreadsheetRowSection as a6, type SpreadsheetSpill as a7, type SpreadsheetTableSettings as a8, type SpreadsheetViewColumn as a9, serializeHtmlTable as aA, shiftFormulaReferences as aB, tokenizeFormula as aC, type SpreadsheetViewModel as aa, type SpreadsheetViewRow as ab, type StructuralChange as ac, type UnaryOpNode as ad, WHOLE_COLUMN_END_ROW as ae, buildSpreadsheetView as af, colNameToIndex as ag, columnDependencyKey as ah, computeRowGroups as ai, createSpreadsheetClipboardData as aj, describeFormulaError as ak, extractCellDependencies as al, getRowSection as am, getTableSections as an, indexToColName as ao, isFormulaError as ap, mapFormulaReferences as aq, offsetFormulaReferences as ar, parseCellReference as as, parseFormula as at, parseHtmlTable as au, parseRange as av, readSpreadsheetClipboard as aw, rebaseClipboardRows as ax, remapFormulaReferences as ay, rowPassesFilters as az, type CellDep as b, type CellFormat as c, type CellPosition as d, type CellRange as e, type CellRefNode as f, type CellValueReader as g, type ColumnBinding as h, type ColumnType as i, type CsvExportOptions as j, type CsvImportOptions as k, DEFAULT_ROW_HEIGHT as l, DataSourceBinder as m, DependencyGraph as n, type FilterOperator as o, type FilterRule as p, type FormulaDiagnostic as q, type FormulaErrorCode as r, type FormulaEvaluationResult as s, FormulaEvaluator as t, FormulaParser as u, type FormulaRange as v, type FormulaToken as w, type FormulaTokenType as x, type FunctionCallNode as y, type GroupSummary as z };
+export { type SpreadsheetDataSource as $, type ASTNode as A, type BinaryOpNode as B, type CellCoordinate as C, DEFAULT_COLUMN_WIDTH as D, type EvaluationContext as E, FORMULA_ERRORS as F, type GroupAggregate as G, type NewFilterRule as H, type PropertyRefNode as I, type RowType as J, SPREADSHEET_CLIPBOARD_MIME as K, type LiteralNode as L, MAX_FORMULA_ARRAY_SIZE as M, type NameNode as N, type SortDirection as O, type ParsedSpreadsheetClipboard as P, type SortKey as Q, type RangeNode as R, SpreadsheetController as S, type SpillRefNode as T, type SpreadsheetCellSpan as U, type SpreadsheetClipboardCell as V, type SpreadsheetClipboardData as W, type SpreadsheetClipboardPayload as X, type SpreadsheetClipboardSource as Y, type SpreadsheetColumn as Z, type SpreadsheetControllerOptions as _, type CellData as a, type SpreadsheetDataSourceField as a0, type SpreadsheetDocument as a1, type SpreadsheetFilterState as a2, type SpreadsheetGrouping as a3, type SpreadsheetRow as a4, type SpreadsheetRowGroup as a5, type SpreadsheetRowSection as a6, type SpreadsheetSpill as a7, type SpreadsheetTableSettings as a8, type SpreadsheetViewColumn as a9, rebaseClipboardRows as aA, remapFormulaReferences as aB, rowPassesFilters as aC, serializeHtmlTable as aD, shiftFormulaReferences as aE, sortCompareValues as aF, tokenizeFormula as aG, type SpreadsheetViewModel as aa, type SpreadsheetViewRow as ab, type StructuralChange as ac, type UnaryOpNode as ad, WHOLE_COLUMN_END_ROW as ae, buildSpreadsheetView as af, colNameToIndex as ag, columnDependencyKey as ah, compareNumbers as ai, compareValues as aj, computeRowGroups as ak, createSpreadsheetClipboardData as al, describeFormulaError as am, extractCellDependencies as an, getRowSection as ao, getTableSections as ap, indexToColName as aq, isFormulaError as ar, mapFormulaReferences as as, numberToText as at, offsetFormulaReferences as au, parseCellReference as av, parseFormula as aw, parseHtmlTable as ax, parseRange as ay, readSpreadsheetClipboard as az, type CellDep as b, type CellFormat as c, type CellPosition as d, type CellRange as e, type CellRefNode as f, type CellValueReader as g, type ColumnBinding as h, type ColumnType as i, type CsvExportOptions as j, type CsvImportOptions as k, DEFAULT_ROW_HEIGHT as l, DataSourceBinder as m, DependencyGraph as n, type FilterOperator as o, type FilterRule as p, type FormulaDiagnostic as q, type FormulaErrorCode as r, type FormulaEvaluationResult as s, FormulaEvaluator as t, FormulaParser as u, type FormulaRange as v, type FormulaToken as w, type FormulaTokenType as x, type FunctionCallNode as y, type GroupSummary as z };

package/dist/documents-BQjzJNe2.d.ts

@@ -0,0 +1,76 @@
+import { Node, Schema } from '@tiptap/pm/model';
+import { R as ReviewAuthor } from './comment-store-BEMgVlAA.js';
+
+/** A document to compare: a ProseMirror node, its JSON, or HTML (needs a DOM). */
+type CompareSource = Node | Record<string, any> | string;
+interface CompareDocumentsOptions {
+    /** Schema of the documents. Required unless both sources are ProseMirror nodes. */
+    schema?: Schema;
+    /** Author recorded on every change. Default `{ id: "compare", name: "Compare" }`. */
+    author?: ReviewAuthor;
+    /** Time recorded on every change (`createdAt`). Default now. */
+    date?: number | Date | string;
+    /** Compare changed paragraphs word by word (default) or character by character. */
+    granularity?: "word" | "char";
+    /** Treat text differing only in case as equal (the revised text is kept). */
+    ignoreCase?: boolean;
+    /** Treat runs of white space as equal (the revised text is kept). */
+    ignoreWhitespace?: boolean;
+    /** Record formatting differences of equal text as `formatChange` marks. Default `true`. */
+    formatting?: boolean;
+    /** Change id generator. */
+    generateId?: () => string;
+    /** Marks not compared as formatting (in addition to review marks, comments and bookmarks). */
+    ignoredMarks?: string[];
+    /** Node attributes ignored when comparing blocks. Default `["id"]`. */
+    ignoredBlockAttributes?: string[];
+    /**
+     * Paragraphs longer than this (in characters) are compared by words even
+     * at `granularity: "char"`. Default 2000.
+     */
+    maxCharDiff?: number;
+}
+interface CompareSummary {
+    /** Inserted text runs and inserted block runs. */
+    insertions: number;
+    /** Deleted text runs and deleted block runs. */
+    deletions: number;
+    /** Formatting changes of equal text. */
+    formatChanges: number;
+    /** Block type, attribute and wrapping changes. */
+    blockChanges: number;
+    /** Differences the result could not represent as tracked changes. */
+    notHonoured: string[];
+}
+interface CompareDocumentsResult {
+    /**
+     * The revised document with the differences as tracked changes: accepting
+     * all changes yields the revised document, rejecting all the original.
+     */
+    doc: Node;
+    summary: CompareSummary;
+}
+/**
+ * Compares two documents and returns the revised document with the
+ * differences as tracked changes (`insertion`/`deletion`/`formatChange`
+ * marks and `blockChange` records), plus a summary.
+ *
+ * Blocks are matched by their text (Myers diff with patience anchors); in a
+ * run of changed blocks the i-th deleted block is paired with the i-th
+ * inserted one and compared word by word (or by character), while unpaired
+ * blocks are recorded as whole-block insertions/deletions. Equal text is
+ * compared for formatting, and type/attribute/wrapping changes become
+ * `blockChange` records. Without ignore options, accepting all changes
+ * yields the revised document and rejecting all yields the original.
+ *
+ * The schema needs the `TrackChanges` extension (marks and the
+ * `blockChange` attribute). Existing tracked changes in either document are
+ * accepted first.
+ */
+declare function compareDocuments(original: CompareSource, revised: CompareSource, options?: CompareDocumentsOptions): CompareDocumentsResult;
+/** `compareDocuments` for two HTML strings (needs a DOM, like `setContent`). */
+declare function compareHtml(originalHtml: string, revisedHtml: string, options: CompareDocumentsOptions & {
+    schema: Schema;
+}): CompareDocumentsResult;
+
+export { type CompareDocumentsOptions as C, type CompareDocumentsResult as a, type CompareSource as b, type CompareSummary as c, compareDocuments as d, compareHtml as e };

package/dist/documents-KRTPhvst.d.cts

@@ -0,0 +1,76 @@
+import { Node, Schema } from '@tiptap/pm/model';
+import { R as ReviewAuthor } from './comment-store-BEMgVlAA.cjs';
+
+/** A document to compare: a ProseMirror node, its JSON, or HTML (needs a DOM). */
+type CompareSource = Node | Record<string, any> | string;
+interface CompareDocumentsOptions {
+    /** Schema of the documents. Required unless both sources are ProseMirror nodes. */
+    schema?: Schema;
+    /** Author recorded on every change. Default `{ id: "compare", name: "Compare" }`. */
+    author?: ReviewAuthor;
+    /** Time recorded on every change (`createdAt`). Default now. */
+    date?: number | Date | string;
+    /** Compare changed paragraphs word by word (default) or character by character. */
+    granularity?: "word" | "char";
+    /** Treat text differing only in case as equal (the revised text is kept). */
+    ignoreCase?: boolean;
+    /** Treat runs of white space as equal (the revised text is kept). */
+    ignoreWhitespace?: boolean;
+    /** Record formatting differences of equal text as `formatChange` marks. Default `true`. */
+    formatting?: boolean;
+    /** Change id generator. */
+    generateId?: () => string;
+    /** Marks not compared as formatting (in addition to review marks, comments and bookmarks). */
+    ignoredMarks?: string[];
+    /** Node attributes ignored when comparing blocks. Default `["id"]`. */
+    ignoredBlockAttributes?: string[];
+    /**
+     * Paragraphs longer than this (in characters) are compared by words even
+     * at `granularity: "char"`. Default 2000.
+     */
+    maxCharDiff?: number;
+}
+interface CompareSummary {
+    /** Inserted text runs and inserted block runs. */
+    insertions: number;
+    /** Deleted text runs and deleted block runs. */
+    deletions: number;
+    /** Formatting changes of equal text. */
+    formatChanges: number;
+    /** Block type, attribute and wrapping changes. */
+    blockChanges: number;
+    /** Differences the result could not represent as tracked changes. */
+    notHonoured: string[];
+}
+interface CompareDocumentsResult {
+    /**
+     * The revised document with the differences as tracked changes: accepting
+     * all changes yields the revised document, rejecting all the original.
+     */
+    doc: Node;
+    summary: CompareSummary;
+}
+/**
+ * Compares two documents and returns the revised document with the
+ * differences as tracked changes (`insertion`/`deletion`/`formatChange`
+ * marks and `blockChange` records), plus a summary.
+ *
+ * Blocks are matched by their text (Myers diff with patience anchors); in a
+ * run of changed blocks the i-th deleted block is paired with the i-th
+ * inserted one and compared word by word (or by character), while unpaired
+ * blocks are recorded as whole-block insertions/deletions. Equal text is
+ * compared for formatting, and type/attribute/wrapping changes become
+ * `blockChange` records. Without ignore options, accepting all changes
+ * yields the revised document and rejecting all yields the original.
+ *
+ * The schema needs the `TrackChanges` extension (marks and the
+ * `blockChange` attribute). Existing tracked changes in either document are
+ * accepted first.
+ */
+declare function compareDocuments(original: CompareSource, revised: CompareSource, options?: CompareDocumentsOptions): CompareDocumentsResult;
+/** `compareDocuments` for two HTML strings (needs a DOM, like `setContent`). */
+declare function compareHtml(originalHtml: string, revisedHtml: string, options: CompareDocumentsOptions & {
+    schema: Schema;
+}): CompareDocumentsResult;
+
+export { type CompareDocumentsOptions as C, type CompareDocumentsResult as a, type CompareSource as b, type CompareSummary as c, compareDocuments as d, compareHtml as e };