@odoo/o-spreadsheet 17.0.22 → 17.0.25

package/dist/o-spreadsheet.esm.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.22
- * @date 2024-05-15T09:18:36.212Z
- * @hash 1f90749
+ * @version 17.0.25
+ * @date 2024-06-10T09:33:40.022Z
+ * @hash 1f01394
  */
 
 import { Component, useRef, onMounted, useEffect, onWillPatch, useState, onWillUpdateProps, onPatched, useComponent, useExternalListener, onWillUnmount, onWillStart, xml, useChildSubEnv, useSubEnv, markRaw } from '@odoo/owl';
@@ -45,7 +45,7 @@ class LazyTranslatedString extends String {
     }
     valueOf() {
         const str = super.valueOf();
-        return _loaded() ? sprintf(_translate(str), ...this.values) : str;
+        return _loaded() ? sprintf(_translate(str), ...this.values) : sprintf(str, ...this.values);
     }
     toString() {
         return this.valueOf();
@@ -392,7 +392,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
@@ -664,8 +667,9 @@ function deepEquals(o1, o2, ignoreFunctions) {
                 return false;
         }
         else {
-            if (ignoreFunctions && typeOfO1Key === "function")
-                return true;
+            if (ignoreFunctions && typeOfO1Key === "function") {
+                continue;
+            }
             if (o1[key] !== o2[key])
                 return false;
         }
@@ -4303,8 +4307,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.
@@ -5232,8 +5239,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;
@@ -6704,6 +6711,7 @@ const FilterMenuPopoverBuilder = {
 };
 
 const macRegex = /Mac/i;
+const MODIFIER_KEYS$1 = ["Shift", "Control", "Alt", "Meta"];
 /**
  * Return true if the event was triggered from
  * a child element.
@@ -6742,6 +6750,31 @@ function* iterateChildren(el) {
 function getOpenedMenus() {
     return Array.from(document.querySelectorAll(".o-spreadsheet .o-menu"));
 }
+const letterRegex = /^[a-zA-Z]$/;
+/**
+ * Transform a keyboard event into a shortcut string that represent this event. The letters keys will be uppercased.
+ *
+ * @argument ev - The keyboard event to transform
+ * @argument mode - Use either ev.key of ev.code to get the string shortcut
+ *
+ * @example
+ * event : { ctrlKey: true, key: "a" } => "Ctrl+A"
+ * event : { shift: true, alt: true, key: "Home" } => "Alt+Shift+Home"
+ */
+function keyboardEventToShortcutString(ev, mode = "key") {
+    let keyDownString = "";
+    if (!MODIFIER_KEYS$1.includes(ev.key)) {
+        if (isCtrlKey(ev))
+            keyDownString += "Ctrl+";
+        if (ev.altKey)
+            keyDownString += "Alt+";
+        if (ev.shiftKey)
+            keyDownString += "Shift+";
+    }
+    const key = mode === "key" ? ev.key : ev.code;
+    keyDownString += letterRegex.test(key) ? key.toUpperCase() : key;
+    return keyDownString;
+}
 function isMacOS() {
     return Boolean(macRegex.test(navigator.userAgent));
 }
@@ -6760,8 +6793,7 @@ function isCtrlKey(ev) {
  */
 function useSpreadsheetRect() {
     const position = 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");
@@ -8534,7 +8566,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();
@@ -8578,7 +8610,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;
@@ -8821,7 +8853,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;
     }
@@ -9155,7 +9187,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;
@@ -9475,7 +9507,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;
@@ -21722,7 +21754,7 @@ class LineBarPieConfigPanel extends 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;
@@ -25764,14 +25796,14 @@ class FigureComponent extends 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;
@@ -25792,7 +25824,22 @@ class FigureComponent extends 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;
@@ -26663,7 +26710,7 @@ class Composer extends Component {
         Enter: this.processEnterKey,
         Escape: this.processEscapeKey,
         F2: () => console.warn("Not implemented"),
-        F4: this.processF4Key,
+        F4: (ev) => this.processF4Key(ev),
         Tab: (ev) => this.processTabKey(ev),
     };
     keyCodeMapping = {
@@ -26768,9 +26815,10 @@ class Composer extends Component {
     processEscapeKey() {
         this.env.model.dispatch("CANCEL_EDITION");
     }
-    processF4Key() {
+    processF4Key(ev) {
         this.env.model.dispatch("CYCLE_EDITION_REFERENCES");
         this.processContent();
+        ev.stopPropagation();
     }
     processNumpadDecimal(ev) {
         ev.stopPropagation();
@@ -26811,8 +26859,15 @@ class Composer extends 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
@@ -26821,10 +26876,6 @@ class Composer extends 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") {
@@ -27272,10 +27323,7 @@ class GridComposer extends 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();
@@ -37962,7 +38010,12 @@ class MergePlugin extends CorePlugin {
      * if they have at least a common cell
      */
     doesIntersectMerge(sheetId, zone) {
-        return positions(zone).some(({ col, row }) => this.getMerge({ sheetId, col, row }) !== undefined);
+        for (const merge of this.getMerges(sheetId)) {
+            if (overlap(zone, merge)) {
+                return true;
+            }
+        }
+        return false;
     }
     /**
      * Returns true if two columns have at least one merge in common
@@ -38563,6 +38616,9 @@ class RangeAdapter {
         if (range.invalidXc) {
             return range.invalidXc;
         }
+        if (!this.getters.tryGetSheet(range.sheetId)) {
+            return INCORRECT_RANGE_STRING;
+        }
         if (range.zone.bottom - range.zone.top < 0 || range.zone.right - range.zone.left < 0) {
             return INCORRECT_RANGE_STRING;
         }
@@ -42014,16 +42070,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)
@@ -48324,7 +48386,7 @@ class ClipboardPlugin extends UIPlugin {
             case "ADD_COLUMNS_ROWS": {
                 this.status = "invisible";
                 // If we add a col/row inside or before the cut area, we invalidate the clipboard
-                if (this.state?.operation !== "CUT") {
+                if (this.state?.operation !== "CUT" || cmd.sheetId !== this.state?.sheetId) {
                     return;
                 }
                 const isClipboardDirty = this.state.isColRowDirtyingClipboard(cmd.position === "before" ? cmd.base : cmd.base + 1, cmd.dimension);
@@ -48336,7 +48398,7 @@ class ClipboardPlugin extends UIPlugin {
             case "REMOVE_COLUMNS_ROWS": {
                 this.status = "invisible";
                 // If we remove a col/row inside or before the cut area, we invalidate the clipboard
-                if (this.state?.operation !== "CUT") {
+                if (this.state?.operation !== "CUT" || cmd.sheetId !== this.state?.sheetId) {
                     return;
                 }
                 for (let el of cmd.elements) {
@@ -51635,9 +51697,11 @@ class BottomBarSheet extends 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) {
@@ -53519,6 +53583,10 @@ class Spreadsheet extends Component {
         });
         useExternalListener(window, "resize", () => this.render(true));
         useExternalListener(window, "beforeunload", this.unbindModelEvents.bind(this));
+        // For some reason, the wheel event is not properly registered inside templates
+        // in Chromium-based browsers based on chromium 125
+        // This hack ensures the event declared in the template is properly registered/working
+        useExternalListener(document.body, "wheel", () => { });
         this.bindModelEvents();
         onWillUpdateProps((nextProps) => {
             if (nextProps.model !== this.props.model) {
@@ -56382,7 +56450,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);
@@ -57367,6 +57439,6 @@ const constants = {
 export { AbstractChart, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
 
 
-__info__.version = "17.0.22";
-__info__.date = "2024-05-15T09:18:36.212Z";
-__info__.hash = "1f90749";
+__info__.version = "17.0.25";
+__info__.date = "2024-06-10T09:33:40.022Z";
+__info__.hash = "1f01394";