@odoo/o-spreadsheet 16.4.14 → 16.4.15

package/dist/o-spreadsheet.esm.js

@@ -668,8 +668,7 @@ function transpose2dArray(matrix, callback = (val) => val) {
  *
  * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Character_Classes
  */
-const whiteSpaceCharacters = [
-    " ",
+const whiteSpaceSpecialCharacters = [
     "\t",
     "\f",
     "\v",
@@ -684,8 +683,7 @@ const whiteSpaceCharacters = [
     String.fromCharCode(parseInt("3000", 16)),
     String.fromCharCode(parseInt("feff", 16)),
 ];
-const whiteSpaceRegexp = new RegExp(whiteSpaceCharacters.join("|"), "g");
-const newLineRegex = /\r\n|\r|\n/g;
+const whiteSpaceRegexp = new RegExp(whiteSpaceSpecialCharacters.join("|") + "|(\r\n|\r|\n)", "g");
 /**
  * Replace all the special spaces in a string (non-breaking, tabs, ...) by normal spaces, and all the
  * different newlines types by \n.
@@ -693,9 +691,9 @@ const newLineRegex = /\r\n|\r|\n/g;
 function replaceSpecialSpaces(text) {
     if (!text)
         return "";
-    text = text.replace(whiteSpaceRegexp, " ");
-    text = text.replace(newLineRegex, NEWLINE);
-    return text;
+    if (!whiteSpaceRegexp.test(text))
+        return text;
+    return text.replace(whiteSpaceRegexp, (match, newLine) => (newLine ? NEWLINE : " "));
 }
 /**
  * Determine if the numbers are consecutive.
@@ -4265,6 +4263,7 @@ var CommandResult;
     CommandResult[CommandResult["NoActiveSheet"] = 94] = "NoActiveSheet";
     CommandResult[CommandResult["InvalidLocale"] = 95] = "InvalidLocale";
     CommandResult[CommandResult["AlreadyInPaintingFormatMode"] = 96] = "AlreadyInPaintingFormatMode";
+    CommandResult[CommandResult["NoChanges"] = 97] = "NoChanges";
 })(CommandResult || (CommandResult = {}));
 
 const borderStyles = ["thin", "medium", "thick", "dashed", "dotted"];
@@ -4354,12 +4353,12 @@ function toString(value) {
     }
 }
 /** Normalize string by setting it to lowercase and replacing accent letters with plain letters */
-function normalizeString(str) {
+const normalizeString = memoize(function normalizeString(str) {
     return str
         .toLowerCase()
         .normalize("NFD")
         .replace(/[\u0300-\u036f]/g, "");
-}
+});
 /**
  * Normalize a value.
  * If the cell value is a string, this will set it to lowercase and replacing accent letters with plain letters
@@ -14170,7 +14169,7 @@ function tokenize(str, locale = DEFAULT_LOCALE) {
     return result;
 }
 function tokenizeDebugger(chars) {
-    if (chars.current() === "?") {
+    if (chars.current === "?") {
         chars.shift();
         return { type: "DEBUGGER", value: "?" };
     }
@@ -14181,7 +14180,7 @@ const misc = {
     ")": "RIGHT_PAREN",
 };
 function tokenizeMisc(chars) {
-    if (chars.current() in misc) {
+    if (chars.current in misc) {
         const value = chars.shift();
         const type = misc[value];
         return { type, value };
@@ -14189,7 +14188,7 @@ function tokenizeMisc(chars) {
     return null;
 }
 function tokenizeArgsSeparator(chars, locale) {
-    if (chars.current() === locale.formulaArgSeparator) {
+    if (chars.current === locale.formulaArgSeparator) {
         const value = chars.shift();
         const type = "ARG_SEPARATOR";
         return { type, value };
@@ -14214,14 +14213,13 @@ function tokenizeNumber(chars, locale) {
     return null;
 }
 function tokenizeString(chars) {
-    if (chars.current() === '"') {
+    if (chars.current === '"') {
         const startChar = chars.shift();
         let letters = startChar;
-        while (chars.current() &&
-            (chars.current() !== startChar || letters[letters.length - 1] === "\\")) {
+        while (chars.current && (chars.current !== startChar || letters[letters.length - 1] === "\\")) {
             letters += chars.shift();
         }
-        if (chars.current() === '"') {
+        if (chars.current === '"') {
             letters += chars.shift();
         }
         return {
@@ -14248,14 +14246,14 @@ function tokenizeSymbol(chars) {
     let result = "";
     // there are two main cases to manage: either something which starts with
     // a ', like 'Sheet 2'A2, or a word-like element.
-    if (chars.current() === "'") {
+    if (chars.current === "'") {
         let lastChar = chars.shift();
         result += lastChar;
-        while (chars.current()) {
+        while (chars.current) {
             lastChar = chars.shift();
             result += lastChar;
             if (lastChar === "'") {
-                if (chars.current() && chars.current() === "'") {
+                if (chars.current && chars.current === "'") {
                     lastChar = chars.shift();
                     result += lastChar;
                 }
@@ -14271,7 +14269,7 @@ function tokenizeSymbol(chars) {
             };
         }
     }
-    while (chars.current() && separatorRegexp.test(chars.current())) {
+    while (chars.current && separatorRegexp.test(chars.current)) {
         result += chars.shift();
     }
     if (result.length) {
@@ -14286,14 +14284,14 @@ function tokenizeSymbol(chars) {
 }
 function tokenizeSpace(chars) {
     let length = 0;
-    while (chars.current() === NEWLINE) {
+    while (chars.current === NEWLINE) {
         length++;
         chars.shift();
     }
     if (length) {
         return { type: "SPACE", value: NEWLINE.repeat(length) };
     }
-    while (chars.current() === " ") {
+    while (chars.current === " ") {
         length++;
         chars.shift();
     }
@@ -14312,17 +14310,20 @@ function tokenizeInvalidRange(chars) {
 class TokenizingChars {
     text;
     currentIndex = 0;
+    current;
     constructor(text) {
         this.text = text;
-    }
-    current() {
-        return this.text[this.currentIndex];
+        this.current = text[0];
     }
     shift() {
-        return this.text[this.currentIndex++];
+        const current = this.current;
+        const next = this.text[++this.currentIndex];
+        this.current = next;
+        return current;
     }
     advanceBy(length) {
         this.currentIndex += length;
+        this.current = this.text[this.currentIndex];
     }
     isOver() {
         return this.currentIndex >= this.text.length;
@@ -31166,6 +31167,14 @@ class BordersPlugin extends CorePlugin {
     // ---------------------------------------------------------------------------
     // Command Handling
     // ---------------------------------------------------------------------------
+    allowDispatch(cmd) {
+        switch (cmd.type) {
+            case "SET_BORDER":
+                return this.checkBordersUnchanged(cmd);
+            default:
+                return 0 /* CommandResult.Success */;
+        }
+    }
     handle(cmd) {
         switch (cmd.type) {
             case "ADD_MERGE":
@@ -31585,6 +31594,14 @@ class BordersPlugin extends CorePlugin {
             this.setBorders(sheetId, [{ ...zone, left: right }], "right", bordersTopLeft.right);
         }
     }
+    checkBordersUnchanged(cmd) {
+        const currentBorder = this.getCellBorder(cmd);
+        const areAllNewBordersUndefined = !cmd.border?.bottom && !cmd.border?.left && !cmd.border?.right && !cmd.border?.top;
+        if ((!currentBorder && areAllNewBordersUndefined) || deepEquals(currentBorder, cmd.border)) {
+            return 97 /* CommandResult.NoChanges */;
+        }
+        return 0 /* CommandResult.Success */;
+    }
     // ---------------------------------------------------------------------------
     // Import/Export
     // ---------------------------------------------------------------------------
@@ -31692,8 +31709,9 @@ class CellPlugin extends CorePlugin {
     allowDispatch(cmd) {
         switch (cmd.type) {
             case "UPDATE_CELL":
+                return this.checkCellOutOfSheet(cmd);
             case "CLEAR_CELL":
-                return this.checkCellOutOfSheet(cmd.sheetId, cmd.col, cmd.row);
+                return this.checkValidations(cmd, this.chainValidations(this.checkCellOutOfSheet, this.checkUselessClearCell));
             default:
                 return 0 /* CommandResult.Success */;
         }
@@ -31852,14 +31870,9 @@ class CellPlugin extends CorePlugin {
      */
     getCellById(cellId) {
         // this must be as fast as possible
-        for (const sheetId in this.cells) {
-            const sheet = this.cells[sheetId];
-            const cell = sheet[cellId];
-            if (cell) {
-                return cell;
-            }
-        }
-        return undefined;
+        const position = this.getters.getCellPosition(cellId);
+        const sheet = this.cells[position.sheetId];
+        return sheet[cellId];
     }
     /*
      * Reconstructs the original formula string based on a normalized form and its dependencies
@@ -32085,13 +32098,23 @@ class CellPlugin extends CorePlugin {
             dependencies: [],
         };
     }
-    checkCellOutOfSheet(sheetId, col, row) {
+    checkCellOutOfSheet(cmd) {
+        const { sheetId, col, row } = cmd;
         const sheet = this.getters.tryGetSheet(sheetId);
         if (!sheet)
             return 28 /* CommandResult.InvalidSheetId */;
         const sheetZone = this.getters.getSheetZone(sheetId);
         return isInside(col, row, sheetZone) ? 0 /* CommandResult.Success */ : 19 /* CommandResult.TargetOutOfSheet */;
     }
+    checkUselessClearCell(cmd) {
+        const cell = this.getters.getCell(cmd);
+        if (!cell)
+            return 97 /* CommandResult.NoChanges */;
+        if (!cell.content && !cell.style && !cell.format) {
+            return 97 /* CommandResult.NoChanges */;
+        }
+        return 0 /* CommandResult.Success */;
+    }
 }
 class FormulaCellWithDependencies {
     id;
@@ -35160,10 +35183,13 @@ class SheetPlugin extends CorePlugin {
         // begin with the end.
         rows.sort((a, b) => b - a);
         for (let group of groupConsecutive(rows)) {
+            // indexes are sorted in the descending order
+            const from = group[group.length - 1];
+            const to = group[0];
             // Move the cells.
-            this.moveCellOnRowsDeletion(sheet, group[group.length - 1], group[0]);
-            // Effectively delete the element and recompute the left-right/top-bottom.
-            group.map((row) => this.updateRowsStructureOnDeletion(row, sheet));
+            this.moveCellOnRowsDeletion(sheet, from, to);
+            // Effectively delete the rows
+            this.updateRowsStructureOnDeletion(sheet, from, to);
         }
         const count = rows.filter((row) => row < sheet.panes.ySplit).length;
         if (count) {
@@ -35185,8 +35211,6 @@ class SheetPlugin extends CorePlugin {
         this.addEmptyRows(sheet, quantity);
         // Move the cells.
         this.moveCellsOnAddition(sheet, index, quantity, "rows");
-        // Recompute the left-right/top-bottom.
-        this.updateRowsStructureOnAddition(sheet, row, quantity);
         if (index < sheet.panes.ySplit) {
             this.setPaneDivisions(sheet.id, sheet.panes.ySplit + quantity, "ROW");
         }
@@ -35287,35 +35311,20 @@ class SheetPlugin extends CorePlugin {
             }
         }
     }
-    updateRowsStructureOnDeletion(index, sheet) {
+    updateRowsStructureOnDeletion(sheet, deleteFromRow, deleteToRow) {
         const rows = [];
-        const cellsQueue = sheet.rows.map((row) => row.cells);
+        const cellsQueue = sheet.rows.map((row) => row.cells).reverse();
         for (let i in sheet.rows) {
-            if (Number(i) === index) {
+            const row = Number(i);
+            if (row >= deleteFromRow && row <= deleteToRow) {
                 continue;
             }
             rows.push({
-                cells: cellsQueue.shift(),
+                cells: cellsQueue.pop(),
             });
         }
         this.history.update("sheets", sheet.id, "rows", rows);
     }
-    /**
-     * Update the rows of the sheet after an addition:
-     * - Rename the rows
-     *
-     * @param sheet Sheet on which the deletion occurs
-     * @param addedRow Index of the added row
-     * @param rowsToAdd Number of the rows to add
-     */
-    updateRowsStructureOnAddition(sheet, addedRow, rowsToAdd) {
-        const rows = [];
-        const cellsQueue = sheet.rows.map((row) => row.cells);
-        sheet.rows.forEach(() => rows.push({
-            cells: cellsQueue.shift(),
-        }));
-        this.history.update("sheets", sheet.id, "rows", rows);
-    }
     /**
      * Add empty rows at the end of the rows
      *
@@ -35431,6 +35440,7 @@ class CompilationParametersBuilder {
     getters;
     computeCell;
     evalContext;
+    rangeCache = {};
     constructor(context, getters, computeCell) {
         this.getters = getters;
         this.computeCell = computeCell;
@@ -35516,25 +35526,32 @@ class CompilationParametersBuilder {
         if (!_zone) {
             return { value: [[]], format: [[]] };
         }
+        const { top, left, bottom, right } = zone;
+        const cacheKey = `${sheetId}-${top}-${left}-${bottom}-${right}`;
+        if (cacheKey in this.rangeCache) {
+            return this.rangeCache[cacheKey];
+        }
         const height = _zone.bottom - _zone.top + 1;
         const width = _zone.right - _zone.left + 1;
-        const value = Array.from({ length: width }, () => Array.from({ length: height }));
-        const format = Array.from({ length: width }, () => Array.from({ length: height }));
+        const value = new Array(width);
+        const format = new Array(width);
         // Performance issue: nested loop is faster than a map here
         for (let col = _zone.left; col <= _zone.right; col++) {
+            const colIndex = col - _zone.left;
+            value[colIndex] = new Array(height);
+            format[colIndex] = new Array(height);
             for (let row = _zone.top; row <= _zone.bottom; row++) {
-                const evaluatedCell = this.getEvaluatedCellIfNotEmpty({ sheetId: sheetId, col, row });
-                if (evaluatedCell) {
-                    const colIndex = col - _zone.left;
-                    const rowIndex = row - _zone.top;
-                    value[colIndex][rowIndex] = evaluatedCell.value;
-                    if (evaluatedCell.format !== undefined) {
-                        format[colIndex][rowIndex] = evaluatedCell.format;
-                    }
+                const evaluatedCell = this.getEvaluatedCellIfNotEmpty({ sheetId, col, row });
+                const rowIndex = row - _zone.top;
+                value[colIndex][rowIndex] = evaluatedCell?.value;
+                if (evaluatedCell?.format !== undefined) {
+                    format[colIndex][rowIndex] = evaluatedCell.format;
                 }
             }
         }
-        return { value, format };
+        const result = { value, format };
+        this.rangeCache[cacheKey] = result;
+        return result;
     }
 }
 
@@ -35732,6 +35749,7 @@ class Evaluator {
         this.formulaDependencies().addDependencies(positionId, dependencies);
     }
     updateCompilationParameters() {
+        // rebuild the compilation parameters (with a clean cache)
         this.compilationParams = buildCompilationParameters(this.context, this.getters, this.computeAndSave.bind(this));
     }
     evaluateCells(positions) {
@@ -35775,6 +35793,15 @@ class Evaluator {
         this.evaluatedCells = new Map();
         this.evaluate(this.getAllCells());
     }
+    evaluateFormula(sheetId, formulaString) {
+        const compiledFormula = compile(formulaString);
+        const ranges = [];
+        for (let xc of compiledFormula.dependencies) {
+            ranges.push(this.getters.getRangeFromSheetXC(sheetId, xc));
+        }
+        this.updateCompilationParameters();
+        return compiledFormula.execute(ranges, ...this.compilationParams).value;
+    }
     getAllCells() {
         const positionIds = new JetSet();
         for (const sheetId of this.getters.getSheetIds()) {
@@ -35801,6 +35828,7 @@ class Evaluator {
         this.nextPositionsToUpdate = cells;
         let currentIteration = 0;
         while (this.nextPositionsToUpdate.size && currentIteration++ < MAX_ITERATION) {
+            this.updateCompilationParameters();
             const positionIds = Array.from(this.nextPositionsToUpdate);
             this.nextPositionsToUpdate.clear();
             for (let i = 0; i < positionIds.length; ++i) {
@@ -36185,7 +36213,6 @@ class PositionBitsEncoder {
 // of other cells depending on it, at the next iteration.
 //#endregion
 class EvaluationPlugin extends UIPlugin {
-    config;
     static getters = [
         "evaluateFormula",
         "getRangeFormattedValues",
@@ -36197,12 +36224,9 @@ class EvaluationPlugin extends UIPlugin {
     ];
     shouldRebuildDependenciesGraph = true;
     evaluator;
-    compilationParams;
     positionsToUpdate = [];
     constructor(config) {
         super(config);
-        this.config = config;
-        this.compilationParams = this.getCompilationParameters();
         this.evaluator = new Evaluator(config.custom, this.getters);
     }
     // ---------------------------------------------------------------------------
@@ -36227,10 +36251,6 @@ class EvaluationPlugin extends UIPlugin {
             case "EVALUATE_CELLS":
                 this.evaluator.evaluateAllCells();
                 break;
-            case "UPDATE_LOCALE":
-                this.compilationParams = this.getCompilationParameters();
-                this.evaluator.updateCompilationParameters();
-                break;
         }
     }
     finalize() {
@@ -36248,12 +36268,7 @@ class EvaluationPlugin extends UIPlugin {
     // Getters
     // ---------------------------------------------------------------------------
     evaluateFormula(sheetId, formulaString) {
-        const compiledFormula = compile(formulaString);
-        const ranges = [];
-        for (let xc of compiledFormula.dependencies) {
-            ranges.push(this.getters.getRangeFromSheetXC(sheetId, xc));
-        }
-        return compiledFormula.execute(ranges, ...this.compilationParams).value;
+        return this.evaluator.evaluateFormula(sheetId, formulaString);
     }
     /**
      * Return the value of each cell in the range as they are displayed in the grid.
@@ -36352,9 +36367,6 @@ class EvaluationPlugin extends UIPlugin {
         }
         return undefined;
     }
-    getCompilationParameters() {
-        return buildCompilationParameters(this.config.custom, this.getters, (position) => this.evaluator.getEvaluatedCell(position));
-    }
 }
 function isBadExpression(formula) {
     try {
@@ -42071,8 +42083,8 @@ class ClipboardPlugin extends UIPlugin {
                 this.lastPasteState = this.state;
                 if (this.paintFormatStatus === "oneOff") {
                     this.paintFormatStatus = "inactive";
-                    this.status = "invisible";
                 }
+                this.status = "invisible";
                 break;
             case "CLEAN_CLIPBOARD_HIGHLIGHT":
                 this.status = "invisible";
@@ -47889,9 +47901,9 @@ function revertChanges(revisions) {
  * Apply the changes of the given HistoryChange to the state
  */
 function applyChange(change, target) {
-    let val = change.root;
-    let key = change.path[change.path.length - 1];
-    for (let pathIndex = 0; pathIndex < change.path.slice(0, -1).length; pathIndex++) {
+    let val = change.path[0];
+    const key = change.path[change.path.length - 1];
+    for (let pathIndex = 1; pathIndex < change.path.slice(0, -1).length; pathIndex++) {
         const p = change.path[pathIndex];
         if (val[p] === undefined) {
             const nextPath = change.path[pathIndex + 1];
@@ -48572,13 +48584,14 @@ class StateObserver {
     }
     addChange(...args) {
         const val = args.pop();
-        const [root, ...path] = args;
+        const root = args[0];
         let value = root;
-        let key = path[path.length - 1];
-        for (let pathIndex = 0; pathIndex <= path.length - 2; pathIndex++) {
-            const p = path[pathIndex];
+        let key = args[args.length - 1];
+        const pathLength = args.length - 2;
+        for (let pathIndex = 1; pathIndex <= pathLength; pathIndex++) {
+            const p = args[pathIndex];
             if (value[p] === undefined) {
-                const nextPath = path[pathIndex + 1];
+                const nextPath = args[pathIndex + 1];
                 value[p] = createEmptyStructure(nextPath);
             }
             value = value[p];
@@ -48587,8 +48600,7 @@ class StateObserver {
             return;
         }
         this.changes.push({
-            root,
-            path,
+            path: args,
             before: value[key],
             after: val,
         });
@@ -50438,19 +50450,22 @@ class Model extends EventBus {
      * Check if the given command is allowed by all the plugins and the history.
      */
     checkDispatchAllowed(command) {
-        if (isCoreCommand(command)) {
-            return this.checkDispatchAllowedCoreCommand(command);
+        const results = isCoreCommand(command)
+            ? this.checkDispatchAllowedCoreCommand(command)
+            : this.checkDispatchAllowedLocalCommand(command);
+        if (results.some((r) => r !== 0 /* CommandResult.Success */)) {
+            return new DispatchResult(results.flat());
         }
-        return this.checkDispatchAllowedLocalCommand(command);
+        return DispatchResult.Success;
     }
     checkDispatchAllowedCoreCommand(command) {
         const results = this.corePlugins.map((handler) => handler.allowDispatch(command));
         results.push(this.range.allowDispatch(command));
-        return new DispatchResult(results.flat());
+        return results;
     }
     checkDispatchAllowedLocalCommand(command) {
         const results = this.uiHandlers.map((handler) => handler.allowDispatch(command));
-        return new DispatchResult(results.flat());
+        return results;
     }
     finalize() {
         this.status = 3 /* Status.Finalizing */;
@@ -50742,6 +50757,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.14';
-__info__.date = '2023-11-16T11:59:51.900Z';
-__info__.hash = '66c6f47';
+__info__.version = '16.4.15';
+__info__.date = '2023-11-24T13:12:26.608Z';
+__info__.hash = '141943d';