@odoo/o-spreadsheet 17.0.31 → 17.0.33

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.0.31
- * @date 2024-07-18T14:22:00.324Z
- * @hash c64db0d
+ * @version 17.0.33
+ * @date 2024-08-02T08:18:55.061Z
+ * @hash 4ad4049
  */
 
 'use strict';
@@ -594,7 +594,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) {
@@ -797,7 +797,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--) {
@@ -811,7 +811,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--) {
@@ -2566,13 +2566,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 toString(value) === toString(operand);
+        if (typeof value === "string" && (isNumber(value, locale) || isDateTime(value, locale))) {
+            return toNumber(value, locale) === operand;
+        }
+        return value === operand;
     }
     if (operator === "<>" || operator === "=") {
         let result;
@@ -2651,7 +2654,7 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
             for (let k = 0; k < countArg - 1; k += 2) {
                 const criteriaValue = args[k][i][j];
                 const criterion = predicates[k / 2];
-                validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion);
+                validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion, locale);
                 if (!validatedPredicates) {
                     break;
                 }
@@ -5900,7 +5903,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",
@@ -8433,8 +8436,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 },
         },
@@ -8743,7 +8746,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) => {
@@ -9397,7 +9400,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) => {
@@ -9485,7 +9488,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,
@@ -9596,7 +9599,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,
         };
@@ -26700,7 +26703,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") {
@@ -26723,6 +26728,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
@@ -28371,10 +28380,13 @@ function useCellHovered(env, gridRef, callback) {
         row: undefined,
     };
     const { Date } = window;
-    let x = 0;
-    let y = 0;
+    let x = undefined;
+    let y = undefined;
     let lastMoved = 0;
     function getPosition() {
+        if (x === undefined || y === undefined) {
+            return { col: -1, row: -1 };
+        }
         const col = env.model.getters.getColIndex(x);
         const row = env.model.getters.getRowIndex(y);
         return { col, row };
@@ -29578,7 +29590,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,
         });
     }
@@ -29789,8 +29801,8 @@ class Grid extends owl.Component {
         "CTRL+SHIFT+L": () => this.setHorizontalAlign("left"),
         "CTRL+SHIFT+R": () => this.setHorizontalAlign("right"),
         "CTRL+SHIFT+V": () => PASTE_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();
         },
@@ -30604,10 +30616,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,
@@ -30842,7 +30854,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 = {
@@ -34483,12 +34495,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;
@@ -39549,12 +39562,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);
                     }
                 }
             }
@@ -39564,7 +39572,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) {
@@ -39573,20 +39581,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);
         }
     }
     /**
@@ -39619,12 +39627,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);
                     }
                 }
             }
@@ -42237,17 +42240,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)) {
@@ -42553,40 +42556,45 @@ class EvaluationConditionalFormatPlugin extends UIPlugin {
     getComputedStyles(sheetId) {
         const computedStyle = {};
         for (let cf of this.getters.getConditionalFormats(sheetId).reverse()) {
-            switch (cf.rule.type) {
-                case "ColorScaleRule":
-                    for (let range of cf.ranges) {
-                        this.applyColorScale(sheetId, range, cf.rule, computedStyle);
-                    }
-                    break;
-                case "CellIsRule":
-                    const formulas = cf.rule.values.map((value) => value.startsWith("=") ? compile(value) : undefined);
-                    for (let ref of cf.ranges) {
-                        const zone = this.getters.getRangeFromSheetXC(sheetId, ref).zone;
-                        for (let row = zone.top; row <= zone.bottom; row++) {
-                            for (let col = zone.left; col <= zone.right; col++) {
-                                const predicate = this.rulePredicate[cf.rule.type];
-                                const target = { sheetId, col, row };
-                                const values = cf.rule.values.map((value, i) => {
-                                    const compiledFormula = formulas[i];
-                                    if (compiledFormula) {
-                                        return this.getters.getTranslatedCellFormula(sheetId, col - zone.left, row - zone.top, {
-                                            ...compiledFormula,
-                                            dependencies: compiledFormula.dependencies.map((d) => this.getters.getRangeFromSheetXC(sheetId, d)),
-                                        });
+            try {
+                switch (cf.rule.type) {
+                    case "ColorScaleRule":
+                        for (let range of cf.ranges) {
+                            this.applyColorScale(sheetId, range, cf.rule, computedStyle);
+                        }
+                        break;
+                    case "CellIsRule":
+                        const formulas = cf.rule.values.map((value) => value.startsWith("=") ? compile(value) : undefined);
+                        for (let ref of cf.ranges) {
+                            const zone = this.getters.getRangeFromSheetXC(sheetId, ref).zone;
+                            for (let row = zone.top; row <= zone.bottom; row++) {
+                                for (let col = zone.left; col <= zone.right; col++) {
+                                    const predicate = this.rulePredicate[cf.rule.type];
+                                    const target = { sheetId, col, row };
+                                    const values = cf.rule.values.map((value, i) => {
+                                        const compiledFormula = formulas[i];
+                                        if (compiledFormula) {
+                                            return this.getters.getTranslatedCellFormula(sheetId, col - zone.left, row - zone.top, {
+                                                ...compiledFormula,
+                                                dependencies: compiledFormula.dependencies.map((d) => this.getters.getRangeFromSheetXC(sheetId, d)),
+                                            });
+                                        }
+                                        return value;
+                                    });
+                                    if (predicate && predicate(target, { ...cf.rule, values })) {
+                                        if (!computedStyle[col])
+                                            computedStyle[col] = [];
+                                        // we must combine all the properties of all the CF rules applied to the given cell
+                                        computedStyle[col][row] = Object.assign(computedStyle[col]?.[row] || {}, cf.rule.style);
                                     }
-                                    return value;
-                                });
-                                if (predicate && predicate(target, { ...cf.rule, values })) {
-                                    if (!computedStyle[col])
-                                        computedStyle[col] = [];
-                                    // we must combine all the properties of all the CF rules applied to the given cell
-                                    computedStyle[col][row] = Object.assign(computedStyle[col]?.[row] || {}, cf.rule.style);
                                 }
                             }
                         }
-                    }
-                    break;
+                        break;
+                }
+            }
+            catch (_) {
+                // we ignore the errors within the evaluation of a rule
             }
         }
         return computedStyle;
@@ -52152,7 +52160,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,
         }));
@@ -52377,7 +52385,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}`,
@@ -52429,7 +52437,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%`,
@@ -53830,7 +53838,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`,
         });
     }
@@ -55333,7 +55341,7 @@ class SelectionStreamProcessorImpl {
 }
 
 class StateObserver {
-    changes = [];
+    changes;
     commands = [];
     /**
      * Record the changes which could happen in the given callback, save them in a
@@ -55365,7 +55373,7 @@ class StateObserver {
         if (value[key] === val) {
             return;
         }
-        this.changes.push({
+        this.changes?.push({
             path: args,
             before: value[key],
             after: val,
@@ -56496,7 +56504,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)}/>`);
@@ -57578,6 +57586,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.0.31";
-__info__.date = "2024-07-18T14:22:00.324Z";
-__info__.hash = "c64db0d";
+__info__.version = "17.0.33";
+__info__.date = "2024-08-02T08:18:55.061Z";
+__info__.hash = "4ad4049";

package/dist/o-spreadsheet.d.ts

@@ -7250,6 +7250,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     autoCompleteState: AutoCompleteState;
     functionDescriptionState: FunctionDescriptionState;
     private compositionActive;
+    private spreadsheetRect;
     get assistantStyle(): string;
     shouldProcessInputEvents: boolean;
     tokens: EnrichedToken[];
@@ -7438,7 +7439,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;