@odoo/o-spreadsheet 17.3.3 → 17.3.5

package/dist/o-spreadsheet.cjs.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.3
- * @date 2024-06-14T10:02:58.082Z
- * @hash c690e9f
+ * @version 17.3.5
+ * @date 2024-06-26T11:05:50.339Z
+ * @hash 54eb151
  */
 
 'use strict';
@@ -1898,9 +1898,10 @@ function percentile(values, percent, isInclusive) {
         sortedValues[indexLow] * (indexSup - percentIndex));
 }
 
-// define a mock translation function, when o-spreadsheet runs in standalone it doesn't translate any string
-let _translate = (s) => s;
-let _loaded = () => false;
+const defaultTranslate = (s) => s;
+const defaultLoaded = () => false;
+let _translate = defaultTranslate;
+let _loaded = defaultLoaded;
 function sprintf(s, ...values) {
     if (values.length === 1 && typeof values[0] === "object" && !(values[0] instanceof String)) {
         const valuesDict = values[0];
@@ -1912,7 +1913,8 @@ function sprintf(s, ...values) {
     return s;
 }
 /***
- * Allow to inject a translation function from outside o-spreadsheet.
+ * Allow to inject a translation function from outside o-spreadsheet. This should be called before instantiating
+ * a model.
  * @param tfn the function that will do the translation
  * @param loaded a function that returns true when the translation is loaded
  */
@@ -1920,6 +1922,18 @@ function setTranslationMethod(tfn, loaded = () => true) {
     _translate = tfn;
     _loaded = loaded;
 }
+/**
+ * If no translation function has been set, this will mark the translation are loaded.
+ *
+ * By default, the translations should not be set as loaded, otherwise top-level translated constants will never be
+ * translated. But if by the time the model is instantiated no custom translation function has been set, we can set
+ * the default translation function as loaded so o-spreadsheet can be run in standalone with no translations.
+ */
+function setDefaultTranslationMethod() {
+    if (_translate === defaultTranslate && _loaded === defaultLoaded) {
+        _loaded = () => true;
+    }
+}
 const _t = function (s, ...values) {
     if (!_loaded()) {
         return new LazyTranslatedString(s, values);
@@ -9461,10 +9475,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;
@@ -34065,6 +34077,7 @@ class FindAndReplaceStore extends SpreadsheetStore {
     currentSearchRegex = null;
     isSearchDirty = false;
     initialShowFormulaState;
+    preserveSelectedMatchIndex = false;
     // fixme: why do we make selectedMatchIndex on top of a selected
     // property in the matches?
     selectedMatchIndex = null;
@@ -34174,7 +34187,9 @@ class FindAndReplaceStore extends SpreadsheetStore {
      * refresh the matches according to the current search options
      */
     refreshSearch(jumpToMatchSheet = true) {
-        this.selectedMatchIndex = null;
+        if (!this.preserveSelectedMatchIndex) {
+            this.selectedMatchIndex = null;
+        }
         this.findMatches();
         this.selectNextCell(Direction.current, jumpToMatchSheet);
     }
@@ -34273,10 +34288,16 @@ class FindAndReplaceStore extends SpreadsheetStore {
         const selectedMatch = matches[nextIndex];
         // Switch to the sheet where the match is located
         if (jumpToMatchSheet && this.getters.getActiveSheetId() !== selectedMatch.sheetId) {
+            // We set `preserveSelectedMatchIndex` to true to avoid resetting the selected search
+            // index in the `refreshSearch` function when a new sheet is activated. The reason being
+            // that, when we automatically go back to previous sheet while performing a search, the
+            // search index is reset to the first occurrence each time.
+            this.preserveSelectedMatchIndex = true;
             this.model.dispatch("ACTIVATE_SHEET", {
                 sheetIdFrom: this.getters.getActiveSheetId(),
                 sheetIdTo: selectedMatch.sheetId,
             });
+            this.preserveSelectedMatchIndex = false;
             // We do not want to reset the selection at finalize in this case
             this.isSearchDirty = false;
         }
@@ -34926,7 +34947,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
@@ -35329,10 +35350,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);
@@ -35559,7 +35583,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") {
@@ -35595,10 +35620,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
@@ -52840,7 +52870,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;
@@ -52882,6 +52911,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));
@@ -54482,7 +54512,7 @@ class PivotUIPlugin extends UIPlugin {
     getPivotIdFromPosition(position) {
         const cell = this.getters.getCorrespondingFormulaCell(position);
         if (cell && cell.isFormula) {
-            const pivotFunction = this.getFirstPivotFunction(cell.compiledFormula.tokens);
+            const pivotFunction = this.getFirstPivotFunction(position.sheetId, cell.compiledFormula.tokens);
             if (pivotFunction) {
                 const pivotId = pivotFunction.args[0]?.toString();
                 return pivotId && this.getters.getPivotId(pivotId);
@@ -54490,7 +54520,7 @@ class PivotUIPlugin extends UIPlugin {
         }
         return undefined;
     }
-    getFirstPivotFunction(tokens) {
+    getFirstPivotFunction(sheetId, tokens) {
         const pivotFunction = getFirstPivotFunction(tokens);
         if (!pivotFunction) {
             return undefined;
@@ -54506,7 +54536,7 @@ class PivotUIPlugin extends UIPlugin {
                 return argAst.value;
             }
             const argsString = astToFormula(argAst);
-            return this.getters.evaluateFormula(this.getters.getActiveSheetId(), argsString);
+            return this.getters.evaluateFormula(sheetId, argsString);
         });
         return { functionName, args: evaluatedArgs };
     }
@@ -54529,7 +54559,7 @@ class PivotUIPlugin extends UIPlugin {
             return undefined;
         }
         const mainPosition = this.getters.getCellPosition(cell.id);
-        const result = this.getters.getFirstPivotFunction(cell.compiledFormula.tokens);
+        const result = this.getters.getFirstPivotFunction(position.sheetId, cell.compiledFormula.tokens);
         if (!result) {
             return undefined;
         }
@@ -66307,6 +66337,7 @@ class Model extends EventBus {
         const start = performance.now();
         console.group("Model creation");
         super();
+        setDefaultTranslationMethod();
         stateUpdateMessages = repairInitialMessages(data, stateUpdateMessages);
         const workbookData = load(data, verboseImport);
         this.state = new StateObserver();
@@ -66983,6 +67014,6 @@ exports.tokenColors = tokenColors;
 exports.tokenize = tokenize;
 
 
-__info__.version = "17.3.3";
-__info__.date = "2024-06-14T10:02:58.082Z";
-__info__.hash = "c690e9f";
+__info__.version = "17.3.5";
+__info__.date = "2024-06-26T11:05:50.339Z";
+__info__.hash = "54eb151";

package/dist/o-spreadsheet.d.ts

@@ -4255,7 +4255,7 @@ declare class PivotUIPlugin extends UIPlugin {
      * is no pivot at this position
      */
     getPivotIdFromPosition(position: CellPosition): "" | UID | undefined;
-    getFirstPivotFunction(tokens: Token[]): {
+    getFirstPivotFunction(sheetId: UID, tokens: Token[]): {
         functionName: string;
         args: (CellValue | Matrix<CellValue> | undefined)[];
     } | undefined;
@@ -8899,6 +8899,7 @@ declare class FindAndReplaceStore extends SpreadsheetStore implements HighlightP
     private currentSearchRegex;
     private isSearchDirty;
     private initialShowFormulaState;
+    private preserveSelectedMatchIndex;
     selectedMatchIndex: number | null;
     toSearch: string;
     toReplace: string;
@@ -10180,7 +10181,8 @@ type SprintfValues = (string | String | number)[] | [{
 }];
 type TranslationFunction = (string: string, ...values: SprintfValues) => string;
 /***
- * Allow to inject a translation function from outside o-spreadsheet.
+ * Allow to inject a translation function from outside o-spreadsheet. This should be called before instantiating
+ * a model.
  * @param tfn the function that will do the translation
  * @param loaded a function that returns true when the translation is loaded
  */

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.3
- * @date 2024-06-14T10:02:58.082Z
- * @hash c690e9f
+ * @version 17.3.5
+ * @date 2024-06-26T11:05:50.339Z
+ * @hash 54eb151
  */
 
 import { useEnv, useSubEnv, onWillUnmount, useComponent, status, Component, useRef, onMounted, useEffect, useState, onPatched, onWillPatch, onWillUpdateProps, useExternalListener, onWillStart, xml, useChildSubEnv, markRaw, toRaw } from '@odoo/owl';
@@ -1896,9 +1896,10 @@ function percentile(values, percent, isInclusive) {
         sortedValues[indexLow] * (indexSup - percentIndex));
 }
 
-// define a mock translation function, when o-spreadsheet runs in standalone it doesn't translate any string
-let _translate = (s) => s;
-let _loaded = () => false;
+const defaultTranslate = (s) => s;
+const defaultLoaded = () => false;
+let _translate = defaultTranslate;
+let _loaded = defaultLoaded;
 function sprintf(s, ...values) {
     if (values.length === 1 && typeof values[0] === "object" && !(values[0] instanceof String)) {
         const valuesDict = values[0];
@@ -1910,7 +1911,8 @@ function sprintf(s, ...values) {
     return s;
 }
 /***
- * Allow to inject a translation function from outside o-spreadsheet.
+ * Allow to inject a translation function from outside o-spreadsheet. This should be called before instantiating
+ * a model.
  * @param tfn the function that will do the translation
  * @param loaded a function that returns true when the translation is loaded
  */
@@ -1918,6 +1920,18 @@ function setTranslationMethod(tfn, loaded = () => true) {
     _translate = tfn;
     _loaded = loaded;
 }
+/**
+ * If no translation function has been set, this will mark the translation are loaded.
+ *
+ * By default, the translations should not be set as loaded, otherwise top-level translated constants will never be
+ * translated. But if by the time the model is instantiated no custom translation function has been set, we can set
+ * the default translation function as loaded so o-spreadsheet can be run in standalone with no translations.
+ */
+function setDefaultTranslationMethod() {
+    if (_translate === defaultTranslate && _loaded === defaultLoaded) {
+        _loaded = () => true;
+    }
+}
 const _t = function (s, ...values) {
     if (!_loaded()) {
         return new LazyTranslatedString(s, values);
@@ -9459,10 +9473,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;
@@ -34063,6 +34075,7 @@ class FindAndReplaceStore extends SpreadsheetStore {
     currentSearchRegex = null;
     isSearchDirty = false;
     initialShowFormulaState;
+    preserveSelectedMatchIndex = false;
     // fixme: why do we make selectedMatchIndex on top of a selected
     // property in the matches?
     selectedMatchIndex = null;
@@ -34172,7 +34185,9 @@ class FindAndReplaceStore extends SpreadsheetStore {
      * refresh the matches according to the current search options
      */
     refreshSearch(jumpToMatchSheet = true) {
-        this.selectedMatchIndex = null;
+        if (!this.preserveSelectedMatchIndex) {
+            this.selectedMatchIndex = null;
+        }
         this.findMatches();
         this.selectNextCell(Direction.current, jumpToMatchSheet);
     }
@@ -34271,10 +34286,16 @@ class FindAndReplaceStore extends SpreadsheetStore {
         const selectedMatch = matches[nextIndex];
         // Switch to the sheet where the match is located
         if (jumpToMatchSheet && this.getters.getActiveSheetId() !== selectedMatch.sheetId) {
+            // We set `preserveSelectedMatchIndex` to true to avoid resetting the selected search
+            // index in the `refreshSearch` function when a new sheet is activated. The reason being
+            // that, when we automatically go back to previous sheet while performing a search, the
+            // search index is reset to the first occurrence each time.
+            this.preserveSelectedMatchIndex = true;
             this.model.dispatch("ACTIVATE_SHEET", {
                 sheetIdFrom: this.getters.getActiveSheetId(),
                 sheetIdTo: selectedMatch.sheetId,
             });
+            this.preserveSelectedMatchIndex = false;
             // We do not want to reset the selection at finalize in this case
             this.isSearchDirty = false;
         }
@@ -34924,7 +34945,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
@@ -35327,10 +35348,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);
@@ -35557,7 +35581,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") {
@@ -35593,10 +35618,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
@@ -52838,7 +52868,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;
@@ -52880,6 +52909,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));
@@ -54480,7 +54510,7 @@ class PivotUIPlugin extends UIPlugin {
     getPivotIdFromPosition(position) {
         const cell = this.getters.getCorrespondingFormulaCell(position);
         if (cell && cell.isFormula) {
-            const pivotFunction = this.getFirstPivotFunction(cell.compiledFormula.tokens);
+            const pivotFunction = this.getFirstPivotFunction(position.sheetId, cell.compiledFormula.tokens);
             if (pivotFunction) {
                 const pivotId = pivotFunction.args[0]?.toString();
                 return pivotId && this.getters.getPivotId(pivotId);
@@ -54488,7 +54518,7 @@ class PivotUIPlugin extends UIPlugin {
         }
         return undefined;
     }
-    getFirstPivotFunction(tokens) {
+    getFirstPivotFunction(sheetId, tokens) {
         const pivotFunction = getFirstPivotFunction(tokens);
         if (!pivotFunction) {
             return undefined;
@@ -54504,7 +54534,7 @@ class PivotUIPlugin extends UIPlugin {
                 return argAst.value;
             }
             const argsString = astToFormula(argAst);
-            return this.getters.evaluateFormula(this.getters.getActiveSheetId(), argsString);
+            return this.getters.evaluateFormula(sheetId, argsString);
         });
         return { functionName, args: evaluatedArgs };
     }
@@ -54527,7 +54557,7 @@ class PivotUIPlugin extends UIPlugin {
             return undefined;
         }
         const mainPosition = this.getters.getCellPosition(cell.id);
-        const result = this.getters.getFirstPivotFunction(cell.compiledFormula.tokens);
+        const result = this.getters.getFirstPivotFunction(position.sheetId, cell.compiledFormula.tokens);
         if (!result) {
             return undefined;
         }
@@ -66305,6 +66335,7 @@ class Model extends EventBus {
         const start = performance.now();
         console.group("Model creation");
         super();
+        setDefaultTranslationMethod();
         stateUpdateMessages = repairInitialMessages(data, stateUpdateMessages);
         const workbookData = load(data, verboseImport);
         this.state = new StateObserver();
@@ -66938,6 +66969,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.3";
-__info__.date = "2024-06-14T10:02:58.082Z";
-__info__.hash = "c690e9f";
+__info__.version = "17.3.5";
+__info__.date = "2024-06-26T11:05:50.339Z";
+__info__.hash = "54eb151";