@odoo/o-spreadsheet 16.0.42 → 16.0.44

package/dist/o-spreadsheet.cjs.js

@@ -2301,8 +2301,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  */
@@ -4023,6 +4026,7 @@ function getMenuDescription(node) {
 }
 
 const macRegex = /Mac/i;
+const MODIFIER_KEYS = ["Shift", "Control", "Alt", "Meta"];
 /**
  * Return true if the event was triggered from
  * a child element.
@@ -4041,6 +4045,31 @@ function gridOverlayPosition() {
 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));
 }
@@ -6975,8 +7004,8 @@ function createDataSets(getters, dataSetsString, sheetId, dataSetsHaveTitle) {
     const dataSets = [];
     for (const sheetXC of dataSetsString) {
         const dataRange = getters.getRangeFromSheetXC(sheetId, sheetXC);
-        const { unboundedZone: zone, sheetId: dataSetSheetId, invalidSheetName } = dataRange;
-        if (invalidSheetName) {
+        const { unboundedZone: zone, sheetId: dataSetSheetId, invalidSheetName, invalidXc } = dataRange;
+        if (invalidSheetName || invalidXc) {
             continue;
         }
         // It's a rectangle. We treat all columns (arbitrary) as different data series.
@@ -7369,7 +7398,7 @@ class BarChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "bar";
         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;
@@ -7665,7 +7694,7 @@ class GaugeChart extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.type = "gauge";
-        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;
     }
@@ -7996,7 +8025,7 @@ class LineChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "line";
         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;
@@ -8270,7 +8299,7 @@ class PieChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "pie";
         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;
     }
@@ -8428,8 +8457,8 @@ class ScorecardChart$1 extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.type = "scorecard";
-        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;
@@ -20582,8 +20611,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
@@ -20593,10 +20629,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") {
@@ -20913,10 +20945,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();
@@ -21202,7 +21231,8 @@ 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(),
@@ -21232,6 +21262,22 @@ class FigureComponent extends owl.Component {
                 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;
         }
     }
 }
@@ -23254,15 +23300,7 @@ class DateTimeCell extends NumberCell {
 }
 class LinkCell extends AbstractCell {
     constructor(id, content, properties = {}) {
-        var _a;
         const link = parseMarkdownLink(content);
-        properties = {
-            ...properties,
-            style: {
-                ...properties.style,
-                textColor: ((_a = properties.style) === null || _a === void 0 ? void 0 : _a.textColor) || LINK_COLOR,
-            },
-        };
         link.label = _t(link.label);
         super(id, lazy({ value: link.label, type: CellValueType.text }), properties);
         this.link = link;
@@ -27828,6 +27866,7 @@ class BordersPlugin extends CorePlugin {
 BordersPlugin.getters = ["getCellBorder"];
 
 const nbspRegexp = new RegExp(String.fromCharCode(160), "g");
+const LINK_STYLE = { textColor: LINK_COLOR };
 /**
  * Core Plugin
  *
@@ -28062,7 +28101,11 @@ class CellPlugin extends CorePlugin {
         return this.buildFormulaContent(sheetId, cell);
     }
     getCellStyle(cell) {
-        return (cell && cell.style) || {};
+        if (!cell) {
+            return {};
+        }
+        const linkStyle = cell.isLink() ? LINK_STYLE : {};
+        return { ...linkStyle, ...cell.style };
     }
     /**
      * Converts a zone to a XC coordinate system
@@ -40631,6 +40674,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;
         }
@@ -41769,6 +41815,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>`;
@@ -42491,7 +42543,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);
@@ -43327,6 +43383,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.0.42';
-__info__.date = '2024-05-24T11:24:56.581Z';
-__info__.hash = 'fd11d19';
+__info__.version = '16.0.44';
+__info__.date = '2024-06-10T09:32:19.116Z';
+__info__.hash = '25d16f6';

package/dist/o-spreadsheet.esm.js

@@ -2297,8 +2297,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  */
@@ -4019,6 +4022,7 @@ function getMenuDescription(node) {
 }
 
 const macRegex = /Mac/i;
+const MODIFIER_KEYS = ["Shift", "Control", "Alt", "Meta"];
 /**
  * Return true if the event was triggered from
  * a child element.
@@ -4037,6 +4041,31 @@ function gridOverlayPosition() {
 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));
 }
@@ -6971,8 +7000,8 @@ function createDataSets(getters, dataSetsString, sheetId, dataSetsHaveTitle) {
     const dataSets = [];
     for (const sheetXC of dataSetsString) {
         const dataRange = getters.getRangeFromSheetXC(sheetId, sheetXC);
-        const { unboundedZone: zone, sheetId: dataSetSheetId, invalidSheetName } = dataRange;
-        if (invalidSheetName) {
+        const { unboundedZone: zone, sheetId: dataSetSheetId, invalidSheetName, invalidXc } = dataRange;
+        if (invalidSheetName || invalidXc) {
             continue;
         }
         // It's a rectangle. We treat all columns (arbitrary) as different data series.
@@ -7365,7 +7394,7 @@ class BarChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "bar";
         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;
@@ -7661,7 +7690,7 @@ class GaugeChart extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.type = "gauge";
-        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;
     }
@@ -7992,7 +8021,7 @@ class LineChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "line";
         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;
@@ -8266,7 +8295,7 @@ class PieChart extends AbstractChart {
         super(definition, sheetId, getters);
         this.type = "pie";
         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;
     }
@@ -8424,8 +8453,8 @@ class ScorecardChart$1 extends AbstractChart {
     constructor(definition, sheetId, getters) {
         super(definition, sheetId, getters);
         this.type = "scorecard";
-        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;
@@ -20578,8 +20607,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
@@ -20589,10 +20625,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") {
@@ -20909,10 +20941,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();
@@ -21198,7 +21227,8 @@ 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(),
@@ -21228,6 +21258,22 @@ class FigureComponent extends Component {
                 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;
         }
     }
 }
@@ -23250,15 +23296,7 @@ class DateTimeCell extends NumberCell {
 }
 class LinkCell extends AbstractCell {
     constructor(id, content, properties = {}) {
-        var _a;
         const link = parseMarkdownLink(content);
-        properties = {
-            ...properties,
-            style: {
-                ...properties.style,
-                textColor: ((_a = properties.style) === null || _a === void 0 ? void 0 : _a.textColor) || LINK_COLOR,
-            },
-        };
         link.label = _t(link.label);
         super(id, lazy({ value: link.label, type: CellValueType.text }), properties);
         this.link = link;
@@ -27824,6 +27862,7 @@ class BordersPlugin extends CorePlugin {
 BordersPlugin.getters = ["getCellBorder"];
 
 const nbspRegexp = new RegExp(String.fromCharCode(160), "g");
+const LINK_STYLE = { textColor: LINK_COLOR };
 /**
  * Core Plugin
  *
@@ -28058,7 +28097,11 @@ class CellPlugin extends CorePlugin {
         return this.buildFormulaContent(sheetId, cell);
     }
     getCellStyle(cell) {
-        return (cell && cell.style) || {};
+        if (!cell) {
+            return {};
+        }
+        const linkStyle = cell.isLink() ? LINK_STYLE : {};
+        return { ...linkStyle, ...cell.style };
     }
     /**
      * Converts a zone to a XC coordinate system
@@ -40627,6 +40670,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;
         }
@@ -41765,6 +41811,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>`;
@@ -42487,7 +42539,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);
@@ -43295,6 +43351,6 @@ function addFunction(functionName, functionDescription) {
 export { AbstractChart, CommandResult, CorePlugin, DATETIME_FORMAT, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, cellTypes, compile, components, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, invalidateEvaluationCommands, load, parse, readonlyAllowedCommands, registries, setTranslationMethod, tokenize };
 
 
-__info__.version = '16.0.42';
-__info__.date = '2024-05-24T11:24:56.581Z';
-__info__.hash = 'fd11d19';
+__info__.version = '16.0.44';
+__info__.date = '2024-06-10T09:32:19.116Z';
+__info__.hash = '25d16f6';