@odoo/o-spreadsheet 17.1.25 → 17.1.27

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.1.25
- * @date 2024-07-24T10:26:01.576Z
- * @hash 0edff47
+ * @version 17.1.27
+ * @date 2024-08-09T12:20:52.051Z
+ * @hash c626332
  */
 
 'use strict';
@@ -481,7 +481,7 @@ function debounce(func, wait, immediate) {
     let timeout;
     return function () {
         const context = this;
-        const args = arguments;
+        const args = Array.from(arguments);
         function later() {
             timeout = null;
             if (!immediate) {
@@ -684,7 +684,7 @@ function isNumberBetween(value, min, max) {
  */
 function largeMax(array) {
     let len = array.length;
-    if (len < 100000)
+    if (len < 100_000)
         return Math.max(...array);
     let max = -Infinity;
     while (len--) {
@@ -698,7 +698,7 @@ function largeMax(array) {
  */
 function largeMin(array) {
     let len = array.length;
-    if (len < 100000)
+    if (len < 100_000)
         return Math.min(...array);
     let min = +Infinity;
     while (len--) {
@@ -2615,13 +2615,16 @@ function operandToRegExp(operand) {
     }
     return new RegExp("^" + exp + "$", "i");
 }
-function evaluatePredicate(value = "", criterion) {
+function evaluatePredicate(value = "", criterion, locale) {
     const { operator, operand } = criterion;
     if (operand === undefined || value === null || operand === null) {
         return false;
     }
     if (typeof operand === "number" && operator === "=") {
-        return value.toString() === operand.toString();
+        if (typeof value === "string" && (isNumber(value, locale) || isDateTime(value, locale))) {
+            return toNumber(value, locale) === operand;
+        }
+        return value === operand;
     }
     if (operator === "<>" || operator === "=") {
         let result;
@@ -2699,7 +2702,7 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
             for (let k = 0; k < countArg - 1; k += 2) {
                 const criteriaValue = toMatrix(args[k])[i][j].value;
                 const criterion = predicates[k / 2];
-                validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion);
+                validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion, locale);
                 if (!validatedPredicates) {
                     break;
                 }
@@ -5981,7 +5984,7 @@ function textCell(value, localeFormat) {
 function numberCell(value, localeFormat) {
     return {
         type: CellValueType.number,
-        value: value || 0,
+        value: value || 0, // necessary to avoid "-0" and NaN values,
         format: localeFormat.format,
         isAutoSummable: true,
         defaultAlign: "right",
@@ -8472,8 +8475,8 @@ function truncateLabel(label) {
 function getDefaultChartJsRuntime(chart, labels, fontColor, { format, locale, truncateLabels = true }) {
     const options = {
         // https://www.chartjs.org/docs/latest/general/responsive.html
-        responsive: true,
-        maintainAspectRatio: false,
+        responsive: true, // will resize when its container is resized
+        maintainAspectRatio: false, // doesn't maintain the aspect ration (width/height =2 by default) so the user has the choice of the exact layout
         layout: {
             padding: { left: 20, right: 20, top: chart.title ? 10 : 25, bottom: 10 },
         },
@@ -8519,7 +8522,7 @@ function getDefaultChartJsRuntime(chart, labels, fontColor, { format, locale, tr
             labels: truncateLabels ? labels.map(truncateLabel) : labels,
             datasets: [],
         },
-        platform: undefined,
+        platform: undefined, // This key is optional and will be set by chart.js
         plugins: [],
     };
 }
@@ -8783,7 +8786,7 @@ function getBarConfiguration(chart, labels, localeFormat) {
         },
         y: {
             position: chart.verticalAxisPosition,
-            beginAtZero: true,
+            beginAtZero: true, // the origin of the y axis is always zero
             ticks: {
                 color: fontColor,
                 callback: (value) => {
@@ -9437,7 +9440,7 @@ function getLineConfiguration(chart, labels, options) {
         },
         y: {
             position: chart.verticalAxisPosition,
-            beginAtZero: true,
+            beginAtZero: true, // the origin of the y axis is always zero
             ticks: {
                 color: fontColor,
                 callback: (value) => {
@@ -9525,7 +9528,7 @@ function createLineChartRuntime(chart, getters) {
         const dataset = {
             label,
             data,
-            tension: 0,
+            tension: 0, // 0 -> render straight lines, which is much faster
             borderColor: color,
             backgroundColor,
             pointBackgroundColor: color,
@@ -9636,7 +9639,7 @@ class PieChart extends AbstractChart {
             ...this.getDefinition(),
             backgroundColor: toXlsxHexColor(this.background || BACKGROUND_CHART_COLOR),
             fontColor: toXlsxHexColor(chartFontColor(this.background)),
-            verticalAxisPosition: "left",
+            verticalAxisPosition: "left", //TODO ExcelChartDefinition should be adapted, but can be done later
             dataSets,
             labelRange,
         };
@@ -27203,7 +27206,9 @@ class Composer extends owl.Component {
         argToFocus: 0,
     });
     compositionActive = false;
+    spreadsheetRect = useSpreadsheetRect();
     get assistantStyle() {
+        const composerRect = this.composerRef.el.getBoundingClientRect();
         const assistantStyle = {};
         assistantStyle["min-width"] = `${this.props.rect?.width || ASSISTANT_WIDTH}px`;
         if (this.autoCompleteState.type === "function") {
@@ -27226,6 +27231,10 @@ class Composer extends owl.Component {
                 assistantStyle.right = `0px`;
             }
         }
+        if (this.props.focus === "contentFocus" &&
+            composerRect.left + ASSISTANT_WIDTH > this.spreadsheetRect.width) {
+            assistantStyle.right = "0px";
+        }
         return cssPropertiesToCss(assistantStyle);
     }
     // we can't allow input events to be triggered while we remove and add back the content of the composer in processContent
@@ -30059,7 +30068,7 @@ class VerticalScrollBar extends owl.Component {
     onScroll(offset) {
         const { scrollX } = this.env.model.getters.getActiveSheetDOMScrollInfo();
         this.env.model.dispatch("SET_VIEWPORT_OFFSET", {
-            offsetX: scrollX,
+            offsetX: scrollX, // offsetX is the same
             offsetY: offset,
         });
     }
@@ -30272,8 +30281,8 @@ class Grid extends owl.Component {
         "Ctrl+Shift+L": () => this.setHorizontalAlign("left"),
         "Ctrl+Shift+R": () => this.setHorizontalAlign("right"),
         "Ctrl+Shift+V": () => PASTE_AS_VALUE_ACTION(this.env),
-        "Ctrl+Shift+<": () => this.clearFormatting(),
-        "Ctrl+<": () => this.clearFormatting(),
+        "Ctrl+Shift+<": () => this.clearFormatting(), // for qwerty
+        "Ctrl+<": () => this.clearFormatting(), // for azerty
         "Ctrl+Shift+ ": () => {
             this.env.model.selection.selectAll();
         },
@@ -31071,10 +31080,10 @@ function convertCFCellIsOperator(xlsxCfOperator) {
 const CF_TYPE_CONVERSION_MAP = {
     aboveAverage: undefined,
     expression: undefined,
-    cellIs: undefined,
-    colorScale: undefined,
+    cellIs: undefined, // exist but isn't an operator in o_spreadsheet
+    colorScale: undefined, // exist but isn't an operator in o_spreadsheet
     dataBar: undefined,
-    iconSet: undefined,
+    iconSet: undefined, // exist but isn't an operator in o_spreadsheet
     top10: undefined,
     uniqueValues: undefined,
     duplicateValues: undefined,
@@ -31309,7 +31318,7 @@ const XLSX_INDEXED_COLORS = {
     61: "993366",
     62: "333399",
     63: "333333",
-    64: "000000",
+    64: "000000", // system foreground
     65: "FFFFFF", // system background
 };
 const IMAGE_MIMETYPE_TO_EXTENSION_MAPPING = {
@@ -34979,12 +34988,13 @@ class BordersPlugin extends CorePlugin {
                 this.clearBorders(cmd.sheetId, cmd.target);
                 break;
             case "REMOVE_COLUMNS_ROWS":
-                for (let el of [...cmd.elements].sort((a, b) => b - a)) {
+                const elements = [...cmd.elements].sort((a, b) => b - a);
+                for (const group of groupConsecutive(elements)) {
                     if (cmd.dimension === "COL") {
-                        this.shiftBordersHorizontally(cmd.sheetId, el + 1, -1);
+                        this.shiftBordersHorizontally(cmd.sheetId, group[group.length - 1] + 1, -group.length);
                     }
                     else {
-                        this.shiftBordersVertically(cmd.sheetId, el + 1, -1);
+                        this.shiftBordersVertically(cmd.sheetId, group[group.length - 1] + 1, -group.length);
                     }
                 }
                 break;
@@ -39116,7 +39126,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 },
@@ -40016,12 +40026,7 @@ class SheetPlugin extends CorePlugin {
                         });
                     }
                     if (colIndex > deletedColumn) {
-                        this.dispatch("UPDATE_CELL_POSITION", {
-                            sheetId: sheet.id,
-                            cellId: cellId,
-                            col: colIndex - 1,
-                            row: rowIndex,
-                        });
+                        this.setNewPosition(cellId, sheet.id, colIndex - 1, rowIndex);
                     }
                 }
             }
@@ -40031,7 +40036,7 @@ class SheetPlugin extends CorePlugin {
      * Move the cells after a column or rows insertion
      */
     moveCellsOnAddition(sheet, addedElement, quantity, dimension) {
-        const commands = [];
+        const updates = [];
         for (let rowIndex = 0; rowIndex < sheet.rows.length; rowIndex++) {
             const row = sheet.rows[rowIndex];
             if (dimension !== "rows" || rowIndex >= addedElement) {
@@ -40040,20 +40045,20 @@ class SheetPlugin extends CorePlugin {
                     const cellId = row.cells[i];
                     if (cellId) {
                         if (dimension === "rows" || colIndex >= addedElement) {
-                            commands.push({
-                                type: "UPDATE_CELL_POSITION",
+                            updates.push({
                                 sheetId: sheet.id,
                                 cellId: cellId,
                                 col: colIndex + (dimension === "columns" ? quantity : 0),
                                 row: rowIndex + (dimension === "rows" ? quantity : 0),
+                                type: "UPDATE_CELL_POSITION",
                             });
                         }
                     }
                 }
             }
         }
-        for (let cmd of commands.reverse()) {
-            this.dispatch(cmd.type, cmd);
+        for (let update of updates.reverse()) {
+            this.updateCellPosition(update);
         }
     }
     /**
@@ -40086,12 +40091,7 @@ class SheetPlugin extends CorePlugin {
                     const colIndex = Number(i);
                     const cellId = row.cells[i];
                     if (cellId) {
-                        this.dispatch("UPDATE_CELL_POSITION", {
-                            sheetId: sheet.id,
-                            cellId: cellId,
-                            col: colIndex,
-                            row: rowIndex - numberRows,
-                        });
+                        this.setNewPosition(cellId, sheet.id, colIndex, rowIndex - numberRows);
                     }
                 }
             }
@@ -42060,18 +42060,30 @@ class Evaluator {
         this.evaluate(this.getAllCells());
     }
     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);
+        const result = this.evaluateFormulaResult(sheetId, formulaString);
         if (isMatrix(result)) {
             return matrixMap(result, (cell) => cell.value);
         }
-        if (result.value === null) {
-            return 0;
-        }
         return result.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;
+        }
+        catch (error) {
+            return handleError(error, "");
+        }
+    }
     getAllCells() {
         const positionIds = new JetSet();
         for (const sheetId of this.getters.getSheetIds()) {
@@ -42496,6 +42508,7 @@ function updateEvalContextAndExecute(compiledFormula, compilationParams, sheetId
 class EvaluationPlugin extends UIPlugin {
     static getters = [
         "evaluateFormula",
+        "evaluateFormulaResult",
         "getCorrespondingFormulaCell",
         "getRangeFormattedValues",
         "getRangeValues",
@@ -42554,12 +42567,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.
@@ -42700,17 +42715,17 @@ function isBadExpression(tokens) {
  */
 function sortWithClusters(colorsToSort) {
     const clusters = [
-        { leadColor: rgba(255, 0, 0), colors: [] },
-        { leadColor: rgba(255, 128, 0), colors: [] },
-        { leadColor: rgba(128, 128, 0), colors: [] },
-        { leadColor: rgba(128, 255, 0), colors: [] },
-        { leadColor: rgba(0, 255, 0), colors: [] },
-        { leadColor: rgba(0, 255, 128), colors: [] },
-        { leadColor: rgba(0, 255, 255), colors: [] },
-        { leadColor: rgba(0, 127, 255), colors: [] },
-        { leadColor: rgba(0, 0, 255), colors: [] },
-        { leadColor: rgba(127, 0, 255), colors: [] },
-        { leadColor: rgba(128, 0, 128), colors: [] },
+        { leadColor: rgba(255, 0, 0), colors: [] }, // red
+        { leadColor: rgba(255, 128, 0), colors: [] }, // orange
+        { leadColor: rgba(128, 128, 0), colors: [] }, // yellow
+        { leadColor: rgba(128, 255, 0), colors: [] }, // chartreuse
+        { leadColor: rgba(0, 255, 0), colors: [] }, // green
+        { leadColor: rgba(0, 255, 128), colors: [] }, // spring green
+        { leadColor: rgba(0, 255, 255), colors: [] }, // cyan
+        { leadColor: rgba(0, 127, 255), colors: [] }, // azure
+        { leadColor: rgba(0, 0, 255), colors: [] }, // blue
+        { leadColor: rgba(127, 0, 255), colors: [] }, // violet
+        { leadColor: rgba(128, 0, 128), colors: [] }, // magenta
         { leadColor: rgba(255, 0, 128), colors: [] }, // rose
     ];
     for (const color of colorsToSort.map(colorToRGBA)) {
@@ -46434,6 +46449,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 zones) {
             for (const position of positions(zone)) {
@@ -46443,15 +46459,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 = futureRecomputeZones(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
@@ -52497,7 +52518,7 @@ class BottomBar extends owl.Component {
             .map((sheetEl) => sheetEl.getBoundingClientRect())
             .map((rect) => ({
             x: rect.x,
-            width: rect.width - 1,
+            width: rect.width - 1, // -1 to compensate negative margin
             y: rect.y,
             height: rect.height,
         }));
@@ -52719,7 +52740,7 @@ class RowGroup extends AbstractHeaderGroup {
         }
         return cssPropertiesToCss({
             top: `${groupBox.headerRect.height / 2}px`,
-            left: `calc(50% - 1px)`,
+            left: `calc(50% - 1px)`, // -1px: we want the border to be on the center
             width: `30%`,
             height: `calc(100% - ${groupBox.headerRect.height / 2}px)`,
             "border-left": `1px solid ${HEADER_GROUPING_BORDER_COLOR}`,
@@ -52771,7 +52792,7 @@ class ColGroup extends AbstractHeaderGroup {
             return "";
         }
         return cssPropertiesToCss({
-            top: `calc(50% - 1px)`,
+            top: `calc(50% - 1px)`, // -1px: we want the border to be on the center
             left: `${groupBox.headerRect.width / 2}px`,
             width: `calc(100% - ${groupBox.headerRect.width / 2}px)`,
             height: `30%`,
@@ -54182,7 +54203,7 @@ class Spreadsheet extends owl.Component {
         const gridColSize = GROUP_LAYER_WIDTH * this.rowLayers.length;
         const gridRowSize = GROUP_LAYER_WIDTH * this.colLayers.length;
         return cssPropertiesToCss({
-            "grid-template-columns": `${gridColSize ? gridColSize + 2 : 0}px auto`,
+            "grid-template-columns": `${gridColSize ? gridColSize + 2 : 0}px auto`, // +2: margins
             "grid-template-rows": `${gridRowSize ? gridRowSize + 2 : 0}px auto`,
         });
     }
@@ -55627,7 +55648,7 @@ class SelectionStreamProcessorImpl {
 }
 
 class StateObserver {
-    changes = [];
+    changes;
     commands = [];
     /**
      * Record the changes which could happen in the given callback, save them in a
@@ -55659,7 +55680,7 @@ class StateObserver {
         if (value[key] === val) {
             return;
         }
-        this.changes.push({
+        this.changes?.push({
             path: args,
             before: value[key],
             after: val,
@@ -56790,7 +56811,7 @@ function addTableColumns(table, sheetData) {
         const colHeaderXc = toXC(tableZone.left + i, tableZone.top);
         const colName = sheetData.cells[colHeaderXc]?.content || `col${i}`;
         const colAttributes = [
-            ["id", i + 1],
+            ["id", i + 1], // id cannot be 0
             ["name", colName],
         ];
         columns.push(escapeXml /*xml*/ `<tableColumn ${formatAttributes(colAttributes)}/>`);
@@ -57882,6 +57903,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.1.25";
-__info__.date = "2024-07-24T10:26:01.576Z";
-__info__.hash = "0edff47";
+__info__.version = "17.1.27";
+__info__.date = "2024-08-09T12:20:52.051Z";
+__info__.hash = "c626332";

package/dist/o-spreadsheet.d.ts

@@ -4006,7 +4006,7 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
 }
 
 declare class EvaluationPlugin extends UIPlugin {
-    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf", "getArrayFormulaSpreadingOn", "isEmpty"];
+    static getters: readonly ["evaluateFormula", "evaluateFormulaResult", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf", "getArrayFormulaSpreadingOn", "isEmpty"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
     private positionsToUpdate;
@@ -4015,6 +4015,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<FPayload> | FPayload;
     /**
      * Return the value of each cell in the range as they are displayed in the grid.
      */
@@ -7912,6 +7913,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     autoCompleteState: AutoCompleteState;
     functionDescriptionState: FunctionDescriptionState;
     private compositionActive;
+    private spreadsheetRect;
     get assistantStyle(): string;
     shouldProcessInputEvents: boolean;
     tokens: EnrichedToken[];
@@ -8130,7 +8132,7 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     private keyDownMapping;
     private isViewportTooSmall;
     get model(): Model;
-    getStyle(): string;
+    getStyle(): "grid-template-rows: auto;" | "grid-template-rows: 63px auto 37px";
     setup(): void;
     get focusTopBarComposer(): Omit<ComposerFocusType, "cellFocus">;
     get focusGridComposer(): ComposerFocusType;