@odoo/o-spreadsheet 17.0.23 → 17.0.27

package/dist/o-spreadsheet.iife.js

@@ -2,17 +2,18 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.0.23
- * @date 2024-05-24T11:27:27.416Z
- * @hash 6c10fec
+ * @version 17.0.27
+ * @date 2024-07-02T09:01:48.383Z
+ * @hash c1c2d01
  */
 
 (function (exports, owl) {
   'use strict';
 
-  // define a mock translation function, when o-spreadsheet runs in standalone it doesn't translate any string
-  let _translate = (s) => s;
-  let _loaded = () => false;
+  const defaultTranslate = (s) => s;
+  const defaultLoaded = () => false;
+  let _translate = defaultTranslate;
+  let _loaded = defaultLoaded;
   function sprintf(s, ...values) {
       if (values.length === 1 && typeof values[0] === "object" && !(values[0] instanceof String)) {
           const valuesDict = values[0];
@@ -24,7 +25,8 @@
       return s;
   }
   /***
-   * Allow to inject a translation function from outside o-spreadsheet.
+   * Allow to inject a translation function from outside o-spreadsheet. This should be called before instantiating
+   * a model.
    * @param tfn the function that will do the translation
    * @param loaded a function that returns true when the translation is loaded
    */
@@ -32,6 +34,18 @@
       _translate = tfn;
       _loaded = loaded;
   }
+  /**
+   * If no translation function has been set, this will mark the translation are loaded.
+   *
+   * By default, the translations should not be set as loaded, otherwise top-level translated constants will never be
+   * translated. But if by the time the model is instantiated no custom translation function has been set, we can set
+   * the default translation function as loaded so o-spreadsheet can be run in standalone with no translations.
+   */
+  function setDefaultTranslationMethod() {
+      if (_translate === defaultTranslate && _loaded === defaultLoaded) {
+          _loaded = () => true;
+      }
+  }
   const _t = function (s, ...values) {
       if (!_loaded()) {
           return new LazyTranslatedString(s, values);
@@ -393,7 +407,10 @@
    * 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
@@ -4305,8 +4322,11 @@
   /**
    * 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.
@@ -5234,8 +5254,8 @@
       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;
@@ -6706,6 +6726,7 @@
   };
 
   const macRegex = /Mac/i;
+  const MODIFIER_KEYS$1 = ["Shift", "Control", "Alt", "Meta"];
   /**
    * Return true if the event was triggered from
    * a child element.
@@ -6744,6 +6765,31 @@
   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));
   }
@@ -6762,8 +6808,7 @@
    */
   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");
@@ -6901,7 +6946,7 @@
               if (!anchor)
                   return;
               const propsMaxSize = { width: this.props.maxWidth, height: this.props.maxHeight };
-              const elDims = {
+              let elDims = {
                   width: el.getBoundingClientRect().width,
                   height: el.getBoundingClientRect().height,
               };
@@ -6909,7 +6954,14 @@
               const popoverPositionHelper = this.props.positioning === "BottomLeft"
                   ? new BottomLeftPopoverContext(anchor, this.containerRect, propsMaxSize, spreadsheetRect)
                   : new TopRightPopoverContext(anchor, this.containerRect, propsMaxSize, spreadsheetRect);
-              const style = popoverPositionHelper.getCss(elDims, this.props.verticalOffset);
+              el.style["max-height"] = popoverPositionHelper.getMaxHeight(elDims.height) + "px";
+              el.style["max-width"] = popoverPositionHelper.getMaxWidth(elDims.width) + "px";
+              // Re-compute the dimensions after setting the max-width and max-height
+              elDims = {
+                  width: el.getBoundingClientRect().width,
+                  height: el.getBoundingClientRect().height,
+              };
+              let style = popoverPositionHelper.getCss(elDims, this.props.verticalOffset);
               for (const property of Object.keys(style)) {
                   el.style[property] = style[property];
               }
@@ -6985,8 +7037,6 @@
           const shouldRenderAtRight = this.shouldRenderAtRight(elDims.width);
           verticalOffset = shouldRenderAtBottom ? verticalOffset : -verticalOffset;
           const cssProperties = {
-              "max-height": maxHeight + "px",
-              "max-width": maxWidth + "px",
               top: this.getTopCoordinate(actualHeight, shouldRenderAtBottom) -
                   this.spreadsheetOffset.y -
                   verticalOffset +
@@ -8536,7 +8586,7 @@
       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();
@@ -8580,7 +8630,7 @@
       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;
@@ -8823,7 +8873,7 @@
       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;
       }
@@ -9157,7 +9207,7 @@
       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;
@@ -9477,7 +9527,7 @@
       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;
@@ -21724,7 +21774,7 @@
           }
           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;
@@ -24945,13 +24995,17 @@
   class SelectMenu extends owl.Component {
       static template = "o-spreadsheet-SelectMenu";
       static components = { Menu };
+      menuId = new UuidGenerator().uuidv4();
       selectRef = owl.useRef("select");
       selectRect = useAbsoluteBoundingRect(this.selectRef);
       state = owl.useState({
           isMenuOpen: false,
       });
-      onClick() {
-          this.state.isMenuOpen = true;
+      onClick(ev) {
+          if (ev.closedMenuId === this.menuId) {
+              return;
+          }
+          this.state.isMenuOpen = !this.state.isMenuOpen;
       }
       onMenuClosed() {
           this.state.isMenuOpen = false;
@@ -24959,7 +25013,7 @@
       get menuPosition() {
           return {
               x: this.selectRect.x,
-              y: this.selectRect.y,
+              y: this.selectRect.y + this.selectRect.height,
           };
       }
   }
@@ -25766,14 +25820,14 @@
       }
       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;
@@ -25794,7 +25848,22 @@
                       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;
@@ -26814,8 +26883,15 @@
       }
       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
@@ -26824,10 +26900,6 @@
           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") {
@@ -27275,10 +27347,7 @@
       }
       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();
@@ -27975,7 +28044,7 @@
           });
       }
       getContainerRect(container) {
-          const { width: viewWidth, height: viewHeight } = this.env.model.getters.getMainViewportRect();
+          const { width: viewWidth, height: viewHeight } = this.env.model.getters.getSheetViewDimension();
           const { x: viewportX, y: viewportY } = this.env.model.getters.getMainViewportCoordinates();
           const x = ["bottomRight", "topRight"].includes(container) ? viewportX : 0;
           const width = viewWidth - x;
@@ -38571,6 +38640,9 @@
           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;
           }
@@ -42022,16 +42094,22 @@
               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)
@@ -44291,7 +44369,10 @@
       /**
        * Notify the server that the user client left the collaborative session
        */
-      leave() {
+      leave(data) {
+          if (Object.keys(this.clients).length === 1 && this.processedRevisions.size) {
+              this.snapshot(data);
+          }
           delete this.clients[this.clientId];
           this.transportService.leave(this.clientId);
           this.transportService.sendMessage({
@@ -44304,6 +44385,9 @@
        * Send a snapshot of the spreadsheet to the collaboration server
        */
       snapshot(data) {
+          if (this.pendingMessages.length !== 0) {
+              return;
+          }
           const snapshotId = this.uuidGenerator.uuidv4();
           this.transportService.sendMessage({
               type: "SNAPSHOT",
@@ -49084,10 +49168,8 @@
               const refRange = this.getters.getRangeFromSheetXC(activeSheetId, xc);
               return isEqual(this.getters.expandZone(activeSheetId, refRange.zone), oldZone);
           });
-          // this function assumes that the previous range is always found because
-          // it's called when changing a highlight, which exists by definition
           if (!previousRefToken) {
-              throw new Error("Previous range not found");
+              return;
           }
           const previousRange = this.getters.getRangeFromSheetXC(activeSheetId, previousRefToken.value);
           this.selectionStart = previousRefToken.start;
@@ -51643,12 +51725,14 @@
           if (ev.key === "Enter") {
               ev.preventDefault();
               this.stopEdition();
+              this.env.focusableElement.focus();
           }
           if (ev.key === "Escape") {
               this.cancelEdition();
+              this.env.focusableElement.focus();
           }
       }
-      onClickSheetName(ev) {
+      onMouseEventSheetName(ev) {
           if (this.state.isEditing)
               ev.stopPropagation();
       }
@@ -56394,7 +56478,11 @@
                   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);
@@ -56837,6 +56925,7 @@
       coreHandlers = [];
       constructor(data = {}, config = {}, stateUpdateMessages = [], uuidGenerator = new UuidGenerator(), verboseImport = true) {
           super();
+          setDefaultTranslationMethod();
           stateUpdateMessages = repairInitialMessages(data, stateUpdateMessages);
           const workbookData = load(data, verboseImport);
           this.state = new StateObserver();
@@ -56912,7 +57001,7 @@
           this.session.join(this.config.client);
       }
       leaveSession() {
-          this.session.leave();
+          this.session.leave(this.exportData());
       }
       setupUiPlugin(Plugin) {
           const plugin = new Plugin(this.uiPluginConfig);
@@ -57336,6 +57425,7 @@
       createAction,
       createActions,
       transformRangeData,
+      deepEquals,
   };
   const links = {
       isMarkdownLink,
@@ -57414,9 +57504,9 @@
   exports.tokenize = tokenize;
 
 
-  __info__.version = "17.0.23";
-  __info__.date = "2024-05-24T11:27:27.416Z";
-  __info__.hash = "6c10fec";
+  __info__.version = "17.0.27";
+  __info__.date = "2024-07-02T09:01:48.383Z";
+  __info__.hash = "c1c2d01";
 
 
 })(this.o_spreadsheet = this.o_spreadsheet || {}, owl);