@odoo/o-spreadsheet 17.2.18 → 17.2.20

package/dist/o-spreadsheet.iife.js

@@ -3,9 +3,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.2.18
- * @date 2024-07-24T10:28:05.353Z
- * @hash 6c65743
+ * @version 17.2.20
+ * @date 2024-08-09T12:24:12.002Z
+ * @hash d667a15
  */
 
 (function (exports, owl) {
@@ -486,7 +486,7 @@
       let timeout = undefined;
       const debounced = function () {
           const context = this;
-          const args = arguments;
+          const args = Array.from(arguments);
           function later() {
               timeout = undefined;
               if (!immediate) {
@@ -714,7 +714,7 @@
    */
   function largeMax(array) {
       let len = array.length;
-      if (len < 100000)
+      if (len < 100_000)
           return Math.max(...array);
       let max = -Infinity;
       while (len--) {
@@ -728,7 +728,7 @@
    */
   function largeMin(array) {
       let len = array.length;
-      if (len < 100000)
+      if (len < 100_000)
           return Math.min(...array);
       let min = +Infinity;
       while (len--) {
@@ -2669,13 +2669,16 @@
       }
       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;
@@ -2757,7 +2760,7 @@
               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;
                   }
@@ -7181,7 +7184,7 @@
   }
   function numberCell(value, format, formattedValue) {
       return {
-          value: value || 0,
+          value: value || 0, // necessary to avoid "-0" and NaN values,
           format,
           formattedValue,
           type: CellValueType.number,
@@ -19629,8 +19632,8 @@ stores.inject(MyMetaStore, storeInstance);
   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 },
           },
@@ -19676,7 +19679,7 @@ stores.inject(MyMetaStore, storeInstance);
               labels: truncateLabels ? labels.map(truncateLabel) : labels,
               datasets: [],
           },
-          platform: undefined,
+          platform: undefined, // This key is optional and will be set by chart.js
           plugins: [],
       };
   }
@@ -19953,7 +19956,7 @@ stores.inject(MyMetaStore, storeInstance);
           },
           y: {
               position: chart.verticalAxisPosition,
-              beginAtZero: true,
+              beginAtZero: true, // the origin of the y axis is always zero
               ticks: {
                   color: fontColor,
                   callback: (value) => {
@@ -20477,7 +20480,7 @@ stores.inject(MyMetaStore, storeInstance);
           },
           y: {
               position: chart.verticalAxisPosition,
-              beginAtZero: true,
+              beginAtZero: true, // the origin of the y axis is always zero
               ticks: {
                   color: fontColor,
                   callback: (value) => {
@@ -20567,7 +20570,7 @@ stores.inject(MyMetaStore, storeInstance);
           const dataset = {
               label,
               data,
-              tension: 0,
+              tension: 0, // 0 -> render straight lines, which is much faster
               borderColor: color,
               backgroundColor,
               pointBackgroundColor: color,
@@ -20789,7 +20792,7 @@ stores.inject(MyMetaStore, storeInstance);
               ...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,
           };
@@ -23356,7 +23359,7 @@ stores.inject(MyMetaStore, storeInstance);
           style: { fillColor: colorSet.highlight, textColor: "#FFFFFF" },
           border: { bottom: { color: colorSet.highlight, style: "thin" } },
       },
-      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } },
+      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } }, // @compatibility: should be double line
       firstRowStripe: { border: { bottom: { color: colorSet.highlight, style: "thin" } } },
       secondRowStripe: { border: { bottom: { color: colorSet.highlight, style: "thin" } } },
   });
@@ -23374,7 +23377,7 @@ stores.inject(MyMetaStore, storeInstance);
           },
       },
       headerRow: { border: { bottom: { color: colorSet.highlight, style: "medium" } } },
-      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } },
+      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } }, // @compatibility: should be double line
       firstRowStripe: { style: { fillColor: colorSet.light } },
       firstColumnStripe: { style: { fillColor: colorSet.light } },
   });
@@ -23393,7 +23396,7 @@ stores.inject(MyMetaStore, storeInstance);
       headerRow: {
           style: { fillColor: colorSet.highlight, textColor: "#FFFFFF" },
       },
-      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } },
+      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } }, // @compatibility: should be double line
       firstRowStripe: { style: { fillColor: colorSet.light } },
       firstColumnStripe: { style: { fillColor: colorSet.light } },
   });
@@ -23429,7 +23432,7 @@ stores.inject(MyMetaStore, storeInstance);
               bottom: { color: "#000000", style: "medium" },
           },
       },
-      totalRow: { border: { top: { color: "#000000", style: "medium" } } },
+      totalRow: { border: { top: { color: "#000000", style: "medium" } } }, // @compatibility: should be double line
       headerRow: {
           style: { fillColor: colorSet.highlight, textColor: "#FFFFFF" },
           border: { bottom: { color: "#000000", style: "medium" } },
@@ -23453,7 +23456,7 @@ stores.inject(MyMetaStore, storeInstance);
           },
           style: { fillColor: colorSet.light },
       },
-      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } },
+      totalRow: { border: { top: { color: colorSet.highlight, style: "medium" } } }, // @compatibility: should be double line
       firstRowStripe: { style: { fillColor: colorSet.medium } },
       firstColumnStripe: { style: { fillColor: colorSet.medium } },
   });
@@ -23484,7 +23487,7 @@ stores.inject(MyMetaStore, storeInstance);
       category: "dark",
       colorName: colorSet.name,
       wholeTable: { style: { fillColor: colorSet.light } },
-      totalRow: { border: { top: { color: "#000000", style: "medium" } } },
+      totalRow: { border: { top: { color: "#000000", style: "medium" } } }, // @compatibility: should be double line
       headerRow: { style: { fillColor: colorSet.highlight, textColor: "#FFFFFF" } },
       firstRowStripe: { style: { fillColor: colorSet.medium } },
       firstColumnStripe: { style: { fillColor: colorSet.medium } },
@@ -32256,7 +32259,9 @@ stores.inject(MyMetaStore, storeInstance);
           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`;
           const proposals = this.autoCompleteState.provider?.proposals;
@@ -32283,6 +32288,9 @@ stores.inject(MyMetaStore, storeInstance);
           }
           else if (this.props.delimitation) {
               assistantStyle["max-height"] = `${this.props.delimitation.height}px`;
+              if (composerRect.left + ASSISTANT_WIDTH > this.spreadsheetRect.width) {
+                  assistantStyle.right = `0px`;
+              }
           }
           return cssPropertiesToCss(assistantStyle);
       }
@@ -35682,7 +35690,7 @@ stores.inject(MyMetaStore, storeInstance);
       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,
           });
       }
@@ -35971,8 +35979,8 @@ stores.inject(MyMetaStore, storeInstance);
           "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();
           },
@@ -36773,10 +36781,10 @@ stores.inject(MyMetaStore, storeInstance);
   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,
@@ -37011,7 +37019,7 @@ stores.inject(MyMetaStore, storeInstance);
       61: "993366",
       62: "333399",
       63: "333333",
-      64: "000000",
+      64: "000000", // system foreground
       65: "FFFFFF", // system background
   };
   const IMAGE_MIMETYPE_TO_EXTENSION_MAPPING = {
@@ -40654,12 +40662,13 @@ stores.inject(MyMetaStore, storeInstance);
                   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;
@@ -44130,7 +44139,7 @@ stores.inject(MyMetaStore, storeInstance);
        * @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 },
@@ -45024,12 +45033,7 @@ stores.inject(MyMetaStore, storeInstance);
                           });
                       }
                       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);
                       }
                   }
               }
@@ -45039,7 +45043,7 @@ stores.inject(MyMetaStore, storeInstance);
        * 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) {
@@ -45048,20 +45052,20 @@ stores.inject(MyMetaStore, storeInstance);
                       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);
           }
       }
       /**
@@ -45094,12 +45098,7 @@ stores.inject(MyMetaStore, storeInstance);
                       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);
                       }
                   }
               }
@@ -47729,18 +47728,23 @@ stores.inject(MyMetaStore, storeInstance);
           this.evaluatedCells = new PositionMap();
           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);
-          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();
@@ -48084,6 +48088,7 @@ stores.inject(MyMetaStore, storeInstance);
   class EvaluationPlugin extends UIPlugin {
       static getters = [
           "evaluateFormula",
+          "evaluateFormulaResult",
           "getCorrespondingFormulaCell",
           "getRangeFormattedValues",
           "getRangeValues",
@@ -48146,12 +48151,14 @@ stores.inject(MyMetaStore, storeInstance);
       // 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.
@@ -48292,17 +48299,17 @@ stores.inject(MyMetaStore, storeInstance);
    */
   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)) {
@@ -51010,6 +51017,7 @@ stores.inject(MyMetaStore, storeInstance);
        * 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)) {
@@ -51019,15 +51027,20 @@ stores.inject(MyMetaStore, storeInstance);
                       // 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
@@ -55423,7 +55436,7 @@ stores.inject(MyMetaStore, storeInstance);
               .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,
           }));
@@ -55645,7 +55658,7 @@ stores.inject(MyMetaStore, storeInstance);
           }
           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}`,
@@ -55697,7 +55710,7 @@ stores.inject(MyMetaStore, storeInstance);
               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%`,
@@ -57115,7 +57128,7 @@ stores.inject(MyMetaStore, storeInstance);
           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`,
           });
       }
@@ -58565,7 +58578,7 @@ stores.inject(MyMetaStore, storeInstance);
   }
 
   class StateObserver {
-      changes = [];
+      changes;
       commands = [];
       /**
        * Record the changes which could happen in the given callback, save them in a
@@ -58597,7 +58610,7 @@ stores.inject(MyMetaStore, storeInstance);
           if (value[key] === val) {
               return;
           }
-          this.changes.push({
+          this.changes?.push({
               path: args,
               before: value[key],
               after: val,
@@ -59728,7 +59741,7 @@ stores.inject(MyMetaStore, storeInstance);
           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)}/>`);
@@ -60885,9 +60898,9 @@ stores.inject(MyMetaStore, storeInstance);
   exports.tokenize = tokenize;
 
 
-  __info__.version = "17.2.18";
-  __info__.date = "2024-07-24T10:28:05.353Z";
-  __info__.hash = "6c65743";
+  __info__.version = "17.2.20";
+  __info__.date = "2024-08-09T12:24:12.002Z";
+  __info__.hash = "d667a15";
 
 
 })(this.o_spreadsheet = this.o_spreadsheet || {}, owl);