@odoo/o-spreadsheet 17.1.0-alpha.2 → 17.1.0-alpha.3

package/dist/o-spreadsheet.d.ts

@@ -17,6 +17,7 @@ declare const functionCache: {
     [key: string]: Omit<CompiledFormula, "dependencies" | "tokens">;
 };
 declare function compile(formula: string): CompiledFormula;
+declare function compileTokens(tokens: Token[]): CompiledFormula;
 
 interface FunctionContext {
     parent: string;
@@ -93,6 +94,7 @@ type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTNumber | ASTBoolea
  * Parse an expression (as a string) into an AST.
  */
 declare function parse(str: string): AST;
+declare function parseTokens(tokens: Token[]): AST;
 /**
  * Allows to visit all nodes of an AST and apply a mapping function
  * to nodes of a specific type.
@@ -2652,6 +2654,9 @@ interface CompiledFormula {
     tokens: Token[];
     dependencies: string[];
 }
+interface RangeCompiledFormula extends Omit<CompiledFormula, "dependencies"> {
+    dependencies: Range[];
+}
 type Matrix<T = unknown> = T[][];
 type ValueAndFormat = {
     value: CellValue;
@@ -2803,8 +2808,7 @@ interface LiteralCell extends CellAttributes {
 }
 interface FormulaCell extends CellAttributes {
     readonly isFormula: true;
-    readonly compiledFormula: CompiledFormula;
-    readonly dependencies: Range[];
+    readonly compiledFormula: RangeCompiledFormula;
 }
 type Cell = LiteralCell | FormulaCell;
 interface EvaluatedCellProperties {
@@ -3378,8 +3382,8 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
      * starting an async evaluation even if it has been moved or re-allocated
      */
     getCellById(cellId: UID): Cell | undefined;
-    getFormulaCellContent(sheetId: UID, cell: Pick<FormulaCell, "dependencies" | "compiledFormula">, dependencies?: Range[]): string;
-    getTranslatedCellFormula(sheetId: UID, offsetX: number, offsetY: number, compiledFormula: CompiledFormula, dependencies: Range[]): string;
+    getFormulaCellContent(sheetId: UID, compiledFormula: RangeCompiledFormula, dependencies?: Range[]): string;
+    getTranslatedCellFormula(sheetId: UID, offsetX: number, offsetY: number, compiledFormula: RangeCompiledFormula): string;
     getCellStyle(position: CellPosition): Style;
     /**
      * Converts a zone to a XC coordinate system
@@ -4084,7 +4088,7 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
 
 declare class EvaluationPlugin extends UIPlugin {
     private config;
-    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone"];
+    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
     private compilationParams;
@@ -4109,6 +4113,7 @@ declare class EvaluationPlugin extends UIPlugin {
     getEvaluatedCell(position: CellPosition): EvaluatedCell;
     getEvaluatedCells(sheetId: UID): Record<UID, EvaluatedCell>;
     getEvaluatedCellsInZone(sheetId: UID, zone: Zone): EvaluatedCell[];
+    getSpreadPositionsOf(position: CellPosition): CellPosition[];
     exportForExcel(data: ExcelWorkbookData): void;
     /**
      * Returns the corresponding formula cell of a given cell
@@ -4142,11 +4147,11 @@ declare class CustomColorsPlugin extends UIPlugin<CustomColorState> {
 }
 
 interface EvaluationChartState {
-    readonly charts: Immutable<Record<UID, ChartRuntime | undefined>>;
+    charts: Record<UID, ChartRuntime | undefined>;
 }
 declare class EvaluationChartPlugin extends UIPlugin<EvaluationChartState> {
     static getters: readonly ["getChartRuntime", "getBackgroundOfSingleCellChart"];
-    readonly charts: Immutable<Record<UID, ChartRuntime | undefined>>;
+    charts: Record<UID, ChartRuntime | undefined>;
     private createRuntimeChart;
     handle(cmd: CoreViewCommand): void;
     getChartRuntime(figureId: UID): ChartRuntime;
@@ -4659,56 +4664,10 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
 }
 
 declare class SortPlugin extends UIPlugin {
-    static getters: readonly ["getContiguousZone"];
     allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
     handle(cmd: Command): void;
     private checkMerge;
     private checkMergeSizes;
-    /**
-     * safe-version of expandZone to make sure we don't get out of the grid
-     */
-    private expand;
-    /**
-     * verifies the presence of at least one non-empty cell in the given zone
-     */
-    private checkExpandedValues;
-    /**
-     * This function will expand the provided zone in directions (top, bottom, left, right) for which there
-     * are non-null cells on the external boundary of the zone in the given direction.
-     *
-     * Example:
-     *          A     B     C     D     E
-     *         ___   ___   ___   ___   ___
-     *    1  |     |  D  |     |     |     |
-     *         ___   ___   ___   ___   ___
-     *    2  |  5  |     |  1  |  D  |     |
-     *         ___   ___   ___   ___   ___
-     *    3  |     |     |  A  |  X  |     |
-     *         ___   ___   ___   ___   ___
-     *    4  |     |     |     |     |     |
-     *         ___   ___   ___   ___   ___
-     *
-     *  Let's consider a provided zone corresponding to (C2:D3) - (left:2, right: 3, top:1, bottom:2)
-     *  - the top external boundary is (B1:E1)
-     *    Since we have B1='D' != "", we expand to the top: => (C1:D3)
-     *    The top boundary having reached the top of the grid, we cannot expand in that direction anymore
-     *
-     *  - the left boundary is (B1:B4)
-     *    since we have B1 again, we expand to the left  => (B1:D3)
-     *
-     *  - the right and bottom boundaries are a dead end for now as (E1:E4) and (A4:E4) are empty.
-     *
-     *  - the left boundary is now (A1:A4)
-     *    Since we have A2=5 != "", we can therefore expand to the left => (A1:D3)
-     *
-     *  This will be the final zone as left and top have reached the boundaries of the grid and
-     *  the other boundaries (E1:E4) and (A4:E4) are empty.
-     *
-     * @param sheetId UID of concerned sheet
-     * @param zone Zone
-     *
-     */
-    getContiguousZone(sheetId: UID, zone: Zone): Zone;
     /**
      * This function evaluates if the top row of a provided zone can be considered as a `header`
      * by checking the following criteria:
@@ -4760,7 +4719,7 @@ declare class UIOptionsPlugin extends UIPlugin {
 }
 
 declare class SheetUIPlugin extends UIPlugin {
-    static getters: readonly ["doesCellHaveGridIcon", "getCellWidth", "getTextWidth", "getCellText", "getCellMultiLineText"];
+    static getters: readonly ["doesCellHaveGridIcon", "getCellWidth", "getTextWidth", "getCellText", "getCellMultiLineText", "getContiguousZone", "isCellEmpty"];
     private ctx;
     allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
     handle(cmd: Command): void;
@@ -4773,6 +4732,15 @@ declare class SheetUIPlugin extends UIPlugin {
      */
     getCellMultiLineText(position: CellPosition, width: number | undefined): string[];
     doesCellHaveGridIcon(position: CellPosition): boolean;
+    /**
+     * Expands the given zone until bordered by empty cells or reached the sheet boundaries.
+     */
+    getContiguousZone(sheetId: UID, zoneToExpand: Zone): Zone;
+    /**
+     * Check if a cell is empty. If the cell is part of a merge,
+     * check if the merge containing the cell is empty.
+     */
+    isCellEmpty(position: CellPosition): boolean;
     private getColMaxWidth;
     /**
      * Check that any "sheetId" in the command matches an existing
@@ -7909,4 +7877,4 @@ declare const constants: {
     DEFAULT_LOCALE: Locale;
 };
 
-export { AbstractChart, CancelledReason, Client, ClientJoinedMessage, ClientLeftMessage, ClientMovedMessage, CollaborationMessage, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, RemoteRevisionMessage, Revision, RevisionRedoneMessage, RevisionUndoneMessage, SPREADSHEET_DIMENSIONS, Spreadsheet, TransportService, UIPlugin, __info__, addFunction, astToFormula, compile, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
+export { AbstractChart, CancelledReason, Client, ClientJoinedMessage, ClientLeftMessage, ClientMovedMessage, CollaborationMessage, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, RemoteRevisionMessage, Revision, RevisionRedoneMessage, RevisionUndoneMessage, SPREADSHEET_DIMENSIONS, Spreadsheet, TransportService, UIPlugin, __info__, addFunction, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };