@odoo/o-spreadsheet 16.1.20 → 16.1.24

package/dist/o-spreadsheet.cjs.js

@@ -321,7 +321,16 @@ const DATE_JS_1900_OFFSET = INITIAL_JS_DAY - INITIAL_1900_DAY;
 const mdyDateRegexp = /^\d{1,2}(\/|-|\s)\d{1,2}((\/|-|\s)\d{1,4})?$/;
 const ymdDateRegexp = /^\d{3,4}(\/|-|\s)\d{1,2}(\/|-|\s)\d{1,2}$/;
 const timeRegexp = /((\d+(:\d+)?(:\d+)?\s*(AM|PM))|(\d+:\d+(:\d+)?))$/;
+const CACHE = {};
 function parseDateTime(str) {
+    if (str in CACHE) {
+        return CACHE[str];
+    }
+    const date = _parseDateTime(str);
+    CACHE[str] = date;
+    return date;
+}
+function _parseDateTime(str) {
     str = str.trim();
     let time;
     const timeMatch = str.match(timeRegexp);
@@ -1006,13 +1015,17 @@ function getAddHeaderStartIndex(position, base) {
     return position === "after" ? base + 1 : base;
 }
 /**
- * Compare two objects.
+ * Compares two objects.
  */
 function deepEquals(o1, o2) {
     if (o1 === o2)
         return true;
     if ((o1 && !o2) || (o2 && !o1))
         return false;
+    if (typeof o1 !== typeof o2)
+        return false;
+    if (typeof o1 !== "object")
+        return o1 === o2;
     // Objects can have different keys if the values are undefined
     const keys = new Set();
     Object.keys(o1).forEach((key) => keys.add(key));
@@ -2121,8 +2134,9 @@ class RangeImpl {
     }
     get zone() {
         const { left, top, bottom, right } = this._zone;
-        if (right !== undefined && bottom !== undefined)
-            return { left, top, right, bottom };
+        if (right !== undefined && bottom !== undefined) {
+            return this._zone;
+        }
         else if (bottom === undefined && right !== undefined) {
             return { right, top, left, bottom: this.getSheetSize(this.sheetId).height - 1 };
         }
@@ -3648,6 +3662,9 @@ exports.CommandResult = void 0;
     CommandResult[CommandResult["InvalidQuantity"] = 87] = "InvalidQuantity";
 })(exports.CommandResult || (exports.CommandResult = {}));
 
+function isMatrix(x) {
+    return Array.isArray(x) && Array.isArray(x[0]);
+}
 var DIRECTION;
 (function (DIRECTION) {
     DIRECTION["UP"] = "up";
@@ -14117,6 +14134,36 @@ const HLOOKUP = {
     isExported: true,
 };
 // -----------------------------------------------------------------------------
+// INDEX
+// -----------------------------------------------------------------------------
+const INDEX = {
+    description: _lt(`Returns the content of a cell, specified by row and column offset.`),
+    args: args(`
+      reference (any, range) ${_lt("The range of cells from which the value is returned.")}
+      row (number) ${_lt("The index of the row to be returned from within the reference range of cells.")}
+      column (number) ${_lt("The index of the column to be returned from within the reference range of cells.")}
+`),
+    returns: ["ANY"],
+    computeFormat: (reference, row, column) => {
+        var _a;
+        const _row = toNumber(row.value);
+        const _column = toNumber(column.value);
+        return (_a = reference[_column - 1][_row - 1]) === null || _a === void 0 ? void 0 : _a.format;
+    },
+    compute: function (reference, row, column) {
+        const _reference = isMatrix(reference) ? reference : [[reference]];
+        const _row = toNumber(row);
+        const _column = toNumber(column);
+        assert(() => _column >= 0 &&
+            _column - 1 < _reference.length &&
+            _row >= 0 &&
+            _row - 1 < _reference[0].length, _lt("Index out of range."));
+        assert(() => row !== 0 && column !== 0, _lt("This function can only return a single cell value, not an array. Provide valid row and column indices."));
+        return _reference[_column - 1][_row - 1];
+    },
+    isExported: true,
+};
+// -----------------------------------------------------------------------------
 // LOOKUP
 // -----------------------------------------------------------------------------
 const LOOKUP = {
@@ -14310,6 +14357,7 @@ var lookup = /*#__PURE__*/Object.freeze({
   COLUMN: COLUMN,
   COLUMNS: COLUMNS,
   HLOOKUP: HLOOKUP,
+  INDEX: INDEX,
   LOOKUP: LOOKUP,
   MATCH: MATCH,
   ROW: ROW,
@@ -18287,6 +18335,7 @@ css /* scss */ `
     padding: 10px;
     width: ${ERROR_TOOLTIP_WIDTH}px;
     box-sizing: border-box !important;
+    overflow-wrap: break-word;
   }
 `;
 class ErrorToolTip extends owl.Component {
@@ -18467,6 +18516,9 @@ class FilterMenu extends owl.Component {
         });
         this.state.values = this.getFilterValues(this.props.filterPosition);
     }
+    get isReadonly() {
+        return this.env.model.getters.isReadonly();
+    }
     getFilterValues(position) {
         const sheetId = this.env.model.getters.getActiveSheetId();
         const filter = this.env.model.getters.getFilter({ sheetId, ...position });
@@ -21729,9 +21781,9 @@ class FindAndReplacePanel extends owl.Component {
     }
     setup() {
         this.showFormulaState = this.env.model.getters.shouldShowFormulas();
-        this.debouncedUpdateSearch = debounce(this.updateSearch.bind(this), 200);
         owl.onMounted(() => this.focusInput());
         owl.onWillUnmount(() => {
+            clearTimeout(this.debounceTimeoutId);
             this.env.model.dispatch("CLEAR_SEARCH");
             this.env.model.dispatch("SET_FORMULA_VISIBILITY", { show: this.showFormulaState });
         });
@@ -21776,6 +21828,13 @@ class FindAndReplacePanel extends owl.Component {
             searchOptions: this.state.searchOptions,
         });
     }
+    debouncedUpdateSearch() {
+        clearTimeout(this.debounceTimeoutId);
+        this.debounceTimeoutId = setTimeout(() => {
+            this.updateSearch();
+            this.debounceTimeoutId = undefined;
+        }, 200);
+    }
     replace() {
         this.env.model.dispatch("REPLACE_SEARCH", {
             replaceWith: this.state.replaceWith,
@@ -22426,9 +22485,11 @@ function useCellHovered(env, gridRef, callback) {
         }
     }
     function updateMousePosition(e) {
-        x = e.offsetX;
-        y = e.offsetY;
-        lastMoved = Date.now();
+        if (gridRef.el === e.target) {
+            x = e.offsetX;
+            y = e.offsetY;
+            lastMoved = Date.now();
+        }
     }
     function recompute() {
         const { col, row } = getPosition();
@@ -22711,7 +22772,14 @@ class AbstractResizer extends owl.Component {
             return;
         }
         if (this.state.waitingForMove === true) {
-            this.startMovement(ev);
+            if (!this.env.model.getters.isGridSelectionActive()) {
+                this._selectElement(index, false);
+            }
+            else {
+                // FIXME: Consider reintroducing this feature for all type of selection if we find
+                // a way to have the grid selection follow the other selections evolution
+                this.startMovement(ev);
+            }
             return;
         }
         if (this.env.model.getters.getEditionMode() === "editing") {
@@ -26011,12 +26079,15 @@ function createXMLFile(doc, path, contentType) {
     };
 }
 function xmlEscape(str) {
-    return String(str)
+    return (String(str)
         .replace(/\&/g, "&amp;")
         .replace(/\</g, "&lt;")
         .replace(/\>/g, "&gt;")
         .replace(/\"/g, "&quot;")
-        .replace(/\'/g, "&apos;");
+        .replace(/\'/g, "&apos;")
+        // Delete all ASCII control characters except for TAB (\x09), LF (\x0A) and CR (\x0D)
+        // They are not valid at all in XML 1.0 (even escaped)
+        .replace(/[\x00-\x08\x0B\x0C\x0E-\x1F]/g, ""));
 }
 function formatAttributes(attrs) {
     return new XMLString(attrs.map(([key, val]) => `${key}="${xmlEscape(val)}"`).join(" "));
@@ -28545,10 +28616,11 @@ class CellPlugin extends CorePlugin {
      * Reconstructs the original formula string based on a normalized form and its dependencies
      */
     buildFormulaContent(sheetId, cell, dependencies) {
-        const ranges = dependencies || [...cell.dependencies];
+        const ranges = dependencies || cell.dependencies;
+        let rangeIndex = 0;
         return concat(cell.compiledFormula.tokens.map((token) => {
             if (token.type === "REFERENCE") {
-                const range = ranges.shift();
+                const range = ranges[rangeIndex++];
                 return this.getters.getRangeString(range, sheetId);
             }
             return token.value;
@@ -32623,6 +32695,7 @@ class EvaluationConditionalFormatPlugin extends UIPlugin {
         // stores the computed styles in the format of computedStyles.sheetName[col][row] = Style
         this.computedStyles = {};
         this.computedIcons = {};
+        this.uuidGenerator = new UuidGenerator();
         /**
          * Execute the predicate to know if a conditional formatting rule should be applied to a cell
          */
@@ -32950,6 +33023,10 @@ class EvaluationConditionalFormatPlugin extends UIPlugin {
         }
         currentRanges = currentRanges.concat(toAdd);
         const newRangesXC = recomputeZones(currentRanges, toRemove);
+        if (newRangesXC.length === 0) {
+            this.dispatch("REMOVE_CONDITIONAL_FORMAT", { id: cf.id, sheetId });
+            return;
+        }
         this.dispatch("ADD_CONDITIONAL_FORMAT", {
             cf: {
                 id: cf.id,
@@ -32975,13 +33052,20 @@ class EvaluationConditionalFormatPlugin extends UIPlugin {
                         this.adaptRules(origin.sheetId, cf, [xc], toRemoveRange);
                     }
                     else {
-                        this.adaptRules(target.sheetId, cf, [xc], []);
                         this.adaptRules(origin.sheetId, cf, [], toRemoveRange);
+                        const cfToCopyTo = this.getCFToCopyTo(target.sheetId, cf);
+                        this.adaptRules(target.sheetId, cfToCopyTo, [xc], []);
                     }
                 }
             }
         }
     }
+    getCFToCopyTo(targetSheetId, originCF) {
+        const cfInTarget = this.getters
+            .getConditionalFormats(targetSheetId)
+            .find((cf) => cf.stopIfTrue === originCF.stopIfTrue && deepEquals(cf.rule, originCF.rule));
+        return cfInTarget ? cfInTarget : { ...originCF, id: this.uuidGenerator.uuidv4(), ranges: [] };
+    }
 }
 EvaluationConditionalFormatPlugin.getters = ["getConditionalIcon", "getCellComputedStyle"];
 
@@ -33329,30 +33413,26 @@ class InternalViewport {
         const { end } = this.getters.getColDimensions(sheetId, targetCol);
         const maxCol = this.getters.getNumberCols(sheetId);
         if (this.offsetX + this.offsetCorrectionX + this.viewportWidth < end) {
-            for (let col = this.left; this.offsetX + this.offsetCorrectionX + this.viewportWidth < end; col++) {
-                if (col > maxCol) {
-                    break;
-                }
-                if (this.getters.isColHidden(sheetId, col)) {
-                    continue;
-                }
-                this.offsetX = this.getters.getColDimensions(sheetId, col).end - this.offsetCorrectionX;
-                this.offsetScrollbarX = this.offsetX;
-                this.adjustViewportZoneX();
+            let finalTarget = targetCol;
+            while (this.getters.isColHidden(sheetId, finalTarget) && targetCol < maxCol) {
+                finalTarget++;
             }
+            const finalTargetEnd = this.getters.getColDimensions(sheetId, finalTarget).end;
+            const startIndex = this.searchHeaderIndex("COL", finalTargetEnd - this.viewportWidth - this.offsetCorrectionX, this.boundaries.left, true);
+            this.offsetX =
+                this.getters.getColDimensions(sheetId, startIndex).end - this.offsetCorrectionX;
+            this.offsetScrollbarX = this.offsetX;
+            this.adjustViewportZoneX();
         }
         else if (this.left > targetCol) {
-            for (let col = this.left; col >= targetCol; col--) {
-                if (col < 0) {
-                    break;
-                }
-                if (this.getters.isColHidden(sheetId, col)) {
-                    continue;
-                }
-                this.offsetX = this.getters.getColDimensions(sheetId, col).start - this.offsetCorrectionX;
-                this.offsetScrollbarX = this.offsetX;
-                this.adjustViewportZoneX();
+            let finalTarget = targetCol;
+            while (this.getters.isColHidden(sheetId, finalTarget) && targetCol > 0) {
+                finalTarget--;
             }
+            this.offsetX =
+                this.getters.getColDimensions(sheetId, finalTarget).start - this.offsetCorrectionX;
+            this.offsetScrollbarX = this.offsetX;
+            this.adjustViewportZoneX();
         }
     }
     adjustPositionY(targetRow) {
@@ -33360,30 +33440,26 @@ class InternalViewport {
         const { end } = this.getters.getRowDimensions(sheetId, targetRow);
         const maxRow = this.getters.getNumberRows(sheetId);
         if (this.offsetY + this.viewportHeight + this.offsetCorrectionY < end) {
-            for (let row = this.top; this.offsetY + this.viewportHeight + this.offsetCorrectionY < end; row++) {
-                if (row > maxRow) {
-                    break;
-                }
-                if (this.getters.isRowHidden(sheetId, row)) {
-                    continue;
-                }
-                this.offsetY = this.getters.getRowDimensions(sheetId, row).end - this.offsetCorrectionY;
-                this.offsetScrollbarY = this.offsetY;
-                this.adjustViewportZoneY();
+            let finalTarget = targetRow;
+            while (this.getters.isRowHidden(sheetId, finalTarget) && targetRow < maxRow) {
+                finalTarget++;
             }
+            const finalTargetEnd = this.getters.getRowDimensions(sheetId, finalTarget).end;
+            const startIndex = this.searchHeaderIndex("ROW", finalTargetEnd - this.viewportHeight - this.offsetCorrectionY, this.boundaries.top, true);
+            this.offsetY =
+                this.getters.getRowDimensions(sheetId, startIndex).end - this.offsetCorrectionY;
+            this.offsetScrollbarY = this.offsetY;
+            this.adjustViewportZoneY();
         }
         else if (this.top > targetRow) {
-            for (let row = this.top; row >= targetRow; row--) {
-                if (row < 0) {
-                    break;
-                }
-                if (this.getters.isRowHidden(sheetId, row)) {
-                    continue;
-                }
-                this.offsetY = this.getters.getRowDimensions(sheetId, row).start - this.offsetCorrectionY;
-                this.offsetScrollbarY = this.offsetY;
-                this.adjustViewportZoneY();
+            let finalTarget = targetRow;
+            while (this.getters.isRowHidden(sheetId, finalTarget) && targetRow > 0) {
+                finalTarget--;
             }
+            this.offsetY =
+                this.getters.getRowDimensions(sheetId, finalTarget).start - this.offsetCorrectionY;
+            this.offsetScrollbarY = this.offsetY;
+            this.adjustViewportZoneY();
         }
     }
     setViewportOffset(offsetX, offsetY) {
@@ -34957,14 +35033,10 @@ class FindAndReplacePlugin extends UIPlugin {
             case "REPLACE_ALL_SEARCH":
                 this.replaceAll(cmd.replaceWith);
                 break;
-            case "EVALUATE_CELLS":
-            case "UPDATE_CELL":
-            case "REMOVE_FILTER_TABLE":
-            case "UPDATE_FILTER":
-                this.isSearchDirty = true;
-                break;
             case "UNDO":
             case "REDO":
+            case "REMOVE_FILTER_TABLE":
+            case "UPDATE_FILTER":
             case "REMOVE_COLUMNS_ROWS":
             case "HIDE_COLUMNS_ROWS":
             case "UNHIDE_COLUMNS_ROWS":
@@ -37956,7 +38028,7 @@ class ClipboardCellsState extends ClipboardCellsAbstractState {
         });
         for (const filterTable of this.copiedTables) {
             this.dispatch("REMOVE_FILTER_TABLE", {
-                sheetId: this.getters.getActiveSheetId(),
+                sheetId: this.sheetId,
                 target: [filterTable.zone],
             });
         }
@@ -38434,7 +38506,7 @@ class ClipboardPlugin extends UIPlugin {
     allowDispatch(cmd) {
         switch (cmd.type) {
             case "CUT":
-                const zones = cmd.target || this.getters.getSelectedZones();
+                const zones = this.getters.getSelectedZones();
                 const state = this.getClipboardState(zones, cmd.type);
                 return state.isCutAllowed(zones);
             case "PASTE":
@@ -38465,7 +38537,7 @@ class ClipboardPlugin extends UIPlugin {
         switch (cmd.type) {
             case "COPY":
             case "CUT":
-                const zones = ("target" in cmd && cmd.target) || this.getters.getSelectedZones();
+                const zones = this.getters.getSelectedZones();
                 this.state = this.getClipboardState(zones, cmd.type);
                 this.status = "visible";
                 break;
@@ -38896,6 +38968,9 @@ class GridSelectionPlugin extends UIPlugin {
     // ---------------------------------------------------------------------------
     // Getters
     // ---------------------------------------------------------------------------
+    isGridSelectionActive() {
+        return this.selection.isListening(this);
+    }
     getActiveSheet() {
         return this.activeSheet;
     }
@@ -39126,26 +39201,24 @@ class GridSelectionPlugin extends UIPlugin {
         const isBasedBefore = cmd.base < start;
         const deltaCol = isBasedBefore && isCol ? thickness : 0;
         const deltaRow = isBasedBefore && !isCol ? thickness : 0;
-        this.dispatch("CUT", {
-            target: [
-                {
-                    left: isCol ? start + deltaCol : 0,
-                    right: isCol ? end + deltaCol : this.getters.getNumberCols(cmd.sheetId) - 1,
-                    top: !isCol ? start + deltaRow : 0,
-                    bottom: !isCol ? end + deltaRow : this.getters.getNumberRows(cmd.sheetId) - 1,
-                },
-            ],
-        });
-        this.dispatch("PASTE", {
-            target: [
-                {
-                    left: isCol ? cmd.base : 0,
-                    right: isCol ? cmd.base + thickness - 1 : this.getters.getNumberCols(cmd.sheetId) - 1,
-                    top: !isCol ? cmd.base : 0,
-                    bottom: !isCol ? cmd.base + thickness - 1 : this.getters.getNumberRows(cmd.sheetId) - 1,
-                },
-            ],
-        });
+        const target = [
+            {
+                left: isCol ? start + deltaCol : 0,
+                right: isCol ? end + deltaCol : this.getters.getNumberCols(cmd.sheetId) - 1,
+                top: !isCol ? start + deltaRow : 0,
+                bottom: !isCol ? end + deltaRow : this.getters.getNumberRows(cmd.sheetId) - 1,
+            },
+        ];
+        const state = new ClipboardCellsState(target, "CUT", this.getters, this.dispatch, this.selection);
+        const pasteTarget = [
+            {
+                left: isCol ? cmd.base : 0,
+                right: isCol ? cmd.base + thickness - 1 : this.getters.getNumberCols(cmd.sheetId) - 1,
+                top: !isCol ? cmd.base : 0,
+                bottom: !isCol ? cmd.base + thickness - 1 : this.getters.getNumberRows(cmd.sheetId) - 1,
+            },
+        ];
+        state.paste(pasteTarget, { selectTarget: true });
         const toRemove = isBasedBefore ? cmd.elements.map((el) => el + thickness) : cmd.elements;
         let currentIndex = cmd.base;
         for (const element of toRemove) {
@@ -39272,6 +39345,7 @@ GridSelectionPlugin.getters = [
     "getSheetPosition",
     "isSelected",
     "getElementsFromSelection",
+    "isGridSelectionActive",
 ];
 
 const corePluginRegistry = new Registry()
@@ -42064,6 +42138,9 @@ class SelectionStreamProcessor {
             anchor: { zone, cell: this.anchor.cell },
         });
     }
+    isListening(owner) {
+        return this.stream.isListening(owner);
+    }
     /**
      * Process a new anchor selection event. If the new anchor is inside
      * the sheet boundaries, the event is pushed to the event stream to
@@ -44350,6 +44427,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.1.20';
-__info__.date = '2023-09-12T11:43:40.624Z';
-__info__.hash = '7d7b841';
+__info__.version = '16.1.24';
+__info__.date = '2023-10-19T14:21:55.097Z';
+__info__.hash = '1b9e9d0';

package/dist/o-spreadsheet.d.ts

@@ -245,7 +245,7 @@ declare class RangeImpl implements Range {
     constructor(args: ConstructorArgs, getSheetSize: (sheetId: UID) => ZoneDimension);
     static fromRange(range: Range, getters: CoreGetters): RangeImpl;
     get unboundedZone(): UnboundedZone;
-    get zone(): Zone;
+    get zone(): Readonly<Zone>;
     static getRangeParts(xc: string, zone: UnboundedZone): RangePart[];
     get isFullCol(): boolean;
     get isFullRow(): boolean;
@@ -340,6 +340,7 @@ interface SelectionProcessor {
     selectAll(): DispatchResult;
     loopSelection(): DispatchResult;
     selectTableAroundSelection(): DispatchResult;
+    isListening(owner: unknown): boolean;
 }
 /**
  * Processes all selection updates (usually from user inputs) and emits an event
@@ -412,6 +413,7 @@ declare class SelectionStreamProcessor implements SelectionProcessor, StatefulSt
      * Select the entire sheet
      */
     selectAll(): DispatchResult;
+    isListening(owner: unknown): boolean;
     /**
      * Process a new anchor selection event. If the new anchor is inside
      * the sheet boundaries, the event is pushed to the event stream to
@@ -1800,8 +1802,6 @@ interface CopyCommand {
 }
 interface CutCommand {
     type: "CUT";
-    /** Zones to cut. If none were given, will copy the zones in the selection*/
-    target?: Zone[];
 }
 interface PasteCommand {
     type: "PASTE";
@@ -3854,6 +3854,7 @@ declare class EvaluationConditionalFormatPlugin extends UIPlugin {
     private isStale;
     private computedStyles;
     private computedIcons;
+    private uuidGenerator;
     handle(cmd: Command): void;
     finalize(): void;
     getCellComputedStyle(position: CellPosition): Style;
@@ -3884,6 +3885,7 @@ declare class EvaluationConditionalFormatPlugin extends UIPlugin {
      */
     private adaptRules;
     private pasteCf;
+    private getCFToCopyTo;
 }
 
 declare class FilterEvaluationPlugin extends UIPlugin {
@@ -4660,7 +4662,7 @@ declare class ClipboardPlugin extends UIPlugin {
  */
 declare class GridSelectionPlugin extends UIPlugin {
     static layers: LAYERS[];
-    static getters: readonly ["getActiveSheet", "getActiveSheetId", "getActiveCell", "getActiveCols", "getActiveRows", "getCurrentStyle", "getSelectedZones", "getSelectedZone", "getStatisticFnResults", "getAggregate", "getSelectedFigureId", "getSelection", "getActivePosition", "getSheetPosition", "isSelected", "getElementsFromSelection"];
+    static getters: readonly ["getActiveSheet", "getActiveSheetId", "getActiveCell", "getActiveCols", "getActiveRows", "getCurrentStyle", "getSelectedZones", "getSelectedZone", "getStatisticFnResults", "getAggregate", "getSelectedFigureId", "getSelection", "getActivePosition", "getSheetPosition", "isSelected", "getElementsFromSelection", "isGridSelectionActive"];
     private gridSelection;
     private selectedFigureId;
     private sheetsData;
@@ -4670,6 +4672,7 @@ declare class GridSelectionPlugin extends UIPlugin {
     allowDispatch(cmd: Command): CommandResult;
     private handleEvent;
     handle(cmd: Command): void;
+    isGridSelectionActive(): boolean;
     getActiveSheet(): Readonly<Sheet>;
     getActiveSheetId(): UID;
     getActiveCell(): EvaluatedCell;