@odoo/o-spreadsheet 16.4.34 → 16.4.36

package/dist/o-spreadsheet.cjs.js

@@ -3236,8 +3236,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.
@@ -5704,6 +5707,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.
@@ -5742,6 +5746,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.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));
 }
@@ -5760,8 +5789,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");
@@ -16542,7 +16570,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;
@@ -16787,7 +16815,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;
     }
@@ -17126,7 +17154,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;
@@ -17424,7 +17452,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;
@@ -17592,8 +17620,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;
@@ -20952,7 +20980,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;
@@ -23417,14 +23445,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;
@@ -23445,7 +23473,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;
@@ -24316,8 +24359,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
@@ -24326,10 +24376,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") {
@@ -24760,10 +24806,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();
@@ -34593,6 +34636,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;
         }
@@ -37644,16 +37690,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)
@@ -46524,9 +46576,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) {
@@ -51142,7 +51196,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);
@@ -52137,6 +52195,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.4.34';
-__info__.date = '2024-05-24T11:27:29.421Z';
-__info__.hash = '5e74805';
+__info__.version = '16.4.36';
+__info__.date = '2024-06-10T09:33:43.623Z';
+__info__.hash = '3b15ed5';

package/dist/o-spreadsheet.esm.js

@@ -3232,8 +3232,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.
@@ -5700,6 +5703,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.
@@ -5738,6 +5742,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.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));
 }
@@ -5756,8 +5785,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");
@@ -16538,7 +16566,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;
@@ -16783,7 +16811,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;
     }
@@ -17122,7 +17150,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;
@@ -17420,7 +17448,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;
@@ -17588,8 +17616,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;
@@ -20948,7 +20976,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;
@@ -23413,14 +23441,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;
@@ -23441,7 +23469,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;
@@ -24312,8 +24355,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
@@ -24322,10 +24372,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") {
@@ -24756,10 +24802,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();
@@ -34589,6 +34632,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;
         }
@@ -37640,16 +37686,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)
@@ -46520,9 +46572,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) {
@@ -51138,7 +51192,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);
@@ -52101,6 +52159,6 @@ const constants = {
 export { AbstractChart, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, compile, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
 
 
-__info__.version = '16.4.34';
-__info__.date = '2024-05-24T11:27:29.421Z';
-__info__.hash = '5e74805';
+__info__.version = '16.4.36';
+__info__.date = '2024-06-10T09:33:43.623Z';
+__info__.hash = '3b15ed5';