@odoo/o-spreadsheet 17.0.2 → 17.0.4

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.
@@ -2497,7 +2499,8 @@ declare const enum CommandResult {
     InvalidDataValidationCriterionValue = "InvalidDataValidationCriterionValue",
     InvalidNumberOfCriterionValues = "InvalidNumberOfCriterionValues",
     BlockingValidationRule = "BlockingValidationRule",
-    InvalidCopyPasteSelection = "InvalidCopyPasteSelection"
+    InvalidCopyPasteSelection = "InvalidCopyPasteSelection",
+    NoChanges = "NoChanges"
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -2652,6 +2655,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 +2809,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 {
@@ -3227,7 +3232,8 @@ interface BordersPluginState {
 declare class BordersPlugin extends CorePlugin<BordersPluginState> implements BordersPluginState {
     static getters: readonly ["getCellBorder", "getBordersColors"];
     readonly borders: BordersPluginState["borders"];
-    handle(cmd: Command): void;
+    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.NoChanges;
+    handle(cmd: CoreCommand): void;
     /**
      * Move borders according to the inserted columns.
      * Ensure borders continuity.
@@ -3325,6 +3331,7 @@ declare class BordersPlugin extends CorePlugin<BordersPluginState> implements Bo
      * Compute the borders to add to the given zone merged.
      */
     private addBordersToMerge;
+    private checkBordersUnchanged;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3349,7 +3356,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
         };
     };
     adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID): void;
-    allowDispatch(cmd: CoreCommand): CommandResult;
+    allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     /**
      * Set a format to all the cells in a zone
@@ -3378,8 +3385,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
@@ -3423,6 +3430,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createFormulaCellWithDependencies;
     private createErrorFormula;
     private checkCellOutOfSheet;
+    private checkUselessClearCell;
 }
 
 /**
@@ -4053,15 +4061,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private moveCellOnRowsDeletion;
     private updateRowsStructureOnDeletion;
-    /**
-     * Update the rows of the sheet after an addition:
-     * - Rename the rows
-     *
-     * @param sheet Sheet on which the deletion occurs
-     * @param addedRow Index of the added row
-     * @param rowsToAdd Number of the rows to add
-     */
-    private updateRowsStructureOnAddition;
     /**
      * Add empty rows at the end of the rows
      *
@@ -4083,11 +4082,9 @@ 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", "getArrayFormulaSpreadingOn"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
-    private compilationParams;
     private positionsToUpdate;
     constructor(config: UIPluginConfig);
     beforeHandle(cmd: Command): void;
@@ -4109,6 +4106,8 @@ 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[];
+    getArrayFormulaSpreadingOn(position: CellPosition): CellPosition | undefined;
     exportForExcel(data: ExcelWorkbookData): void;
     /**
      * Returns the corresponding formula cell of a given cell
@@ -4116,7 +4115,6 @@ declare class EvaluationPlugin extends UIPlugin {
      * formula of the array formula that spreads to the cell
      */
     getCorrespondingFormulaCell(position: CellPosition): FormulaCell | undefined;
-    private getCompilationParameters;
 }
 
 interface CustomColorState {
@@ -4142,11 +4140,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;
@@ -7908,4 +7906,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 };