@odoo/o-spreadsheet 16.3.35 → 16.3.37

package/dist/o-spreadsheet.cjs.js

@@ -2488,8 +2488,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;
 }
 
 /** Methods from Odoo Web Utils  */
@@ -5262,6 +5265,7 @@ const FilterMenuPopoverBuilder = {
 };
 
 const macRegex = /Mac/i;
+const MODIFIER_KEYS = ["Shift", "Control", "Alt", "Meta"];
 /**
  * Return true if the event was triggered from
  * a child element.
@@ -5308,6 +5312,31 @@ function setElementScrollTop(el, scroll) {
 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.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));
 }
@@ -7027,7 +7056,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;
@@ -7271,7 +7300,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;
     }
@@ -7607,7 +7636,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;
@@ -7903,7 +7932,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;
@@ -8070,8 +8099,8 @@ 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;
@@ -18102,7 +18131,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;
@@ -20266,14 +20295,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;
@@ -20294,7 +20323,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;
@@ -21088,7 +21132,7 @@ class Composer extends owl.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),
     };
     setup() {
@@ -21205,9 +21249,10 @@ class Composer extends owl.Component {
     processEscapeKey() {
         this.env.model.dispatch("STOP_EDITION", { cancel: true });
     }
-    processF4Key() {
+    processF4Key(ev) {
         this.env.model.dispatch("CYCLE_EDITION_REFERENCES");
         this.processContent();
+        ev.stopPropagation();
     }
     onCompositionStart() {
         this.compositionActive = true;
@@ -31898,7 +31943,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
@@ -32510,6 +32560,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;
         }
@@ -40608,7 +40661,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);
@@ -40620,7 +40673,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) {
@@ -42523,9 +42576,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) {
@@ -44270,6 +44325,10 @@ class Spreadsheet extends owl.Component {
         });
         owl.useExternalListener(window, "resize", () => this.render(true));
         owl.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
+        owl.useExternalListener(document.body, "wheel", () => { });
         this.bindModelEvents();
         owl.onMounted(() => {
             this.checkViewportSize();
@@ -46309,6 +46368,12 @@ function addFormula(cell) {
     else {
         // Shouldn't we always output the value then ?
         const value = cell.value;
+        // 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 === "")
+            return undefined;
         const type = getCellType(value);
         attrs.push(["t", type]);
         node = escapeXml /*xml*/ `<v>${value}</v>`;
@@ -47112,7 +47177,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);
@@ -48093,6 +48162,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.3.35';
-__info__.date = '2024-05-15T09:15:19.399Z';
-__info__.hash = '255caa0';
+__info__.version = '16.3.37';
+__info__.date = '2024-06-03T14:49:37.305Z';
+__info__.hash = 'e7bf8e1';

package/dist/o-spreadsheet.esm.js

@@ -2484,8 +2484,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;
 }
 
 /** Methods from Odoo Web Utils  */
@@ -5258,6 +5261,7 @@ const FilterMenuPopoverBuilder = {
 };
 
 const macRegex = /Mac/i;
+const MODIFIER_KEYS = ["Shift", "Control", "Alt", "Meta"];
 /**
  * Return true if the event was triggered from
  * a child element.
@@ -5304,6 +5308,31 @@ function setElementScrollTop(el, scroll) {
 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.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));
 }
@@ -7023,7 +7052,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;
@@ -7267,7 +7296,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;
     }
@@ -7603,7 +7632,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;
@@ -7899,7 +7928,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;
@@ -8066,8 +8095,8 @@ 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;
@@ -18098,7 +18127,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;
@@ -20262,14 +20291,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;
@@ -20290,7 +20319,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;
@@ -21084,7 +21128,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),
     };
     setup() {
@@ -21201,9 +21245,10 @@ class Composer extends Component {
     processEscapeKey() {
         this.env.model.dispatch("STOP_EDITION", { cancel: true });
     }
-    processF4Key() {
+    processF4Key(ev) {
         this.env.model.dispatch("CYCLE_EDITION_REFERENCES");
         this.processContent();
+        ev.stopPropagation();
     }
     onCompositionStart() {
         this.compositionActive = true;
@@ -31894,7 +31939,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
@@ -32506,6 +32556,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;
         }
@@ -40604,7 +40657,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);
@@ -40616,7 +40669,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) {
@@ -42519,9 +42572,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) {
@@ -44266,6 +44321,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();
         onMounted(() => {
             this.checkViewportSize();
@@ -46305,6 +46364,12 @@ function addFormula(cell) {
     else {
         // Shouldn't we always output the value then ?
         const value = cell.value;
+        // 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 === "")
+            return undefined;
         const type = getCellType(value);
         attrs.push(["t", type]);
         node = escapeXml /*xml*/ `<v>${value}</v>`;
@@ -47108,7 +47173,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);
@@ -48061,6 +48130,6 @@ function addFunction(functionName, functionDescription) {
 export { AbstractChart, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, compile, components, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, invalidateEvaluationCommands, links, load, parse, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
 
 
-__info__.version = '16.3.35';
-__info__.date = '2024-05-15T09:15:19.399Z';
-__info__.hash = '255caa0';
+__info__.version = '16.3.37';
+__info__.date = '2024-06-03T14:49:37.305Z';
+__info__.hash = 'e7bf8e1';