@odoo/o-spreadsheet 16.1.27 → 16.1.28

package/dist/o-spreadsheet.cjs.js

@@ -626,13 +626,6 @@ function getYearFrac(startDate, endDate, _dayCountConvention) {
 }
 
 //------------------------------------------------------------------------------
-/**
- * Stringify an object, like JSON.stringify, except that the first level of keys
- * is ordered.
- */
-function stringify(obj) {
-    return JSON.stringify(obj, Object.keys(obj).sort());
-}
 /**
  * Remove quotes from a quoted string
  * ```js
@@ -928,7 +921,7 @@ function isObjectEmptyRecursive(argument) {
  */
 function getItemId(item, itemsDic) {
     for (let [key, value] of Object.entries(itemsDic)) {
-        if (stringify(value) === stringify(item)) {
+        if (deepEquals(value, item)) {
             return parseInt(key, 10);
         }
     }
@@ -1064,6 +1057,22 @@ function transpose2dArray(matrix) {
     if (!matrix.length)
         return matrix;
     return matrix[0].map((_, i) => matrix.map((row) => row[i]));
+}
+/**
+ * Creates a version of the function that's memoized on the value of its first
+ * argument, if any.
+ */
+function memoize(func) {
+    const cache = new Map();
+    const funcName = func.name ? func.name + " (memoized)" : "memoized";
+    return {
+        [funcName](...args) {
+            if (!cache.has(args[0])) {
+                cache.set(args[0], func(...args));
+            }
+            return cache.get(args[0]);
+        },
+    }[funcName];
 }
 
 const RBA_REGEX = /rgba?\(|\s+|\)/gi;
@@ -3660,6 +3669,7 @@ exports.CommandResult = void 0;
     CommandResult[CommandResult["ChartDoesNotExist"] = 85] = "ChartDoesNotExist";
     CommandResult[CommandResult["InvalidHeaderIndex"] = 86] = "InvalidHeaderIndex";
     CommandResult[CommandResult["InvalidQuantity"] = 87] = "InvalidQuantity";
+    CommandResult[CommandResult["NoChanges"] = 88] = "NoChanges";
 })(exports.CommandResult || (exports.CommandResult = {}));
 
 function isMatrix(x) {
@@ -8023,12 +8033,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
@@ -27945,6 +27955,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":
@@ -28340,6 +28358,15 @@ class BordersPlugin extends CorePlugin {
             this.setBorders(sheetId, [{ ...zone, left: right }], "right");
         }
     }
+    checkBordersUnchanged(cmd) {
+        var _a, _b, _c, _d;
+        const currentBorder = this.getCellBorder(cmd);
+        const areAllNewBordersUndefined = !((_a = cmd.border) === null || _a === void 0 ? void 0 : _a.bottom) && !((_b = cmd.border) === null || _b === void 0 ? void 0 : _b.left) && !((_c = cmd.border) === null || _c === void 0 ? void 0 : _c.right) && !((_d = cmd.border) === null || _d === void 0 ? void 0 : _d.top);
+        if ((!currentBorder && areAllNewBordersUndefined) || deepEquals(currentBorder, cmd.border)) {
+            return 88 /* CommandResult.NoChanges */;
+        }
+        return 0 /* CommandResult.Success */;
+    }
     // ---------------------------------------------------------------------------
     // Import/Export
     // ---------------------------------------------------------------------------
@@ -28375,7 +28402,7 @@ class BordersPlugin extends CorePlugin {
          */
         function getBorderId(border) {
             for (let [key, value] of Object.entries(borders)) {
-                if (stringify(value) === stringify(border)) {
+                if (deepEquals(value, border)) {
                     return parseInt(key, 10);
                 }
             }
@@ -28443,8 +28470,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 */;
         }
@@ -28603,14 +28631,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
@@ -28851,13 +28874,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 27 /* CommandResult.InvalidSheetId */;
         const sheetZone = this.getters.getSheetZone(sheetId);
         return isInside(col, row, sheetZone) ? 0 /* CommandResult.Success */ : 18 /* CommandResult.TargetOutOfSheet */;
     }
+    checkUselessClearCell(cmd) {
+        const cell = this.getters.getCell(cmd);
+        if (!cell)
+            return 88 /* CommandResult.NoChanges */;
+        if (!cell.content && !cell.style && !cell.format) {
+            return 88 /* CommandResult.NoChanges */;
+        }
+        return 0 /* CommandResult.Success */;
+    }
 }
 CellPlugin.getters = [
     "zoneToXC",
@@ -31918,10 +31951,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) {
@@ -31943,8 +31979,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");
         }
@@ -32045,35 +32079,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
      *
@@ -32530,6 +32549,7 @@ class EvaluationPlugin extends UIPlugin {
             }
             return evaluatedCell;
         };
+        const rangeCache = {};
         /**
          * Return the values of the cell(s) used in reference, but always in the format of a range even
          * if a single cell is referenced. It is a list of col values. This is useful for the formulas that describe parameters as
@@ -32546,21 +32566,26 @@ class EvaluationPlugin extends UIPlugin {
             // 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 = getters.getSheetZone(sheetId);
-            const result = [];
             const zone = intersection(range.zone, sheetZone);
             if (!zone) {
-                result.push([]);
-                return result;
+                return [[]];
+            }
+            const { top, left, bottom, right } = zone;
+            const cacheKey = `${sheetId}-${top}-${left}-${bottom}-${right}`;
+            if (cacheKey in rangeCache) {
+                return rangeCache[cacheKey];
             }
+            const result = new Array(right - left + 1);
             // Performance issue: nested loop is faster than a map here
-            for (let col = zone.left; col <= zone.right; col++) {
-                const rowValues = [];
-                for (let row = zone.top; row <= zone.bottom; row++) {
+            for (let col = left; col <= right; col++) {
+                const rowValues = new Array(bottom - top + 1);
+                for (let row = top; row <= bottom; row++) {
                     const cell = evalContext.getters.getCell({ sheetId: range.sheetId, col, row });
-                    rowValues.push(cell ? getEvaluatedCell(cell) : undefined);
+                    rowValues[row - top] = cell ? getEvaluatedCell(cell) : undefined;
                 }
-                result.push(rowValues);
+                result[col - left] = rowValues;
             }
+            rangeCache[cacheKey] = result;
             return result;
         }
         /**
@@ -41674,9 +41699,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];
@@ -42431,13 +42456,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];
@@ -42446,8 +42472,7 @@ class StateObserver {
             return;
         }
         this.changes.push({
-            root,
-            path,
+            path: args,
             before: value[key],
             after: val,
         });
@@ -44221,7 +44246,10 @@ class Model extends EventBus {
      */
     checkDispatchAllowed(command) {
         const results = this.handlers.map((handler) => handler.allowDispatch(command));
-        return new DispatchResult(results.flat());
+        if (results.some((r) => r !== 0 /* CommandResult.Success */)) {
+            return new DispatchResult(results.flat());
+        }
+        return DispatchResult.Success;
     }
     finalize() {
         this.status = 3 /* Status.Finalizing */;
@@ -44449,6 +44477,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.1.27';
-__info__.date = '2023-11-16T11:57:02.419Z';
-__info__.hash = '81f7214';
+__info__.version = '16.1.28';
+__info__.date = '2023-11-24T13:11:01.992Z';
+__info__.hash = '257f369';

package/dist/o-spreadsheet.d.ts

@@ -1194,7 +1194,7 @@ declare class StateObserver {
         commands: CoreCommand[];
     };
     addCommand(command: CoreCommand): void;
-    addChange(...args: any[]): void;
+    addChange(...args: [...HistoryChange["path"], any]): void;
 }
 
 interface Validator {
@@ -2259,7 +2259,8 @@ declare const enum CommandResult {
     DuplicatedChartId = 84,
     ChartDoesNotExist = 85,
     InvalidHeaderIndex = 86,
-    InvalidQuantity = 87
+    InvalidQuantity = 87,
+    NoChanges = 88
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -3043,7 +3044,8 @@ interface BordersPluginState {
 declare class BordersPlugin extends CorePlugin<BordersPluginState> implements BordersPluginState {
     static getters: readonly ["getCellBorder"];
     readonly borders: BordersPluginState["borders"];
-    handle(cmd: Command): void;
+    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.NoChanges;
+    handle(cmd: CoreCommand): void;
     /**
      * Move borders according to the inserted columns.
      * Ensure borders continuity.
@@ -3140,6 +3142,7 @@ declare class BordersPlugin extends CorePlugin<BordersPluginState> implements Bo
      * Compute the borders to add to the given zone merged.
      */
     private addBordersToMerge;
+    private checkBordersUnchanged;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3164,7 +3167,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
         };
     };
     adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID): void;
-    allowDispatch(cmd: CoreCommand): CommandResult;
+    allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
     /**
      * Set a format to all the cells in a zone
@@ -3237,6 +3240,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createFormulaCellWithDependencies;
     private createErrorFormula;
     private checkCellOutOfSheet;
+    private checkUselessClearCell;
 }
 
 /**
@@ -3745,15 +3749,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      */
     private moveCellOnRowsDeletion;
     private updateRowsStructureOnDeletion;
-    /**
-     * 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
-     */
-    private updateRowsStructureOnAddition;
     /**
      * Add empty rows at the end of the rows
      *
@@ -4806,8 +4801,7 @@ type Getters = {
 } & LocalHistoryGetters & CoreGetters & SessionGetters & AutofillGetters & AutomaticSumGetters & ClipboardGetters & EditionGetters & EvaluationGetters & EvaluationChartGetters & EvaluationConditionalFormatGetters & FindAndReplaceGetters & HighlightGetters & CustomColorsGetters & RendererGetters & SelectionGetters & SelectionInputGetters & SelectionMultiUserGetters & SortGetters & UIOptionsGetters & SheetUIGetters & ViewportGetters & CellPopoverPluginGetters & FilterEvaluationGetters & HeaderVisibilityIUIGetters;
 
 interface HistoryChange {
-    root: any;
-    path: (string | number)[];
+    path: [any, ...(number | string)[]];
     before: any;
     after: any;
 }