@odoo/o-spreadsheet 17.0.8 → 17.0.10

package/dist/o-spreadsheet.esm.js

@@ -2,9 +2,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.0.8
- * @date 2024-01-17T10:27:32.736Z
- * @hash 0f2d46e
+ * @version 17.0.10
+ * @date 2024-02-02T13:48:28.727Z
+ * @hash be06aa9
  */
 
 import { Component, useRef, onMounted, useEffect, onWillPatch, useState, onWillUpdateProps, onPatched, useComponent, useExternalListener, onWillUnmount, onWillStart, xml, useChildSubEnv, useSubEnv, markRaw } from '@odoo/owl';
@@ -2120,6 +2120,7 @@ var CommandResult;
     CommandResult["BlockingValidationRule"] = "BlockingValidationRule";
     CommandResult["InvalidCopyPasteSelection"] = "InvalidCopyPasteSelection";
     CommandResult["NoChanges"] = "NoChanges";
+    CommandResult["InvalidInputId"] = "InvalidInputId";
 })(CommandResult || (CommandResult = {}));
 
 const DEFAULT_LOCALES = [
@@ -3264,27 +3265,30 @@ function roundFormat(format) {
 }
 function createLargeNumberFormat(format, magnitude, postFix, locale) {
     const internalFormat = parseFormat(format || "#,##0");
-    const largeNumberFormat = internalFormat
-        .map((formatPart) => {
-        if (formatPart.type === "NUMBER") {
-            return [
-                {
-                    ...formatPart,
-                    format: {
-                        ...formatPart.format,
-                        magnitude,
-                        decimalPart: undefined,
-                    },
-                },
-                {
-                    type: "STRING",
-                    format: postFix,
-                },
-            ];
+    const largeNumberFormat = [];
+    for (let i = 0; i < internalFormat.length; i++) {
+        const formatPart = internalFormat[i];
+        if (formatPart.type !== "NUMBER") {
+            largeNumberFormat.push(formatPart);
+            continue;
         }
-        return formatPart;
-    })
-        .flat();
+        largeNumberFormat.push({
+            ...formatPart,
+            format: {
+                ...formatPart.format,
+                magnitude,
+                decimalPart: undefined,
+            },
+        });
+        largeNumberFormat.push({
+            type: "STRING",
+            format: postFix,
+        });
+        const nextFormatPart = internalFormat[i + 1];
+        if (nextFormatPart?.type === "STRING" && ["k", "m", "b"].includes(nextFormatPart.format)) {
+            i++;
+        }
+    }
     return convertInternalFormatToFormat(largeNumberFormat);
 }
 function changeDecimalPlaces(format, step, locale) {
@@ -4928,14 +4932,8 @@ function createDataSets(getters, dataSetsString, sheetId, dataSetsHaveTitle) {
                     : undefined));
             }
         }
-        else if (zone.left === zone.right && zone.top === zone.bottom) {
-            // A single cell. If it's only the title, the dataset is not added.
-            if (!dataSetsHaveTitle) {
-                dataSets.push(createDataSet(getters, dataSetSheetId, zone, undefined));
-            }
-        }
         else {
-            /* 1 row or 1 column */
+            /* 1 cell, 1 row or 1 column */
             dataSets.push(createDataSet(getters, dataSetSheetId, zone, dataSetsHaveTitle
                 ? {
                     top: zone.top,
@@ -4984,8 +4982,10 @@ function toExcelDataset(getters, ds) {
     }
     const dataRange = ds.dataRange.clone({ zone: dataZone });
     return {
-        label: ds.labelCell ? getters.getRangeString(ds.labelCell, "forceSheetReference") : undefined,
-        range: getters.getRangeString(dataRange, "forceSheetReference"),
+        label: ds.labelCell
+            ? getters.getRangeString(ds.labelCell, "forceSheetReference", { useFixedReference: true })
+            : undefined,
+        range: getters.getRangeString(dataRange, "forceSheetReference", { useFixedReference: true }),
     };
 }
 function toExcelLabelRange(getters, labelRange, shouldRemoveFirstLabel) {
@@ -4998,7 +4998,7 @@ function toExcelLabelRange(getters, labelRange, shouldRemoveFirstLabel) {
         zone.top = zone.top + 1;
     }
     const range = labelRange.clone({ zone });
-    return getters.getRangeString(range, "forceSheetReference");
+    return getters.getRangeString(range, "forceSheetReference", { useFixedReference: true });
 }
 /**
  * Transform a chart definition which supports dataSets (dataSets and LabelRange)
@@ -8588,7 +8588,7 @@ class BarChart extends AbstractChart {
             return undefined;
         const dataSets = this.dataSets
             .map((ds) => toExcelDataset(this.getters, ds))
-            .filter((ds) => ds.range !== ""); // && range !== INCORRECT_RANGE_STRING ? show incorrect #ref ?
+            .filter((ds) => ds.range !== "" && ds.range !== INCORRECT_RANGE_STRING);
         const labelRange = toExcelLabelRange(this.getters, this.labelRange, shouldRemoveFirstLabel(this.labelRange, this.dataSets[0], this.dataSetsHaveTitle));
         return {
             ...this.getDefinition(),
@@ -9166,7 +9166,7 @@ class LineChart extends AbstractChart {
             return undefined;
         const dataSets = this.dataSets
             .map((ds) => toExcelDataset(this.getters, ds))
-            .filter((ds) => ds.range !== ""); // && range !== INCORRECT_RANGE_STRING ? show incorrect #ref ?
+            .filter((ds) => ds.range !== "" && ds.range !== INCORRECT_RANGE_STRING);
         const labelRange = toExcelLabelRange(this.getters, this.labelRange, shouldRemoveFirstLabel(this.labelRange, this.dataSets[0], this.dataSetsHaveTitle));
         return {
             ...this.getDefinition(),
@@ -9472,7 +9472,7 @@ class PieChart extends AbstractChart {
             return undefined;
         const dataSets = this.dataSets
             .map((ds) => toExcelDataset(this.getters, ds))
-            .filter((ds) => ds.range !== ""); // && range !== INCORRECT_RANGE_STRING ? show incorrect #ref ?
+            .filter((ds) => ds.range !== "" && ds.range !== INCORRECT_RANGE_STRING);
         const labelRange = toExcelLabelRange(this.getters, this.labelRange, shouldRemoveFirstLabel(this.labelRange, this.dataSets[0], this.dataSetsHaveTitle));
         return {
             ...this.getDefinition(),
@@ -19915,19 +19915,20 @@ const formatNumberPercent = createFormatActionSpec({
 const formatNumberCurrency = createFormatActionSpec({
     name: _t("Currency"),
     descriptionValue: 1000.12,
-    format: (env) => env.model.config.defaultCurrencyFormat,
+    format: (env) => env.model.config.defaultCurrencyFormat ?? DEFAULT_CURRENCY_FORMAT,
 });
 const formatNumberCurrencyRounded = {
     ...createFormatActionSpec({
         name: _t("Currency rounded"),
         descriptionValue: 1000,
-        format: (env) => roundFormat(env.model.config.defaultCurrencyFormat),
+        format: (env) => roundFormat(env.model.config.defaultCurrencyFormat ?? DEFAULT_CURRENCY_FORMAT),
     }),
     isVisible: (env) => {
         const currencyFormat = env.model.config.defaultCurrencyFormat;
-        return currencyFormat !== roundFormat(currencyFormat);
+        return currencyFormat !== roundFormat(currencyFormat ?? DEFAULT_CURRENCY_FORMAT);
     },
 };
+const DEFAULT_CURRENCY_FORMAT = "[$$]#,##0.00";
 const EXAMPLE_DATE = parseLiteral("2023/09/26 10:43:00 PM", DEFAULT_LOCALE);
 const formatCustomCurrency = {
     name: _t("Custom currency"),
@@ -26806,6 +26807,9 @@ class Composer extends Component {
             const token = tokens.filter((token) => token.value.includes(currentSelectedText) &&
                 token.start <= currentSelection.start &&
                 token.end >= currentSelection.end)[0];
+            if (!token) {
+                return;
+            }
             if (token.type === "REFERENCE") {
                 this.env.model.dispatch("CHANGE_COMPOSER_CURSOR_SELECTION", {
                     start: token.start,
@@ -29344,6 +29348,7 @@ const registries$1 = {
     GROUP_HEADERS: groupHeadersMenuRegistry,
     UNGROUP_HEADERS: unGroupHeadersMenuRegistry,
 };
+const MODIFIER_KEYS = ["Shift", "Control", "Alt", "Meta"];
 // -----------------------------------------------------------------------------
 // JS
 // -----------------------------------------------------------------------------
@@ -29716,16 +29721,15 @@ class Grid extends Component {
         }
     }
     onKeydown(ev) {
-        const eventKey = ev.key.toUpperCase();
         let keyDownString = "";
-        if (isCtrlKey(ev) && eventKey !== "CTRL")
-            keyDownString += "CTRL+";
-        if (ev.metaKey)
-            keyDownString += "CTRL+";
-        if (ev.altKey && eventKey !== "ALT")
-            keyDownString += "ALT+";
-        if (ev.shiftKey && eventKey !== "SHIFT")
-            keyDownString += "SHIFT+";
+        if (!MODIFIER_KEYS.includes(ev.key)) {
+            if (isCtrlKey(ev))
+                keyDownString += "CTRL+";
+            if (ev.altKey)
+                keyDownString += "ALT+";
+            if (ev.shiftKey)
+                keyDownString += "SHIFT+";
+        }
         keyDownString += ev.key.toUpperCase();
         let handler = this.keyDownMapping[keyDownString];
         if (handler) {
@@ -35563,6 +35567,9 @@ class CellPlugin extends CorePlugin {
                     format: cell.format ? getItemId(cell.format, formats) : undefined,
                     content: cell.content || undefined,
                 };
+                if (cell instanceof FormulaCellWithDependencies) {
+                    cells[xc].content = cell.contentWithFixedReferences || undefined;
+                }
             }
             _sheet.cells = cells;
         }
@@ -35606,13 +35613,13 @@ class CellPlugin extends CorePlugin {
     /*
      * Reconstructs the original formula string based on a normalized form and its dependencies
      */
-    getFormulaCellContent(sheetId, compiledFormula, dependencies) {
+    getFormulaCellContent(sheetId, compiledFormula, dependencies, useFixedReference = false) {
         const ranges = dependencies || compiledFormula.dependencies;
         let rangeIndex = 0;
         return concat(compiledFormula.tokens.map((token) => {
             if (token.type === "REFERENCE") {
                 const range = ranges[rangeIndex++];
-                return this.getters.getRangeString(range, sheetId);
+                return this.getters.getRangeString(range, sheetId, { useFixedReference });
             }
             return token.value;
         }));
@@ -35881,6 +35888,18 @@ class FormulaCellWithDependencies {
     get content() {
         return concat(this.compiledFormula.tokens.map((token) => token.value));
     }
+    get contentWithFixedReferences() {
+        let rangeIndex = 0;
+        return concat(this.compiledFormula.tokens.map((token) => {
+            if (token.type === "REFERENCE") {
+                const index = rangeIndex++;
+                return this.getRangeString(this.compiledFormula.dependencies[index], this.sheetId, {
+                    useFixedReference: true,
+                });
+            }
+            return token.value;
+        }));
+    }
 }
 class RangeReferenceToken {
     getValue;
@@ -36185,7 +36204,13 @@ class ConditionalFormatPlugin extends CorePlugin {
         }
     }
     exportForExcel(data) {
-        this.export(data);
+        if (data.sheets) {
+            for (let sheet of data.sheets) {
+                if (this.cfRules[sheet.id]) {
+                    sheet.conditionalFormats = this.cfRules[sheet.id].map((rule) => this.mapToConditionalFormat(sheet.id, rule, { useFixedReference: true }));
+                }
+            }
+        }
     }
     // ---------------------------------------------------------------------------
     // Getters
@@ -36250,11 +36275,11 @@ class ConditionalFormatPlugin extends CorePlugin {
     // ---------------------------------------------------------------------------
     // Private
     // ---------------------------------------------------------------------------
-    mapToConditionalFormat(sheetId, cf) {
+    mapToConditionalFormat(sheetId, cf, { useFixedReference } = { useFixedReference: false }) {
         return {
             ...cf,
             ranges: cf.ranges.map((range) => {
-                return this.getters.getRangeString(range, sheetId);
+                return this.getters.getRangeString(range, sheetId, { useFixedReference });
             }),
         };
     }
@@ -38322,8 +38347,10 @@ class RangeAdapter {
      *
      * @param range the range (received from getRangeFromXC or getRangeFromZone)
      * @param forSheetId the id of the sheet where the range string is supposed to be used.
+     * @param options
+     * @param options.useFixedReference if true, the range will be returned with fixed row and column
      */
-    getRangeString(range, forSheetId) {
+    getRangeString(range, forSheetId, options = { useFixedReference: false }) {
         if (!range) {
             return INCORRECT_RANGE_STRING;
         }
@@ -38350,7 +38377,7 @@ class RangeAdapter {
         if (prefixSheet && !sheetName) {
             return INCORRECT_RANGE_STRING;
         }
-        let rangeString = this.getRangePartString(rangeImpl, 0);
+        let rangeString = this.getRangePartString(rangeImpl, 0, options);
         if (rangeImpl.parts && rangeImpl.parts.length === 2) {
             // this if converts A2:A2 into A2 except if any part of the original range had fixed row or column (with $)
             if (rangeImpl.zone.top !== rangeImpl.zone.bottom ||
@@ -38360,7 +38387,7 @@ class RangeAdapter {
                 rangeImpl.parts[1].rowFixed ||
                 rangeImpl.parts[1].colFixed) {
                 rangeString += ":";
-                rangeString += this.getRangePartString(rangeImpl, 1);
+                rangeString += this.getRangePartString(rangeImpl, 1, options);
             }
         }
         return `${prefixSheet ? sheetName + "!" : ""}${rangeString}`;
@@ -38401,13 +38428,13 @@ class RangeAdapter {
     /**
      * Get a Xc string that represent a part of a range
      */
-    getRangePartString(range, part) {
+    getRangePartString(range, part, options = { useFixedReference: false }) {
         const colFixed = range.parts && range.parts[part]?.colFixed ? "$" : "";
         const col = part === 0 ? numberToLetters(range.zone.left) : numberToLetters(range.zone.right);
         const rowFixed = range.parts && range.parts[part]?.rowFixed ? "$" : "";
         const row = part === 0 ? String(range.zone.top + 1) : String(range.zone.bottom + 1);
         let str = "";
-        if (range.isFullCol) {
+        if (range.isFullCol && !options.useFixedReference) {
             if (part === 0 && range.unboundedZone.hasHeader) {
                 str = colFixed + col + rowFixed + row;
             }
@@ -38415,7 +38442,7 @@ class RangeAdapter {
                 str = colFixed + col;
             }
         }
-        else if (range.isFullRow) {
+        else if (range.isFullRow && !options.useFixedReference) {
             if (part === 0 && range.unboundedZone.hasHeader) {
                 str = colFixed + col + rowFixed + row;
             }
@@ -39836,22 +39863,17 @@ class CompilationParametersBuilder {
      *        The `compute` of the formula's function must process it completely
      */
     refFn(range, isMeta, functionName, paramNumber) {
+        this.assertRangeValid(range);
         if (isMeta) {
             // Use zoneToXc of zone instead of getRangeString to avoid sending unbounded ranges
             return { value: zoneToXc(range.zone) };
         }
-        if (!isZoneValid(range.zone)) {
-            throw new InvalidReferenceError();
-        }
         // if the formula definition could have accepted a range, we would pass through the _range function and not here
         if (range.zone.bottom !== range.zone.top || range.zone.left !== range.zone.right) {
             throw new Error(paramNumber
                 ? _t("Function %s expects the parameter %s to be a single value or a single cell reference, not a range.", functionName.toString(), paramNumber.toString())
                 : _t("Function %s expects its parameters to be single values or single cell references, not ranges.", functionName.toString()));
         }
-        if (range.invalidSheetName) {
-            throw new Error(_t("Invalid sheet name: %s", range.invalidSheetName));
-        }
         const position = { sheetId: range.sheetId, col: range.zone.left, row: range.zone.top };
         return this.readCell(position);
     }
@@ -39886,10 +39908,10 @@ class CompilationParametersBuilder {
      * Note that each col is possibly sparse: it only contain the values of cells
      * that are actually present in the grid.
      */
-    range({ sheetId, zone }) {
-        if (!isZoneValid(zone)) {
-            throw new InvalidReferenceError();
-        }
+    range(range) {
+        this.assertRangeValid(range);
+        const sheetId = range.sheetId;
+        const zone = range.zone;
         // Performance issue: Avoid fetching data on positions that are out of the spreadsheet
         // e.g. A1:ZZZ9999 in a sheet with 10 cols and 10 rows should ignore everything past J10 and return a 10x10 array
         const sheetZone = this.getters.getSheetZone(sheetId);
@@ -39926,6 +39948,14 @@ class CompilationParametersBuilder {
         this.rangeCache[cacheKey] = matrix;
         return matrix;
     }
+    assertRangeValid(range) {
+        if (!isZoneValid(range.zone)) {
+            throw new InvalidReferenceError();
+        }
+        if (range.invalidSheetName) {
+            throw new Error(_t("Invalid sheet name: %s", range.invalidSheetName));
+        }
+    }
 }
 
 function quickselect(arr, k, left, right, compare) {
@@ -45998,27 +46028,6 @@ class SelectionInputPlugin extends UIPlugin {
     // ---------------------------------------------------------------------------
     // Command Handling
     // ---------------------------------------------------------------------------
-    allowDispatch(cmd) {
-        switch (cmd.type) {
-            case "ADD_RANGE":
-            case "ADD_EMPTY_RANGE":
-                if (this.inputHasSingleRange && this.ranges.length === 1) {
-                    return "MaximumRangesReached" /* CommandResult.MaximumRangesReached */;
-                }
-                break;
-            case "REMOVE_RANGE":
-                if (this.ranges.length === 1) {
-                    return "MinimumRangesReached" /* CommandResult.MinimumRangesReached */;
-                }
-                break;
-            case "CHANGE_RANGE":
-                if (this.inputHasSingleRange && cmd.value.split(",").length > 1) {
-                    return "MaximumRangesReached" /* CommandResult.MaximumRangesReached */;
-                }
-                break;
-        }
-        return "Success" /* CommandResult.Success */;
-    }
     handleEvent(event) {
         if (this.focusedRangeIndex === null) {
             return;
@@ -46256,6 +46265,15 @@ class SelectionInputsManagerPlugin extends UIPlugin {
     // Command Handling
     // ---------------------------------------------------------------------------
     allowDispatch(cmd) {
+        switch (cmd.type) {
+            case "FOCUS_RANGE":
+            case "CHANGE_RANGE":
+            case "ADD_EMPTY_RANGE":
+            case "REMOVE_RANGE":
+                if (!this.inputs[cmd.id]) {
+                    return "InvalidInputId" /* CommandResult.InvalidInputId */;
+                }
+        }
         switch (cmd.type) {
             case "FOCUS_RANGE":
                 const index = this.currentInput?.getIndex(cmd.rangeId);
@@ -46263,9 +46281,25 @@ class SelectionInputsManagerPlugin extends UIPlugin {
                     return "InputAlreadyFocused" /* CommandResult.InputAlreadyFocused */;
                 }
                 break;
-        }
-        if (this.currentInput) {
-            return this.currentInput.allowDispatch(cmd);
+            case "ADD_RANGE":
+            case "ADD_EMPTY_RANGE":
+                const input = this.inputs[cmd.id];
+                if (input.inputHasSingleRange && input.ranges.length === 1) {
+                    return "MaximumRangesReached" /* CommandResult.MaximumRangesReached */;
+                }
+                break;
+            case "REMOVE_RANGE":
+                if (this.inputs[cmd.id].ranges.length === 1) {
+                    return "MinimumRangesReached" /* CommandResult.MinimumRangesReached */;
+                }
+                break;
+            case "CHANGE_RANGE": {
+                const input = this.inputs[cmd.id];
+                if (input.inputHasSingleRange && cmd.value.split(",").length > 1) {
+                    return "MaximumRangesReached" /* CommandResult.MaximumRangesReached */;
+                }
+                break;
+            }
         }
         return "Success" /* CommandResult.Success */;
     }
@@ -48574,9 +48608,10 @@ class EditionPlugin extends UIPlugin {
      */
     getReferencedRanges() {
         const editionSheetId = this.getters.getCurrentEditedCell().sheetId;
-        return this.currentTokens
+        const referenceRanges = this.currentTokens
             .filter((token) => token.type === "REFERENCE")
             .map((token) => this.getters.getRangeFromSheetXC(editionSheetId, token.value));
+        return referenceRanges.filter((range) => !range.invalidSheetName && !range.invalidXc);
     }
     getAutoCompleteDataValidationValues() {
         if (this.mode === "inactive") {
@@ -54934,12 +54969,7 @@ function addFormula(cell) {
         attrs.push(["t", "str"]);
         cycle = escapeXml /*xml*/ `<v>${cell.value}</v>`;
     }
-    node = escapeXml /*xml*/ `
-      <f>
-        ${XlsxFormula}
-      </f>
-      ${cycle}
-    `;
+    node = escapeXml /*xml*/ `<f>${XlsxFormula}</f>${cycle}`;
     return { attrs, node };
 }
 function addContent(content, sharedStrings, forceString = false) {
@@ -55758,11 +55788,10 @@ function addRows(construct, data, sheet) {
                     ({ attrs: additionalAttrs, node: cellNode } = addContent(cell.content, construct.sharedStrings, isTableHeader));
                 }
                 attributes.push(...additionalAttrs);
-                cellNodes.push(escapeXml /*xml*/ `
-          <c ${formatAttributes(attributes)}>
-            ${cellNode}
-          </c>
-        `);
+                // prettier-ignore
+                cellNodes.push(escapeXml /*xml*/ `<c ${formatAttributes(attributes)}>
+  ${cellNode}
+</c>`);
             }
         }
         if (cellNodes.length || row.size !== DEFAULT_CELL_HEIGHT || row.isHidden) {
@@ -56358,7 +56387,6 @@ class Model extends EventBus {
             ...config,
             mode: config.mode || "normal",
             custom: config.custom || {},
-            defaultCurrencyFormat: config.defaultCurrencyFormat || "[$$]#,##0.00",
             external: this.setupExternalConfig(config.external || {}),
             transportService,
             client,
@@ -56396,6 +56424,7 @@ class Model extends EventBus {
             custom: this.config.custom,
             uiActions: this.config,
             session: this.session,
+            defaultCurrencyFormat: this.config.defaultCurrencyFormat,
         };
     }
     // ---------------------------------------------------------------------------
@@ -56733,6 +56762,6 @@ const constants = {
 export { AbstractChart, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, tokenize };
 
 
-__info__.version = "17.0.8";
-__info__.date = "2024-01-17T10:27:32.736Z";
-__info__.hash = "0f2d46e";
+__info__.version = "17.0.10";
+__info__.date = "2024-02-02T13:48:28.727Z";
+__info__.hash = "be06aa9";