@odoo/o-spreadsheet 17.1.16 → 17.1.18

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.16
- * @date 2024-05-24T11:27:23.083Z
- * @hash 3a41c3a
+ * @version 17.1.18
+ * @date 2024-06-10T09:34:55.045Z
+ * @hash 0e756ce
  */
 
 'use strict';
@@ -295,7 +295,10 @@ function deepCopy(obj) {
  * Check if the object is a plain old javascript object.
  */
 function isPlainObject(obj) {
-    return typeof obj === "object" && obj?.constructor === Object;
+    return (typeof obj === "object" &&
+        obj !== null &&
+        // obj.constructor can be undefined when there's no prototype (`Object.create(null, {})`)
+        (obj?.constructor === Object || obj?.constructor === undefined));
 }
 /**
  * Sanitize the name of a sheet, by eventually removing quotes
@@ -2607,7 +2610,7 @@ function evaluatePredicate(value, criterion) {
         return false;
     }
     if (typeof operand === "number" && operator === "=") {
-        return toString(value) === toString(operand);
+        return value.toString() === operand.toString();
     }
     if (operator === "<>" || operator === "=") {
         let result;
@@ -2667,14 +2670,13 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
     if (countArg % 2 === 1) {
         throw new EvaluationError(_t("Function [[FUNCTION_NAME]] expects criteria_range and criterion to be in pairs."));
     }
-    const dimRow = args[0].length;
-    const dimCol = args[0][0].length;
+    const firstArg = toMatrix(args[0]);
+    const dimRow = firstArg.length;
+    const dimCol = firstArg[0].length;
     let predicates = [];
     for (let i = 0; i < countArg - 1; i += 2) {
-        const criteriaRange = args[i];
-        if (!isMatrix(criteriaRange) ||
-            criteriaRange.length !== dimRow ||
-            criteriaRange[0].length !== dimCol) {
+        const criteriaRange = toMatrix(args[i]);
+        if (criteriaRange.length !== dimRow || criteriaRange[0].length !== dimCol) {
             throw new EvaluationError(_t("Function [[FUNCTION_NAME]] expects criteria_range to have the same dimension"));
         }
         const description = toString(args[i + 1]);
@@ -2684,7 +2686,7 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
         for (let j = 0; j < dimCol; j++) {
             let validatedPredicates = true;
             for (let k = 0; k < countArg - 1; k += 2) {
-                const criteriaValue = args[k][i][j].value;
+                const criteriaValue = toMatrix(args[k])[i][j].value;
                 const criterion = predicates[k / 2];
                 validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion);
                 if (!validatedPredicates) {
@@ -4372,8 +4374,11 @@ function copyRangeWithNewSheetId(sheetIdFrom, sheetIdTo, range) {
 /**
  * Create a range from a xc. If the xc is empty, this function returns undefined.
  */
-function createRange(getters, sheetId, range) {
-    return range ? getters.getRangeFromSheetXC(sheetId, range) : undefined;
+function createValidRange(getters, sheetId, xc) {
+    if (!xc)
+        return;
+    const range = getters.getRangeFromSheetXC(sheetId, xc);
+    return !(range.invalidSheetName || range.invalidXc) ? range : undefined;
 }
 /**
  * Spread multiple colrows zone to one row/col zone and add a many new input range as needed.
@@ -5304,8 +5309,8 @@ let ScorecardChart$1 = class ScorecardChart extends AbstractChart {
     type = "scorecard";
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
-        this.keyValue = createRange(getters, sheetId, definition.keyValue);
-        this.baseline = createRange(getters, sheetId, definition.baseline);
+        this.keyValue = createValidRange(getters, sheetId, definition.keyValue);
+        this.baseline = createValidRange(getters, sheetId, definition.baseline);
         this.baselineMode = definition.baselineMode;
         this.baselineDescr = definition.baselineDescr;
         this.background = definition.background;
@@ -6839,8 +6844,7 @@ function isCtrlKey(ev) {
  */
 function useSpreadsheetRect() {
     const position = owl.useState({ x: 0, y: 0, width: 0, height: 0 });
-    let spreadsheetElement = document.querySelector(".o-spreadsheet");
-    updatePosition();
+    let spreadsheetElement = null;
     function updatePosition() {
         if (!spreadsheetElement) {
             spreadsheetElement = document.querySelector(".o-spreadsheet");
@@ -8604,7 +8608,7 @@ function chartToImage(runtime, figure, type) {
     if ("chartJsConfig" in runtime) {
         runtime.chartJsConfig.plugins = [backgroundColorChartJSPlugin];
         // @ts-ignore
-        const chart = new window.Chart(canvas, runtime.chartJsConfig);
+        const chart = new window.Chart(canvas, deepCopy(runtime.chartJsConfig));
         const imgContent = chart.toBase64Image();
         chart.destroy();
         div.remove();
@@ -8648,7 +8652,7 @@ class BarChart extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.dataSets = createDataSets(getters, definition.dataSets, sheetId, definition.dataSetsHaveTitle);
-        this.labelRange = createRange(getters, sheetId, definition.labelRange);
+        this.labelRange = createValidRange(getters, sheetId, definition.labelRange);
         this.background = definition.background;
         this.verticalAxisPosition = definition.verticalAxisPosition;
         this.legendPosition = definition.legendPosition;
@@ -8891,7 +8895,7 @@ class GaugeChart extends AbstractChart {
     type = "gauge";
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
-        this.dataRange = createRange(this.getters, this.sheetId, definition.dataRange);
+        this.dataRange = createValidRange(this.getters, this.sheetId, definition.dataRange);
         this.sectionRule = definition.sectionRule;
         this.background = definition.background;
     }
@@ -9225,7 +9229,7 @@ class LineChart extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.dataSets = createDataSets(this.getters, definition.dataSets, sheetId, definition.dataSetsHaveTitle);
-        this.labelRange = createRange(this.getters, sheetId, definition.labelRange);
+        this.labelRange = createValidRange(this.getters, sheetId, definition.labelRange);
         this.background = definition.background;
         this.verticalAxisPosition = definition.verticalAxisPosition;
         this.legendPosition = definition.legendPosition;
@@ -9545,7 +9549,7 @@ class PieChart extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.dataSets = createDataSets(getters, definition.dataSets, sheetId, definition.dataSetsHaveTitle);
-        this.labelRange = createRange(getters, sheetId, definition.labelRange);
+        this.labelRange = createValidRange(getters, sheetId, definition.labelRange);
         this.background = definition.background;
         this.legendPosition = definition.legendPosition;
         this.aggregated = definition.aggregated;
@@ -11189,6 +11193,9 @@ function makeArg(str, description) {
     if (types.some((t) => t.startsWith("RANGE"))) {
         result.acceptMatrix = true;
     }
+    if (types.every((t) => t.startsWith("RANGE"))) {
+        result.acceptMatrixOnly = true;
+    }
     return result;
 }
 /**
@@ -11470,11 +11477,16 @@ const CHOOSECOLS = {
     compute: function (array, ...columns) {
         const _array = toMatrix(array);
         const _columns = flattenRowFirst(columns, (item) => toInteger(item?.value, this.locale));
-        assert(() => _columns.every((col) => col > 0 && col <= _array.length), _t("The columns arguments must be between 1 and %s (got %s).", _array.length.toString(), (_columns.find((col) => col <= 0 || col > _array.length) || 0).toString()));
+        const argOutOfRange = _columns.filter((col) => col === 0 || _array.length < Math.abs(col));
+        assert(() => argOutOfRange.length === 0, _t("The columns arguments must be between -%s and %s (got %s), excluding 0.", _array.length.toString(), _array.length.toString(), argOutOfRange.join(",")));
         const result = Array(_columns.length);
         for (let col = 0; col < _columns.length; col++) {
-            const colIndex = _columns[col] - 1; // -1 because columns arguments are 1-indexed
-            result[col] = _array[colIndex];
+            if (_columns[col] > 0) {
+                result[col] = _array[_columns[col] - 1]; // -1 because columns arguments are 1-indexed
+            }
+            else {
+                result[col] = _array[_array.length + _columns[col]];
+            }
         }
         return result;
     },
@@ -11495,8 +11507,14 @@ const CHOOSEROWS = {
         const _array = toMatrix(array);
         const _rows = flattenRowFirst(rows, (item) => toInteger(item?.value, this.locale));
         const _nbColumns = _array.length;
-        assert(() => _rows.every((row) => row > 0 && row <= _array[0].length), _t("The rows arguments must be between 1 and %s (got %s).", _array[0].length.toString(), (_rows.find((row) => row <= 0 || row > _array[0].length) || 0).toString()));
-        return generateMatrix(_nbColumns, _rows.length, (col, row) => _array[col][_rows[row] - 1]); // -1 because rows arguments are 1-indexed
+        const argOutOfRange = _rows.filter((row) => row === 0 || _array[0].length < Math.abs(row));
+        assert(() => argOutOfRange.length === 0, _t("The rows arguments must be between -%s and %s (got %s), excluding 0.", _array[0].length.toString(), _array[0].length.toString(), argOutOfRange.join(",")));
+        return generateMatrix(_nbColumns, _rows.length, (col, row) => {
+            if (_rows[row] > 0) {
+                return _array[col][_rows[row] - 1]; // -1 because columns arguments are 1-indexed
+            }
+            return _array[col][_array[col].length + _rows[row]];
+        });
     },
     isExported: true,
 };
@@ -12404,7 +12422,7 @@ const COUNTUNIQUEIFS = {
     compute: function (range, ...args) {
         let uniqueValues = new Set();
         visitMatchingRanges(args, (i, j) => {
-            const data = range[i][j];
+            const data = range[i]?.[j];
             if (isDefined(data)) {
                 uniqueValues.add(data.value);
             }
@@ -13034,7 +13052,7 @@ const SUMIF = {
         }
         let sum = 0;
         visitMatchingRanges([criteriaRange, criterion], (i, j) => {
-            const value = sumRange[i][j].value;
+            const value = sumRange[i]?.[j]?.value;
             if (typeof value === "number") {
                 sum += value;
             }
@@ -13059,7 +13077,7 @@ const SUMIFS = {
     compute: function (sumRange, ...criters) {
         let sum = 0;
         visitMatchingRanges(criters, (i, j) => {
-            const value = sumRange[i][j].value;
+            const value = sumRange[i]?.[j]?.value;
             if (typeof value === "number") {
                 sum += value;
             }
@@ -13606,7 +13624,7 @@ const AVERAGEIF = {
         let count = 0;
         let sum = 0;
         visitMatchingRanges([criteriaRange, criterion], (i, j) => {
-            const value = _averageRange[i][j].value;
+            const value = _averageRange[i]?.[j]?.value;
             if (typeof value === "number") {
                 count += 1;
                 sum += value;
@@ -13635,7 +13653,7 @@ const AVERAGEIFS = {
         let count = 0;
         let sum = 0;
         visitMatchingRanges(args, (i, j) => {
-            const value = _averageRange[i][j].value;
+            const value = _averageRange[i]?.[j]?.value;
             if (typeof value === "number") {
                 count += 1;
                 sum += value;
@@ -13940,7 +13958,7 @@ const MAXIFS = {
     compute: function (range, ...args) {
         let result = -Infinity;
         visitMatchingRanges(args, (i, j) => {
-            const value = range[i][j].value;
+            const value = range[i]?.[j]?.value;
             if (typeof value === "number") {
                 result = result < value ? value : result;
             }
@@ -14023,7 +14041,7 @@ const MINIFS = {
     compute: function (range, ...args) {
         let result = Infinity;
         visitMatchingRanges(args, (i, j) => {
-            const value = range[i][j].value;
+            const value = range[i]?.[j]?.value;
             if (typeof value === "number") {
                 result = result > value ? value : result;
             }
@@ -19800,6 +19818,9 @@ function addInputHandling(descr) {
                 }
                 args[i] = arg[0][0];
             }
+            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()));
+            }
         }
         return descr.compute.apply(this, args);
     }
@@ -22152,7 +22173,7 @@ class LineBarPieConfigPanel extends owl.Component {
         }
         const getters = this.env.model.getters;
         const sheetId = getters.getActiveSheetId();
-        const labelRange = createRange(getters, sheetId, this.labelRange);
+        const labelRange = createValidRange(getters, sheetId, this.labelRange);
         const dataSets = createDataSets(getters, this.dataSeriesRanges, sheetId, this.props.definition.dataSetsHaveTitle);
         if (dataSets.length) {
             return dataSets[0].dataRange.zone.top + 1;
@@ -26275,14 +26296,14 @@ class FigureComponent extends owl.Component {
     }
     onKeyDown(ev) {
         const figure = this.props.figure;
-        switch (ev.key) {
+        const keyDownShortcut = keyboardEventToShortcutString(ev);
+        switch (keyDownShortcut) {
             case "Delete":
                 this.env.model.dispatch("DELETE_FIGURE", {
                     sheetId: this.env.model.getters.getActiveSheetId(),
                     id: figure.id,
                 });
                 this.props.onFigureDeleted();
-                ev.stopPropagation();
                 ev.preventDefault();
                 ev.stopPropagation();
                 break;
@@ -26303,7 +26324,22 @@ class FigureComponent extends owl.Component {
                     x: figure.x + delta[0],
                     y: figure.y + delta[1],
                 });
+                ev.preventDefault();
                 ev.stopPropagation();
+                break;
+            case "Ctrl+A":
+                // Maybe in the future we will implement a way to select all figures
+                ev.preventDefault();
+                ev.stopPropagation();
+                break;
+            case "Ctrl+Y":
+            case "Ctrl+Z":
+                if (keyDownShortcut === "Ctrl+Y") {
+                    this.env.model.dispatch("REQUEST_REDO");
+                }
+                else if (keyDownShortcut === "Ctrl+Z") {
+                    this.env.model.dispatch("REQUEST_UNDO");
+                }
                 ev.preventDefault();
                 ev.stopPropagation();
                 break;
@@ -27341,8 +27377,15 @@ class Composer extends owl.Component {
     }
     onPaste(ev) {
         if (this.env.model.getters.getEditionMode() !== "inactive") {
+            // let the browser clipboard work
             ev.stopPropagation();
         }
+        else {
+            // the user meant to paste in the sheet, not open the composer with the pasted content
+            // While we're not editing, we still have the focus and should therefore prevent
+            // the native "paste" to occur.
+            ev.preventDefault();
+        }
     }
     /*
      * Triggered automatically by the content-editable between the keydown and key up
@@ -27351,10 +27394,6 @@ class Composer extends owl.Component {
         if (!this.shouldProcessInputEvents) {
             return;
         }
-        if (ev.inputType === "insertFromPaste" &&
-            this.env.model.getters.getEditionMode() === "inactive") {
-            return;
-        }
         ev.stopPropagation();
         let content;
         if (this.env.model.getters.getEditionMode() === "inactive") {
@@ -27795,10 +27834,7 @@ class GridComposer extends owl.Component {
     }
     get containerStyle() {
         if (this.env.model.getters.getEditionMode() === "inactive" || !this.rect) {
-            return `
-        position: absolute;
-        z-index: -1000;
-      `;
+            return `z-index: -1000;`;
         }
         const isFormula = this.env.model.getters.getCurrentContent().startsWith("=");
         const cell = this.env.model.getters.getActiveCell();
@@ -35764,12 +35800,6 @@ function compileTokens(tokens) {
                 // detect when an argument need to be evaluated as a meta argument
                 const isMeta = argTypes.includes("META");
                 const hasRange = argTypes.some((t) => isRangeType(t));
-                const isRangeOnly = argTypes.every((t) => isRangeType(t));
-                if (isRangeOnly) {
-                    if (!isRangeInput(currentArg)) {
-                        throw new BadExpressionError(_t("Function %s expects the parameter %s to be reference to a cell or range, not a %s.", functionName, (i + 1).toString(), currentArg.type.toLowerCase()));
-                    }
-                }
                 compiledArgs.push(compileAST(currentArg, isMeta, hasRange, {
                     functionName,
                     paramIndex: i + 1,
@@ -35940,16 +35970,6 @@ function assertEnoughArgs(ast) {
 function isRangeType(type) {
     return type.startsWith("RANGE");
 }
-function isRangeInput(arg) {
-    if (arg.type === "REFERENCE") {
-        return true;
-    }
-    if (arg.type === "FUNCALL") {
-        const fnDef = functions$1[arg.value.toUpperCase()];
-        return fnDef && isRangeType(fnDef.returns[0]);
-    }
-    return false;
-}
 
 /**
  * Add the following information on tokens:
@@ -39062,6 +39082,9 @@ class RangeAdapter {
         if (range.invalidXc) {
             return range.invalidXc;
         }
+        if (!this.getters.tryGetSheet(range.sheetId)) {
+            return CellErrorType.InvalidReference;
+        }
         if (range.zone.bottom - range.zone.top < 0 || range.zone.right - range.zone.left < 0) {
             return CellErrorType.InvalidReference;
         }
@@ -42509,16 +42532,22 @@ class EvaluationPlugin extends UIPlugin {
             let newContent = undefined;
             let newFormat = undefined;
             let isExported = true;
+            const exportedSheetData = data.sheets.find((sheet) => sheet.id === position.sheetId);
             const formulaCell = this.getCorrespondingFormulaCell(position);
             if (formulaCell) {
                 isExported = isExportableToExcel(formulaCell.compiledFormula.tokens);
                 isFormula = isExported;
                 if (!isExported) {
-                    newContent = value.toString();
-                    newFormat = evaluatedCell.format;
+                    // If the cell contains a non-exported formula and that is evaluates to
+                    // nothing* ,we don't export it.
+                    // * non-falsy value are relevant and so are 0 and FALSE, which only leaves
+                    // the empty string.
+                    if (value !== "") {
+                        newContent = value.toString();
+                        newFormat = evaluatedCell.format;
+                    }
                 }
             }
-            const exportedSheetData = data.sheets.find((sheet) => sheet.id === position.sheetId);
             const exportedCellData = exportedSheetData.cells[xc] || {};
             const format = newFormat
                 ? getItemId(newFormat, data.formats)
@@ -52015,9 +52044,11 @@ class BottomBarSheet extends owl.Component {
         if (ev.key === "Enter") {
             ev.preventDefault();
             this.stopEdition();
+            this.env.focusableElement.focus();
         }
         if (ev.key === "Escape") {
             this.cancelEdition();
+            this.env.focusableElement.focus();
         }
     }
     onClickSheetName(ev) {
@@ -56712,7 +56743,11 @@ function addRows(construct, data, sheet) {
                 let cellNode = escapeXml ``;
                 // Either formula or static value inside the cell
                 if (cell.isFormula) {
-                    ({ attrs: additionalAttrs, node: cellNode } = addFormula(cell));
+                    const res = addFormula(cell);
+                    if (!res) {
+                        continue;
+                    }
+                    ({ attrs: additionalAttrs, node: cellNode } = res);
                 }
                 else if (cell.content && isMarkdownLink(cell.content)) {
                     const { label } = parseMarkdownLink(cell.content);
@@ -57742,6 +57777,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.1.16";
-__info__.date = "2024-05-24T11:27:23.083Z";
-__info__.hash = "3a41c3a";
+__info__.version = "17.1.18";
+__info__.date = "2024-06-10T09:34:55.045Z";
+__info__.hash = "0e756ce";

package/dist/o-spreadsheet.d.ts

@@ -5200,6 +5200,7 @@ type Getters = {
 type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "RANGE<ANY>" | "META";
 interface ArgDefinition {
     acceptMatrix?: boolean;
+    acceptMatrixOnly?: boolean;
     repeating?: boolean;
     optional?: boolean;
     description: string;