@odoo/o-spreadsheet 17.3.2 → 17.3.4

package/dist/o-spreadsheet.esm.js

@@ -3,9 +3,9 @@
 /**
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
- * @version 17.3.2
- * @date 2024-06-10T09:38:56.657Z
- * @hash c3b358f
+ * @version 17.3.4
+ * @date 2024-06-21T20:00:08.515Z
+ * @hash 6efbf3b
  */
 
 import { useEnv, useSubEnv, onWillUnmount, useComponent, status, Component, useRef, onMounted, useEffect, useState, onPatched, onWillPatch, onWillUpdateProps, useExternalListener, onWillStart, xml, useChildSubEnv, markRaw, toRaw } from '@odoo/owl';
@@ -2779,7 +2779,7 @@ function evaluatePredicate(value, criterion) {
         return false;
     }
     if (typeof operand === "number" && operator === "=") {
-        return toString(value) === toString(operand);
+        return value.toString() === operand.toString();
     }
     if (operator === "<>" || operator === "=") {
         let result;
@@ -2839,14 +2839,13 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
     if (countArg % 2 === 1) {
         throw new EvaluationError(_t("Function [[FUNCTION_NAME]] expects criteria_range and criterion to be in pairs."));
     }
-    const dimRow = args[0].length;
-    const dimCol = args[0][0].length;
+    const firstArg = toMatrix(args[0]);
+    const dimRow = firstArg.length;
+    const dimCol = firstArg[0].length;
     let predicates = [];
     for (let i = 0; i < countArg - 1; i += 2) {
-        const criteriaRange = args[i];
-        if (!isMatrix(criteriaRange) ||
-            criteriaRange.length !== dimRow ||
-            criteriaRange[0].length !== dimCol) {
+        const criteriaRange = toMatrix(args[i]);
+        if (criteriaRange.length !== dimRow || criteriaRange[0].length !== dimCol) {
             throw new EvaluationError(_t("Function [[FUNCTION_NAME]] expects criteria_range to have the same dimension"));
         }
         const description = toString(args[i + 1]);
@@ -2860,7 +2859,7 @@ function visitMatchingRanges(args, cb, locale, isQuery = false) {
         for (let j = 0; j < dimCol; j++) {
             let validatedPredicates = true;
             for (let k = 0; k < countArg - 1; k += 2) {
-                const criteriaValue = args[k][i][j].value;
+                const criteriaValue = toMatrix(args[k])[i][j].value;
                 const criterion = predicates[k / 2];
                 validatedPredicates = evaluatePredicate(criteriaValue ?? undefined, criterion);
                 if (!validatedPredicates) {
@@ -9460,10 +9459,8 @@ class ComposerStore extends SpreadsheetStore {
             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;
@@ -10988,6 +10985,9 @@ function makeArg(str, description) {
     if (types.some((t) => t.startsWith("RANGE"))) {
         result.acceptMatrix = true;
     }
+    if (types.every((t) => t.startsWith("RANGE"))) {
+        result.acceptMatrixOnly = true;
+    }
     return result;
 }
 /**
@@ -11269,11 +11269,16 @@ const CHOOSECOLS = {
     compute: function (array, ...columns) {
         const _array = toMatrix(array);
         const _columns = flattenRowFirst(columns, (item) => toInteger(item?.value, this.locale));
-        assert(() => _columns.every((col) => col > 0 && col <= _array.length), _t("The columns arguments must be between 1 and %s (got %s).", _array.length.toString(), (_columns.find((col) => col <= 0 || col > _array.length) || 0).toString()));
+        const argOutOfRange = _columns.filter((col) => col === 0 || _array.length < Math.abs(col));
+        assert(() => argOutOfRange.length === 0, _t("The columns arguments must be between -%s and %s (got %s), excluding 0.", _array.length.toString(), _array.length.toString(), argOutOfRange.join(",")));
         const result = Array(_columns.length);
         for (let col = 0; col < _columns.length; col++) {
-            const colIndex = _columns[col] - 1; // -1 because columns arguments are 1-indexed
-            result[col] = _array[colIndex];
+            if (_columns[col] > 0) {
+                result[col] = _array[_columns[col] - 1]; // -1 because columns arguments are 1-indexed
+            }
+            else {
+                result[col] = _array[_array.length + _columns[col]];
+            }
         }
         return result;
     },
@@ -11294,8 +11299,14 @@ const CHOOSEROWS = {
         const _array = toMatrix(array);
         const _rows = flattenRowFirst(rows, (item) => toInteger(item?.value, this.locale));
         const _nbColumns = _array.length;
-        assert(() => _rows.every((row) => row > 0 && row <= _array[0].length), _t("The rows arguments must be between 1 and %s (got %s).", _array[0].length.toString(), (_rows.find((row) => row <= 0 || row > _array[0].length) || 0).toString()));
-        return generateMatrix(_nbColumns, _rows.length, (col, row) => _array[col][_rows[row] - 1]); // -1 because rows arguments are 1-indexed
+        const argOutOfRange = _rows.filter((row) => row === 0 || _array[0].length < Math.abs(row));
+        assert(() => argOutOfRange.length === 0, _t("The rows arguments must be between -%s and %s (got %s), excluding 0.", _array[0].length.toString(), _array[0].length.toString(), argOutOfRange.join(",")));
+        return generateMatrix(_nbColumns, _rows.length, (col, row) => {
+            if (_rows[row] > 0) {
+                return _array[col][_rows[row] - 1]; // -1 because columns arguments are 1-indexed
+            }
+            return _array[col][_array[col].length + _rows[row]];
+        });
     },
     isExported: true,
 };
@@ -19762,6 +19773,9 @@ function addInputHandling(descr) {
                 }
                 args[i] = arg[0][0];
             }
+            if (!isMatrix(arg) && argDefinition.acceptMatrixOnly) {
+                throw new BadExpressionError(_t("Function [[FUNCTION_NAME]] expects the parameter '%s' to be reference to a cell or range.", (i + 1).toString()));
+            }
         }
         return descr.compute.apply(this, args);
     }
@@ -21356,12 +21370,6 @@ function compileTokens(tokens) {
                 // detect when an argument need to be evaluated as a meta argument
                 const isMeta = argTypes.includes("META");
                 const hasRange = argTypes.some((t) => isRangeType(t));
-                const isRangeOnly = argTypes.every((t) => isRangeType(t));
-                if (isRangeOnly) {
-                    if (!isRangeInput(currentArg)) {
-                        throw new BadExpressionError(_t("Function %(function_name)s expects the parameter %(arg_index)s to be a reference to a cell or a range.", { function_name: functionName, arg_index: i + 1 }));
-                    }
-                }
                 compiledArgs.push(compileAST(currentArg, isMeta, hasRange));
             }
             return compiledArgs;
@@ -21526,16 +21534,6 @@ function assertEnoughArgs(ast) {
 function isRangeType(type) {
     return type.startsWith("RANGE");
 }
-function isRangeInput(arg) {
-    if (arg.type === "REFERENCE") {
-        return true;
-    }
-    if (arg.type === "FUNCALL") {
-        const fnDef = functions$1[arg.value.toUpperCase()];
-        return fnDef && isRangeType(fnDef.returns[0]);
-    }
-    return false;
-}
 
 const functions = functionRegistry.content;
 function isExportableToExcel(tokens) {
@@ -21964,7 +21962,9 @@ autoCompleteProviders.add("pivot_group_values", {
         if (!groupByField) {
             return;
         }
-        return dataSource.getPossibleFieldValues(groupByField.split(":")[0]).map(({ value, label }) => {
+        return dataSource
+            .getPossibleFieldValues(groupByField.toString().split(":")[0])
+            .map(({ value, label }) => {
             const isString = typeof value === "string";
             const text = isString ? `"${value}"` : value.toString();
             const color = isString ? tokenColors.STRING : tokenColors.NUMBER;
@@ -25450,7 +25450,7 @@ class Popover extends Component {
             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,
             };
@@ -25458,7 +25458,14 @@ class Popover extends Component {
             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];
             }
@@ -25521,8 +25528,6 @@ class PopoverPositionContext {
         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 +
@@ -31336,10 +31341,8 @@ class ChartTitle extends Component {
 
 class AxisDesignEditor extends Component {
     static template = "o-spreadsheet-AxisDesignEditor";
-    static components = {
-        Section,
-        ChartTitle,
-    };
+    static components = { Section, ChartTitle };
+    static props = { figureId: String, definition: Object, updateChart: Function, axesList: Array };
     state = useState({ currentAxis: "x" });
     get axisTitleStyle() {
         const axisDesign = this.props.definition.axesDesign?.[this.state.currentAxis] ?? {};
@@ -31490,6 +31493,12 @@ class ChartWithAxisDesignPanel extends Component {
         AxisDesignEditor,
         RoundColorPicker,
     };
+    static props = {
+        figureId: String,
+        definition: Object,
+        canUpdateChart: Function,
+        updateChart: Function,
+    };
     state = useState({ index: 0 });
     get axesList() {
         const { useLeftAxis, useRightAxis } = getDefinedAxis(this.props.definition);
@@ -31671,14 +31680,6 @@ class GaugeChartDesignPanel extends Component {
         const cancelledReasons = [...(this.state.sectionRuleDispatchResult?.reasons || [])];
         return cancelledReasons.map((error) => ChartTerms.Errors[error] || ChartTerms.Errors.Unexpected);
     }
-    updateBackgroundColor(color) {
-        this.props.updateChart(this.props.figureId, {
-            background: color,
-        });
-    }
-    updateTitle(content) {
-        this.props.updateChart(this.props.figureId, { title: { text: content } });
-    }
     isRangeMinInvalid() {
         return !!(this.state.sectionRuleDispatchResult?.isCancelledBecause("EmptyGaugeRangeMin" /* CommandResult.EmptyGaugeRangeMin */) ||
             this.state.sectionRuleDispatchResult?.isCancelledBecause("GaugeRangeMinNaN" /* CommandResult.GaugeRangeMinNaN */) ||
@@ -31718,9 +31719,6 @@ class GaugeChartDesignPanel extends Component {
             sectionRule,
         });
     }
-    get backgroundColorTitle() {
-        return ChartTerms.BackgroundColor;
-    }
 }
 
 class LineConfigPanel extends GenericChartConfigPanel {
@@ -31903,9 +31901,6 @@ class ScorecardChartDesignPanel extends Component {
     get humanizeNumbersLabel() {
         return _t("Humanize numbers");
     }
-    updateTitle(content) {
-        this.props.updateChart(this.props.figureId, { title: { text: content } });
-    }
     updateHumanizeNumbers(humanize) {
         this.props.updateChart(this.props.figureId, { humanize });
     }
@@ -31928,9 +31923,6 @@ class ScorecardChartDesignPanel extends Component {
                 break;
         }
     }
-    get backgroundColorTitle() {
-        return ChartTerms.BackgroundColor;
-    }
 }
 
 class WaterfallChartDesignPanel extends Component {
@@ -33431,13 +33423,17 @@ class SelectMenu extends Component {
         class: { type: String, optional: true },
     };
     static components = { Menu };
+    menuId = new UuidGenerator().uuidv4();
     selectRef = useRef("select");
     selectRect = useAbsoluteBoundingRect(this.selectRef);
     state = 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;
@@ -33445,7 +33441,7 @@ class SelectMenu extends Component {
     get menuPosition() {
         return {
             x: this.selectRect.x,
-            y: this.selectRect.y,
+            y: this.selectRect.y + this.selectRect.height,
         };
     }
 }
@@ -34385,9 +34381,9 @@ class FindAndReplacePanel extends Component {
     static props = {
         onCloseSidePanel: Function,
     };
-    dataRange = "";
     searchInput = useRef("searchInput");
     store;
+    state;
     get hasSearchResult() {
         return this.store.selectedMatchIndex !== null;
     }
@@ -34417,6 +34413,7 @@ class FindAndReplacePanel extends Component {
     }
     setup() {
         this.store = useLocalStore(FindAndReplaceStore);
+        this.state = useState({ dataRange: "" });
         onMounted(() => this.searchInput.el?.focus());
     }
     onFocusSearch() {
@@ -34453,13 +34450,13 @@ class FindAndReplacePanel extends Component {
         this.store.updateSearchOptions({ searchScope });
     }
     onSearchRangeChanged(ranges) {
-        this.dataRange = ranges[0];
+        this.state.dataRange = ranges[0];
     }
     updateDataRange() {
-        if (!this.dataRange || this.searchOptions.searchScope !== "specificRange") {
+        if (!this.state.dataRange || this.searchOptions.searchScope !== "specificRange") {
             return;
         }
-        const specificRange = this.env.model.getters.getRangeFromSheetXC(this.env.model.getters.getActiveSheetId(), this.dataRange);
+        const specificRange = this.env.model.getters.getRangeFromSheetXC(this.env.model.getters.getActiveSheetId(), this.state.dataRange);
         this.store.updateSearchOptions({ specificRange });
     }
 }
@@ -34925,7 +34922,7 @@ function createMeasure(fields, measure) {
 function createPivotDimension(fields, dimension) {
     const field = fields[dimension.name];
     const type = field?.type ?? "integer";
-    const granularity = field && isDateField(field) ? dimension.granularity ?? "month_number" : undefined;
+    const granularity = field && isDateField(field) ? dimension.granularity : undefined;
     return {
         /**
          * Get the display name of the dimension
@@ -35328,10 +35325,13 @@ function compareDimensionValues(dimension, a, b) {
 }
 
 function createDate(dimension, value, locale) {
-    const granularity = dimension.granularity || "month_number";
-    if (!(granularity in MAP_VALUE_DIMENSION_DATE)) {
+    const granularity = dimension.granularity;
+    if (!granularity || !(granularity in MAP_VALUE_DIMENSION_DATE)) {
         throw new Error(`Unknown date granularity: ${granularity}`);
     }
+    if (value === null) {
+        return null;
+    }
     if (!MAP_VALUE_DIMENSION_DATE[granularity].set.has(value)) {
         MAP_VALUE_DIMENSION_DATE[granularity].set.add(value);
         const date = toJsDate(value, locale);
@@ -35558,7 +35558,8 @@ class SpreadsheetPivot {
         if (!finalCell) {
             return { value: "" };
         }
-        if (finalCell.value === null) {
+        // Value can be null but stringified (e.g. an empty date, as for now every date is stringified)
+        if (finalCell.value === null || finalCell.value === `${null}`) {
             return { value: _t("(Undefined)") };
         }
         if (dimension.type === "date") {
@@ -35594,10 +35595,15 @@ class SpreadsheetPivot {
         if (!operator) {
             throw new Error(`Aggregator ${aggregator} does not exist`);
         }
-        return {
-            value: values.length ? operator.fn([values], this.getters.getLocale()) : "",
-            format: operator.format(values[0]),
-        };
+        try {
+            return {
+                value: values.length ? operator.fn([values], this.getters.getLocale()) : "",
+                format: operator.format(values[0]),
+            };
+        }
+        catch (e) {
+            return handleError(e, aggregator.toUpperCase());
+        }
     }
     getPossibleFieldValues(groupBy) {
         //TODO This method should be implemented for the autocomplete feature
@@ -36130,6 +36136,7 @@ css /* scss */ `
 class RemoveDuplicatesPanel extends Component {
     static template = "o-spreadsheet-RemoveDuplicatesPanel";
     static components = { ValidationMessages, Section, Checkbox };
+    static props = { onCloseSidePanel: Function };
     state = useState({
         hasHeader: false,
         columns: {},
@@ -38554,7 +38561,7 @@ class FiguresContainer extends Component {
         });
     }
     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;
@@ -51159,22 +51166,6 @@ class PivotCorePlugin extends CorePlugin {
                 this.addPivotFormula(cellPosition, formulaId, pivotCell);
             }
         }
-        const pivotZone = {
-            top: position.row,
-            bottom: position.row + pivotCells[0].length - 1,
-            left: position.col,
-            right: position.col + pivotCells.length - 1,
-        };
-        const numberOfHeaders = table.columns.length - 1;
-        const cmdContent = {
-            sheetId: position.sheetId,
-            ranges: [this.getters.getRangeDataFromZone(position.sheetId, pivotZone)],
-            config: { ...PIVOT_TABLE_CONFIG, numberOfHeaders },
-            tableType: "static",
-        };
-        if (this.canDispatch("CREATE_TABLE", cmdContent).isSuccessful) {
-            this.dispatch("CREATE_TABLE", cmdContent);
-        }
     }
     resizeSheet(sheetId, { col, row }, table) {
         const colLimit = table.getNumberOfDataColumns() + 1; // +1 for the Top-Left
@@ -52854,7 +52845,6 @@ class Evaluator {
         if (!this.blockedArrayFormulas.has(position)) {
             this.invalidateSpreading(position);
         }
-        this.spreadingRelations.removeNode(position);
         const cell = this.getters.getCell(position);
         if (cell === undefined) {
             return EMPTY_CELL;
@@ -52896,6 +52886,7 @@ class Evaluator {
         this.assertSheetHasEnoughSpaceToSpreadFormulaResult(formulaPosition, formulaReturn);
         const nbColumns = formulaReturn.length;
         const nbRows = formulaReturn[0].length;
+        this.spreadingRelations.removeNode(formulaPosition);
         forEachSpreadPositionInMatrix(nbColumns, nbRows, this.updateSpreadRelation(formulaPosition));
         this.assertNoMergedCellsInSpreadZone(formulaPosition, formulaReturn);
         forEachSpreadPositionInMatrix(nbColumns, nbRows, this.checkCollision(formulaPosition));
@@ -55900,7 +55891,10 @@ class Session extends EventBus {
     /**
      * 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({
@@ -55913,6 +55907,9 @@ class Session extends EventBus {
      * 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",
@@ -66400,7 +66397,7 @@ class Model extends EventBus {
         this.session.join(this.config.client);
     }
     leaveSession() {
-        this.session.leave();
+        this.session.leave(this.exportData());
     }
     setupUiPlugin(Plugin) {
         const plugin = new Plugin(this.uiPluginConfig);
@@ -66948,6 +66945,6 @@ const constants = {
 export { AbstractCellClipboardHandler, AbstractChart, AbstractFigureClipboardHandler, CellErrorType, CommandResult, CorePlugin, DispatchResult, EvaluationError, Model, PivotRuntimeDefinition, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, SpreadsheetPivotTable, UIPlugin, __info__, addFunction, addRenderingLayer, astToFormula, compile, compileTokens, components, constants, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, hooks, invalidateCFEvaluationCommands, invalidateDependenciesCommands, invalidateEvaluationCommands, iterateAstNodes, links, load, parse, parseTokens, readonlyAllowedCommands, registries, setDefaultSheetViewSize, setTranslationMethod, stores, tokenColors, tokenize };
 
 
-__info__.version = "17.3.2";
-__info__.date = "2024-06-10T09:38:56.657Z";
-__info__.hash = "c3b358f";
+__info__.version = "17.3.4";
+__info__.date = "2024-06-21T20:00:08.515Z";
+__info__.hash = "6efbf3b";