@odoo/o-spreadsheet 16.4.0-alpha.0 → 16.4.0-alpha.1

package/dist/o-spreadsheet.d.ts

@@ -1132,7 +1132,6 @@ interface ModelConfig {
     readonly client: Client;
     readonly snapshotRequested: boolean;
     readonly notifyUI: (payload: NotifyUIEvent) => void;
-    readonly lazyEvaluation: boolean;
 }
 declare class Model extends EventBus<any> implements CommandDispatcher {
     private corePlugins;
@@ -1365,7 +1364,6 @@ interface UIPluginConfig {
     readonly moveClient: (position: ClientPosition) => void;
     readonly uiActions: UIActions;
     readonly custom: ModelConfig["custom"];
-    readonly lazyEvaluation: boolean;
     readonly session: Session;
 }
 interface UIPluginConstructor {
@@ -2502,34 +2500,44 @@ interface Border$1 {
     right?: BorderDescr;
 }
 declare type ReferenceDenormalizer = (range: Range, isMeta: boolean, functionName: string, paramNumber: number) => any | any[][];
-declare type EnsureRange = (range: Range) => any[][];
+declare type EnsureRange = (range: Range) => MatrixArg;
 declare type _CompiledFormula = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, ctx: {}) => FormulaReturn;
 interface CompiledFormula {
     execute: _CompiledFormula;
     tokens: Token[];
     dependencies: string[];
 }
+declare type Matrix<T = unknown> = T[][];
 declare type Arg = MatrixArg | PrimitiveArg;
-declare type MatrixArg = ({
-    value: CellValue;
-    format?: Format;
-} | undefined)[][];
+declare type MatrixArg = {
+    value: MatrixArgValue;
+    format?: MatrixArgFormat;
+};
 declare type PrimitiveArg = {
     value: PrimitiveArgValue;
-    format?: Format;
+    format?: PrimitiveFormat;
 };
 declare type ArgValue = PrimitiveArgValue | MatrixArgValue;
-declare type MatrixArgValue = (CellValue | undefined)[][];
-declare type PrimitiveArgValue = string | number | boolean | null;
-declare type FunctionReturn = {
-    value: FunctionReturnValue;
-    format?: Format;
+declare type MatrixArgValue = Matrix<CellValue | undefined>;
+declare type PrimitiveArgValue = CellValue | null;
+declare type MatrixArgFormat = Matrix<PrimitiveFormat>;
+declare type PrimitiveFormat = Format | undefined;
+declare type FunctionReturn = MatrixFunctionReturn | PrimitiveFunctionReturn;
+declare type FunctionReturnValue = CellValue | Matrix<CellValue>;
+declare type FunctionReturnFormat = PrimitiveFormat | MatrixArgFormat;
+declare type MatrixFunctionReturn = {
+    value: Matrix<CellValue>;
+    format?: FunctionReturnFormat;
+};
+declare type PrimitiveFunctionReturn = {
+    value: CellValue;
+    format?: PrimitiveFormat;
+};
+declare type FormulaReturn = MatrixFunctionReturn | PrimitiveFormulaReturn;
+declare type PrimitiveFormulaReturn = {
+    value: CellValue | null;
+    format?: PrimitiveFormat;
 };
-interface FormulaReturn extends Omit<FunctionReturn, "value"> {
-    value: FunctionReturnValue | null;
-    format?: Format;
-}
-declare type FunctionReturnValue = string | number | boolean;
 interface HeaderDimensions {
     start: Pixel;
     size: Pixel;
@@ -2825,7 +2833,7 @@ declare type ComputeFunction<T, R> = (this: EvalContext, ...args: ComputeFunctio
 interface AddFunctionDescription {
     description: string;
     compute: ComputeFunction<ArgValue, FunctionReturnValue>;
-    computeFormat?: ComputeFunction<Arg, Format | undefined>;
+    computeFormat?: ComputeFunction<Arg, FunctionReturnFormat>;
     category?: string;
     args: ArgDefinition[];
     returns: [ArgType];
@@ -3693,31 +3701,14 @@ declare class SheetPlugin extends CorePlugin<SheetState$1> implements SheetState
     private checkZonesAreInSheet;
 }
 
-/**
- * CustomColors plugin
- * This plugins aims to compute and keep to custom colors used in the
- * current spreadsheet
- */
-declare class CustomColorsPlugin extends UIPlugin {
-    private customColors;
-    private shouldUpdateColors;
-    static getters: readonly ["getCustomColors"];
-    handle(cmd: Command): void;
-    finalize(): void;
-    getCustomColors(): Color[];
-    private getColorsFromCells;
-    private getFormattingColors;
-    private getChartColors;
-    private tryToAddColor;
-}
-
 declare class EvaluationPlugin extends UIPlugin {
-    static getters: readonly ["evaluateFormula", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getColEvaluatedCells", "getEvaluatedCellsInZone"];
-    private isUpToDate;
-    private evaluatedCells;
-    private readonly evalContext;
-    private readonly lazyEvaluation;
+    static getters: readonly ["evaluateFormula", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone"];
+    private shouldRebuildDependenciesGraph;
+    private evaluator;
+    private compilationParams;
+    private positionsToUpdate;
     constructor(config: UIPluginConfig);
+    beforeHandle(cmd: Command): void;
     handle(cmd: Command): void;
     finalize(): void;
     evaluateFormula(formulaString: string, sheetId?: UID): any;
@@ -3733,25 +3724,34 @@ declare class EvaluationPlugin extends UIPlugin {
      * Return the format of each cell in the range.
      */
     getRangeFormats(range: Range): (Format | undefined)[];
-    getEvaluatedCell({ sheetId, col, row }: CellPosition): EvaluatedCell;
+    getEvaluatedCell(position: CellPosition): EvaluatedCell;
     getEvaluatedCells(sheetId: UID): Record<UID, EvaluatedCell>;
-    /**
-     * Returns all the evaluated cells of a col
-     */
-    getColEvaluatedCells(sheetId: UID, col: HeaderIndex): EvaluatedCell[];
     getEvaluatedCellsInZone(sheetId: UID, zone: Zone): EvaluatedCell[];
-    private setEvaluatedCell;
-    private getAllCells;
-    private evaluate;
+    exportForExcel(data: ExcelWorkbookData): void;
     /**
-     * Return all functions necessary to properly evaluate a formula:
-     * - a refFn function to read any reference, cell or range of a normalized formula
-     * - a range function to convert any reference to a proper value array
-     * - an evaluation context
+     * Returns the corresponding formula cell of a given cell
+     * It could be the formula present in the cell itself or the
+     * formula of the array formula that spreads to the cell
      */
-    private getCompilationParameters;
-    exportForExcel(data: ExcelWorkbookData): void;
-    private isBadExpression;
+    private getCorrespondingFormulaCell;
+}
+
+/**
+ * CustomColors plugin
+ * This plugins aims to compute and keep to custom colors used in the
+ * current spreadsheet
+ */
+declare class CustomColorsPlugin extends UIPlugin {
+    private customColors;
+    private shouldUpdateColors;
+    static getters: readonly ["getCustomColors"];
+    handle(cmd: Command): void;
+    finalize(): void;
+    getCustomColors(): Color[];
+    private getColorsFromCells;
+    private getFormattingColors;
+    private getChartColors;
+    private tryToAddColor;
 }
 
 declare class EvaluationChartPlugin extends UIPlugin {