@odoo/o-spreadsheet 17.4.3 → 17.4.4

package/dist/o-spreadsheet.cjs.js

@@ -2,9 +2,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.4.3
- * @date 2024-08-02T08:23:56.573Z
- * @hash 40ecd1e
+ * @version 17.4.4
+ * @date 2024-08-09T12:24:07.798Z
+ * @hash a43e855
  */
 
 'use strict';
@@ -10578,6 +10578,18 @@ function getDefinedAxis(definition) {
     useLeftAxis ||= !useRightAxis;
     return { useLeftAxis, useRightAxis };
 }
+function formatTickValue(localeFormat) {
+    return (value) => {
+        value = Number(value);
+        if (isNaN(value))
+            return value;
+        const { locale, format } = localeFormat;
+        return formatValue(value, {
+            locale,
+            format: !format && Math.abs(value) >= 1000 ? "#,##" : format,
+        });
+    };
+}
 
 /** This is a chartJS plugin that will draw the values of each data next to the point/bar/pie slice */
 const chartShowValuesPlugin = {
@@ -19126,6 +19138,7 @@ const PIVOT_VALUE = {
         const pivot = this.getters.getPivot(pivotId);
         const coreDefinition = this.getters.getPivotCoreDefinition(pivotId);
         addPivotDependencies(this, coreDefinition);
+        pivot.init({ reload: pivot.needsReevaluation });
         const error = pivot.assertIsValid({ throwOnError: false });
         if (error) {
             return error;
@@ -19154,6 +19167,7 @@ const PIVOT_HEADER = {
         const pivot = this.getters.getPivot(_pivotId);
         const coreDefinition = this.getters.getPivotCoreDefinition(_pivotId);
         addPivotDependencies(this, coreDefinition);
+        pivot.init({ reload: pivot.needsReevaluation });
         const error = pivot.assertIsValid({ throwOnError: false });
         if (error) {
             return error;
@@ -20371,14 +20385,6 @@ for (let category of categories) {
 }
 const notAvailableError = new NotAvailableError(_t("Array arguments to [[FUNCTION_NAME]] are of different size."));
 function createComputeFunction(descr, functionName) {
-    function runtimeCompute(...args) {
-        try {
-            return vectorizedCompute.apply(this, args);
-        }
-        catch (e) {
-            return handleError(e, functionName);
-        }
-    }
     function vectorizedCompute(...args) {
         let countVectorizableCol = 1;
         let countVectorizableRow = 1;
@@ -20419,13 +20425,13 @@ function createComputeFunction(descr, functionName) {
                 }
             }
             if (!isMatrix(arg) && argDefinition.acceptMatrixOnly) {
-                throw new BadExpressionError(_t("Function [[FUNCTION_NAME]] expects the parameter '%s' to be reference to a cell or range.", (i + 1).toString()));
+                throw new BadExpressionError(_t("Function %s expects the parameter '%s' to be reference to a cell or range.", functionName, (i + 1).toString()));
             }
         }
         //#endregion
         if (countVectorizableCol === 1 && countVectorizableRow === 1) {
             // either this function is not vectorized or it ends up with a 1x1 dimension
-            return computeFunctionToObject.apply(this, args);
+            return errorHandlingCompute.apply(this, args);
         }
         const getArgOffset = (i, j) => args.map((arg, index) => {
             switch (vectorArgsType?.[index]) {
@@ -20443,7 +20449,7 @@ function createComputeFunction(descr, functionName) {
             if (col > vectorizableColLimit - 1 || row > vectorizableRowLimit - 1) {
                 return notAvailableError;
             }
-            const singleCellComputeResult = computeFunctionToObject.apply(this, getArgOffset(col, row));
+            const singleCellComputeResult = errorHandlingCompute.apply(this, getArgOffset(col, row));
             // In the case where the user tries to vectorize arguments of an array formula, we will get an
             // array for every combination of the vectorized arguments, which will lead to a 3D matrix and
             // we won't be able to return the values.
@@ -20458,6 +20464,14 @@ function createComputeFunction(descr, functionName) {
                 : singleCellComputeResult;
         });
     }
+    function errorHandlingCompute(...args) {
+        try {
+            return computeFunctionToObject.apply(this, args);
+        }
+        catch (e) {
+            return handleError(e, functionName);
+        }
+    }
     function computeFunctionToObject(...args) {
         const result = descr.compute.apply(this, args);
         if (!isMatrix(result)) {
@@ -20473,7 +20487,7 @@ function createComputeFunction(descr, functionName) {
         }
         return matrixMap(result, (row) => ({ value: row }));
     }
-    return runtimeCompute;
+    return vectorizedCompute;
 }
 function handleError(e, functionName) {
     // the error could be an user error (instance of EvaluationError)
@@ -23694,23 +23708,13 @@ function getBarConfiguration(chart, labels, localeFormat) {
         padding: { left: 20, right: 20, top: chart.title ? 10 : 25, bottom: 10 },
     };
     config.options.indexAxis = chart.horizontal ? "y" : "x";
-    const formatCallback = (value) => {
-        value = Number(value);
-        if (isNaN(value))
-            return value;
-        const { locale, format } = localeFormat;
-        return formatValue(value, {
-            locale,
-            format: !format && Math.abs(value) >= 1000 ? "#,##" : format,
-        });
-    };
     config.options.scales = {};
     const labelsAxis = { ticks: { padding: 5, color: fontColor } };
     const valuesAxis = {
         beginAtZero: true, // the origin of the y axis is always zero
         ticks: {
             color: fontColor,
-            callback: formatCallback,
+            callback: formatTickValue(localeFormat),
         },
     };
     const xAxis = chart.horizontal ? valuesAxis : labelsAxis;
@@ -23747,7 +23751,7 @@ function getBarConfiguration(chart, labels, localeFormat) {
         showValues: chart.showValues,
         background: chart.background,
         horizontal: chart.horizontal,
-        callback: formatCallback,
+        callback: formatTickValue(localeFormat),
     };
     return config;
 }
@@ -24026,21 +24030,11 @@ function getLineOrScatterConfiguration(chart, labels, options) {
             title: getChartAxisTitleRuntime(chart.axesDesign?.x),
         },
     };
-    const formatCallback = (value) => {
-        value = Number(value);
-        if (isNaN(value))
-            return value;
-        const { locale, format } = options;
-        return formatValue(value, {
-            locale,
-            format: !format && Math.abs(value) >= 1000 ? "#,##" : format,
-        });
-    };
     const yAxis = {
         beginAtZero: true, // the origin of the y axis is always zero
         ticks: {
             color: fontColor,
-            callback: formatCallback,
+            callback: formatTickValue(options),
         },
     };
     const { useLeftAxis, useRightAxis } = getDefinedAxis(chart.getDefinition());
@@ -24071,7 +24065,7 @@ function getLineOrScatterConfiguration(chart, labels, options) {
     config.options.plugins.chartShowValuesPlugin = {
         showValues: chart.showValues,
         background: chart.background,
-        callback: formatCallback,
+        callback: formatTickValue(options),
     };
     return config;
 }
@@ -24346,30 +24340,18 @@ function createComboChartRuntime(chart, getters) {
             title: getChartAxisTitleRuntime(chart.axesDesign?.x),
         },
     };
-    const formatCallback = (format) => {
-        return (value) => {
-            value = Number(value);
-            if (isNaN(value))
-                return value;
-            const { locale } = localeFormat;
-            return formatValue(value, {
-                locale,
-                format: !format && Math.abs(value) >= 1000 ? "#,##" : format,
-            });
-        };
-    };
     const leftVerticalAxis = {
         beginAtZero: true, // the origin of the y axis is always zero
         ticks: {
             color: fontColor,
-            callback: formatCallback(mainDataSetFormat),
+            callback: formatTickValue({ format: mainDataSetFormat, locale }),
         },
     };
     const rightVerticalAxis = {
         beginAtZero: true, // the origin of the y axis is always zero
         ticks: {
             color: fontColor,
-            callback: formatCallback(lineDataSetsFormat),
+            callback: formatTickValue({ format: lineDataSetsFormat, locale }),
         },
     };
     const definition = chart.getDefinition();
@@ -24394,7 +24376,7 @@ function createComboChartRuntime(chart, getters) {
     config.options.plugins.chartShowValuesPlugin = {
         showValues: chart.showValues,
         background: chart.background,
-        callback: formatCallback(mainDataSetFormat),
+        callback: formatTickValue({ format: mainDataSetFormat, locale }),
     };
     const colors = new ColorGenerator();
     for (let [index, { label, data }] of dataSetsValues.entries()) {
@@ -24926,7 +24908,10 @@ function getPieConfiguration(chart, labels, localeFormat) {
         const yLabelStr = formatValue(yLabel, { format: toolTipFormat, locale });
         return xLabel ? `${xLabel}: ${yLabelStr} (${percentage}%)` : `${yLabelStr} (${percentage}%)`;
     };
-    config.options.plugins.chartShowValuesPlugin = { showValues: chart.showValues };
+    config.options.plugins.chartShowValuesPlugin = {
+        showValues: chart.showValues,
+        callback: formatTickValue(localeFormat),
+    };
     return config;
 }
 function getPieColors(colors, dataSetsValues) {
@@ -25510,6 +25495,7 @@ function getWaterfallConfiguration(chart, labels, dataSeriesLabels, localeFormat
     config.options.plugins.chartShowValuesPlugin = {
         showValues: chart.showValues,
         background: chart.background,
+        callback: formatTickValue(localeFormat),
     };
     return config;
 }
@@ -50414,7 +50400,7 @@ class RangeAdapter {
      * @param sheetXC the string description of a range, in the form SheetName!XC:XC
      */
     getRangeFromSheetXC(defaultSheetId, sheetXC) {
-        if (!rangeReference.test(sheetXC)) {
+        if (!rangeReference.test(sheetXC) || !this.getters.tryGetSheet(defaultSheetId)) {
             return new RangeImpl({
                 sheetId: "",
                 zone: { left: -1, top: -1, right: -1, bottom: -1 },
@@ -54067,18 +54053,23 @@ class Evaluator {
         this.evaluate(this.getAllCells());
         console.info("evaluate all cells", performance.now() - start, "ms");
     }
-    evaluateFormula(sheetId, formulaString) {
-        const compiledFormula = compile(formulaString);
-        const ranges = compiledFormula.dependencies.map((xc) => this.getters.getRangeFromSheetXC(sheetId, xc));
-        this.updateCompilationParameters();
-        const result = updateEvalContextAndExecute({ ...compiledFormula, dependencies: ranges }, this.compilationParams, sheetId);
-        if (isMatrix(result)) {
-            return matrixMap(result, (cell) => cell.value);
+    evaluateFormulaResult(sheetId, formulaString) {
+        try {
+            const compiledFormula = compile(formulaString);
+            const ranges = compiledFormula.dependencies.map((xc) => this.getters.getRangeFromSheetXC(sheetId, xc));
+            this.updateCompilationParameters();
+            const result = updateEvalContextAndExecute({ ...compiledFormula, dependencies: ranges }, this.compilationParams, sheetId);
+            if (isMatrix(result)) {
+                return result;
+            }
+            if (result.value === null) {
+                return { value: 0, format: result.format };
+            }
+            return result;
         }
-        if (result.value === null) {
-            return 0;
+        catch (error) {
+            return handleError(error, "");
         }
-        return result.value;
     }
     getAllCells() {
         const positions = this.createEmptyPositionSet();
@@ -54441,6 +54432,7 @@ function updateEvalContextAndExecute(compiledFormula, compilationParams, sheetId
 class EvaluationPlugin extends UIPlugin {
     static getters = [
         "evaluateFormula",
+        "evaluateFormulaResult",
         "getCorrespondingFormulaCell",
         "getRangeFormattedValues",
         "getRangeValues",
@@ -54500,12 +54492,14 @@ class EvaluationPlugin extends UIPlugin {
     // Getters
     // ---------------------------------------------------------------------------
     evaluateFormula(sheetId, formulaString) {
-        try {
-            return this.evaluator.evaluateFormula(sheetId, formulaString);
-        }
-        catch (error) {
-            return error.value || CellErrorType.GenericError;
+        const result = this.evaluateFormulaResult(sheetId, formulaString);
+        if (isMatrix(result)) {
+            return matrixMap(result, (cell) => cell.value);
         }
+        return result.value;
+    }
+    evaluateFormulaResult(sheetId, formulaString) {
+        return this.evaluator.evaluateFormulaResult(sheetId, formulaString);
     }
     /**
      * Return the value of each cell in the range as they are displayed in the grid.
@@ -55888,28 +55882,33 @@ class PivotUIPlugin extends UIPlugin {
             const pivotRow = position.row - mainPosition.row;
             return pivotCells[pivotCol][pivotRow];
         }
-        if (functionName === "PIVOT.HEADER" && args.at(-2) === "measure") {
-            const domain = pivot.parseArgsToPivotDomain(args.slice(1, -2).map((value) => ({ value })));
+        try {
+            if (functionName === "PIVOT.HEADER" && args.at(-2) === "measure") {
+                const domain = pivot.parseArgsToPivotDomain(args.slice(1, -2).map((value) => ({ value })));
+                return {
+                    type: "MEASURE_HEADER",
+                    domain,
+                    measure: args.at(-1)?.toString() || "",
+                };
+            }
+            else if (functionName === "PIVOT.HEADER") {
+                const domain = pivot.parseArgsToPivotDomain(args.slice(1).map((value) => ({ value })));
+                return {
+                    type: "HEADER",
+                    domain,
+                };
+            }
+            const [measure, ...domainArgs] = args.slice(1);
+            const domain = pivot.parseArgsToPivotDomain(domainArgs.map((value) => ({ value })));
             return {
-                type: "MEASURE_HEADER",
+                type: "VALUE",
                 domain,
-                measure: args.at(-1)?.toString() || "",
+                measure: measure?.toString() || "",
             };
         }
-        else if (functionName === "PIVOT.HEADER") {
-            const domain = pivot.parseArgsToPivotDomain(args.slice(1).map((value) => ({ value })));
-            return {
-                type: "HEADER",
-                domain,
-            };
+        catch (_) {
+            return EMPTY_PIVOT_CELL;
         }
-        const [measure, ...domainArgs] = args.slice(1);
-        const domain = pivot.parseArgsToPivotDomain(domainArgs.map((value) => ({ value })));
-        return {
-            type: "VALUE",
-            domain,
-            measure: measure?.toString() || "",
-        };
     }
     getPivot(pivotId) {
         return this.pivots[pivotId];
@@ -57777,6 +57776,7 @@ class FormatPlugin extends UIPlugin {
      * evaluated and updated with the number type.
      */
     setDecimal(sheetId, zones, step) {
+        const positionsByFormat = {};
         // Find the each cell with a number value and get the format
         for (const zone of recomputeZones(zones)) {
             for (const position of positions(zone)) {
@@ -57786,15 +57786,20 @@ class FormatPlugin extends UIPlugin {
                     // of the format
                     this.getters.getLocale();
                     const newFormat = changeDecimalPlaces(numberFormat, step);
-                    // Apply the new format on the whole zone
-                    this.dispatch("SET_FORMATTING", {
-                        sheetId,
-                        target: [positionToZone(position)],
-                        format: newFormat,
-                    });
+                    positionsByFormat[newFormat] = positionsByFormat[newFormat] || [];
+                    positionsByFormat[newFormat].push(position);
                 }
             }
         }
+        // consolidate all positions with the same format in bigger zones
+        for (const newFormat in positionsByFormat) {
+            const zones = recomputeZones(positionsByFormat[newFormat].map((position) => positionToZone(position)));
+            this.dispatch("SET_FORMATTING", {
+                sheetId,
+                format: newFormat,
+                target: zones,
+            });
+        }
     }
     /**
      * Take a range of cells and return the format of the first cell containing a
@@ -68424,6 +68429,6 @@ exports.tokenColors = tokenColors;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.4.3";
-__info__.date = "2024-08-02T08:23:56.573Z";
-__info__.hash = "40ecd1e";
+__info__.version = "17.4.4";
+__info__.date = "2024-08-09T12:24:07.798Z";
+__info__.hash = "a43e855";

package/dist/o-spreadsheet.d.ts

@@ -3976,7 +3976,7 @@ declare class UIPlugin<State = any> extends BasePlugin<State, Command> {
 }
 
 declare class EvaluationPlugin extends UIPlugin {
-    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getEvaluatedCellsPositions", "getSpreadZone", "getArrayFormulaSpreadingOn", "isEmpty"];
+    static getters: readonly ["evaluateFormula", "evaluateFormulaResult", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getEvaluatedCellsPositions", "getSpreadZone", "getArrayFormulaSpreadingOn", "isEmpty"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
     private positionsToUpdate;
@@ -3985,6 +3985,7 @@ declare class EvaluationPlugin extends UIPlugin {
     handle(cmd: CoreViewCommand): void;
     finalize(): void;
     evaluateFormula(sheetId: UID, formulaString: string): CellValue | Matrix<CellValue>;
+    evaluateFormulaResult(sheetId: UID, formulaString: string): Matrix<FunctionResultObject> | FunctionResultObject;
     /**
      * Return the value of each cell in the range as they are displayed in the grid.
      */