@odoo/o-spreadsheet 19.2.0-alpha.1 → 19.2.0-alpha.2

package/dist/o-spreadsheet-engine.d.ts

@@ -143,12 +143,11 @@ type BarChartRuntime = {
 interface GenericCriterion {
     type: GenericCriterionType;
     values: string[];
+    isPercent?: boolean;
+    isBottom?: boolean;
 }
-type GenericCriterionType = "containsText" | "notContainsText" | "isEqualText" | "isEmail" | "isLink" | "dateIs" | "dateIsBefore" | "dateIsOnOrBefore" | "dateIsAfter" | "dateIsOnOrAfter" | "dateIsBetween" | "dateIsNotBetween" | "dateIsValid" | "isEqual" | "isNotEqual" | "isGreaterThan" | "isGreaterOrEqualTo" | "isLessThan" | "isLessOrEqualTo" | "isBetween" | "isNotBetween" | "isBoolean" | "isValueInList" | "isValueInRange" | "customFormula" | "beginsWithText" | "endsWithText" | "isNotEmpty" | "isEmpty";
+type GenericCriterionType = "containsText" | "notContainsText" | "isEqualText" | "isEmail" | "isLink" | "dateIs" | "dateIsBefore" | "dateIsOnOrBefore" | "dateIsAfter" | "dateIsOnOrAfter" | "dateIsBetween" | "dateIsNotBetween" | "dateIsValid" | "isEqual" | "isNotEqual" | "isGreaterThan" | "isGreaterOrEqualTo" | "isLessThan" | "isLessOrEqualTo" | "isBetween" | "isNotBetween" | "isBoolean" | "isValueInList" | "isValueInRange" | "customFormula" | "beginsWithText" | "endsWithText" | "isNotEmpty" | "isEmpty" | "top10";
 type DateCriterionValue = "today" | "tomorrow" | "yesterday" | "lastWeek" | "lastMonth" | "lastYear" | "exactDate";
-type EvaluatedCriterion<T extends GenericCriterion = GenericCriterion> = Omit<T, "values"> & {
-    values: CellValue[];
-};
 
 interface RangePart {
     readonly colFixed: boolean;
@@ -646,6 +645,8 @@ interface CellIsRule extends SingleColorRule {
     operator: ConditionalFormattingOperatorValues;
     values: string[];
     dateValue?: DateCriterionValue;
+    isPercent?: boolean;
+    isBottom?: boolean;
 }
 type ThresholdType = "value" | "number" | "percentage" | "percentile" | "formula";
 type ColorScaleThreshold = {
@@ -688,7 +689,7 @@ interface IconSetRule {
     upperInflectionPoint: IconThreshold;
     lowerInflectionPoint: IconThreshold;
 }
-declare const cfOperators: readonly ["containsText", "notContainsText", "isGreaterThan", "isGreaterOrEqualTo", "isLessThan", "isLessOrEqualTo", "isBetween", "isNotBetween", "beginsWithText", "endsWithText", "isNotEmpty", "isEmpty", "isNotEqual", "isEqual", "customFormula", "dateIs", "dateIsBefore", "dateIsAfter", "dateIsOnOrBefore", "dateIsOnOrAfter"];
+declare const cfOperators: readonly ["containsText", "notContainsText", "isGreaterThan", "isGreaterOrEqualTo", "isLessThan", "isLessOrEqualTo", "isBetween", "isNotBetween", "beginsWithText", "endsWithText", "isNotEmpty", "isEmpty", "isNotEqual", "isEqual", "customFormula", "dateIs", "dateIsBefore", "dateIsAfter", "dateIsOnOrBefore", "dateIsOnOrAfter", "top10"];
 type ConditionalFormattingOperatorValues = (typeof cfOperators)[number];
 
 interface ConditionalFormatState {
@@ -2535,6 +2536,7 @@ declare class Session extends EventBus<CollaborativeEvent> {
     private onClientJoined;
     private onClientLeft;
     private sendUpdateMessage;
+    private sendToTransport;
     /**
      * Send the next pending message
      */
@@ -2755,6 +2757,9 @@ type SheetValidationResult = {
 declare class EvaluationDataValidationPlugin extends CoreViewPlugin {
     static getters: readonly ["getDataValidationInvalidCriterionValueMessage", "getInvalidDataValidationMessage", "getValidationResultForCellValue", "getDataValidationRangeValues", "isCellValidCheckbox", "getDataValidationCellStyle", "getDataValidationChipStyle", "isDataValidationInvalid"];
     validationResults: Record<UID, SheetValidationResult>;
+    criterionPreComputeResult: Record<UID, {
+        [dvRuleId: UID]: unknown;
+    }>;
     handle(cmd: CoreViewCommand): void;
     isDataValidationInvalid(cellPosition: CellPosition): boolean;
     getDataValidationCellStyle(position: CellPosition): Style | undefined;
@@ -2766,7 +2771,7 @@ declare class EvaluationDataValidationPlugin extends CoreViewPlugin {
      * The value must be canonicalized.
      */
     getDataValidationInvalidCriterionValueMessage(criterionType: DataValidationCriterionType, value: string): string | undefined;
-    getDataValidationRangeValues(sheetId: UID, criterion: EvaluatedCriterion): {
+    getDataValidationRangeValues(sheetId: UID, criterion: GenericCriterion): {
         value: string;
         label: string;
     }[];

package/dist/o-spreadsheet-engine.esm.js

@@ -3,8 +3,8 @@
  * This file is generated by o-spreadsheet build tools. Do not edit it.
  * @see https://github.com/odoo/o-spreadsheet
  * @version 19.1.0-alpha.3
- * @date 2025-12-26T10:19:48.559Z
- * @hash 3296c7e
+ * @date 2026-01-07T16:20:57.293Z
+ * @hash ac2fa3e
  */
 
 class FunctionCodeBuilder {
@@ -14251,6 +14251,7 @@ const DVTerms = {
         dateValue: _t("The value must be a date"),
         validRange: _t("The value must be a valid range"),
         validFormula: _t("The formula must be valid"),
+        positiveNumber: _t("The value must be a positive number"),
     },
     Errors: {
         ["InvalidRange" /* CommandResult.InvalidRange */]: _t("The range is invalid."),
@@ -18112,7 +18113,7 @@ class ReadonlyTransportFilter {
         if (message.type === "CLIENT_JOINED" ||
             message.type === "CLIENT_LEFT" ||
             message.type === "CLIENT_MOVED") {
-            this.transportService.sendMessage(message);
+            await this.transportService.sendMessage(message);
         }
         // ignore all other messages
     }
@@ -20731,7 +20732,7 @@ class Session extends EventBus {
         }
         delete this.clients[this.clientId];
         this.transportService.leave(this.clientId);
-        this.transportService.sendMessage({
+        this.sendToTransport({
             type: "CLIENT_LEFT",
             clientId: this.clientId,
             version: MESSAGE_VERSION,
@@ -20745,7 +20746,7 @@ class Session extends EventBus {
             return;
         }
         const snapshotId = this.uuidGenerator.uuidv4();
-        await this.transportService.sendMessage({
+        await this.sendToTransport({
             type: "SNAPSHOT",
             nextRevisionId: snapshotId,
             serverRevisionId: this.serverRevisionId,
@@ -20793,10 +20794,14 @@ class Session extends EventBus {
         const type = currentPosition ? "CLIENT_MOVED" : "CLIENT_JOINED";
         const client = this.getCurrentClient();
         this.clients[this.clientId] = { ...client, position };
-        this.transportService.sendMessage({
+        this.sendToTransport({
             type,
             version: MESSAGE_VERSION,
             client: { ...client, position },
+        }).then(() => {
+            if (this.pendingMessages.length > 0 && !this.waitingAck) {
+                this.sendPendingMessage();
+            }
         });
     }
     /**
@@ -20877,7 +20882,7 @@ class Session extends EventBus {
             if (client) {
                 const { position } = client;
                 if (position) {
-                    this.transportService.sendMessage({
+                    this.sendToTransport({
                         type: "CLIENT_MOVED",
                         version: MESSAGE_VERSION,
                         client: { ...client, position },
@@ -20898,6 +20903,10 @@ class Session extends EventBus {
         }
         this.sendPendingMessage();
     }
+    async sendToTransport(message) {
+        // wrap in an async function to ensure it returns a promise
+        return this.transportService.sendMessage(message);
+    }
     /**
      * Send the next pending message
      */
@@ -20926,9 +20935,14 @@ class Session extends EventBus {
       ${JSON.stringify(message)}`);
         }
         this.waitingAck = true;
-        this.transportService.sendMessage({
+        this.sendToTransport({
             ...message,
             serverRevisionId: this.serverRevisionId,
+        }).catch((e) => {
+            if (!(e instanceof ClientDisconnectedError)) {
+                throw e.cause || e;
+            }
+            this.waitingAck = false;
         });
     }
     acknowledge(message) {
@@ -22389,6 +22403,7 @@ const CF_OPERATOR_TYPE_CONVERSION_MAP = {
     greaterThanOrEqual: "isGreaterOrEqualTo",
     lessThan: "isLessThan",
     lessThanOrEqual: "isLessOrEqualTo",
+    top10: "top10",
 };
 /** Conversion map CF types in XLSX <=> Cf types in o_spreadsheet */
 const CF_TYPE_CONVERSION_MAP = {
@@ -22929,6 +22944,7 @@ function convertConditionalFormats(xlsxCfs, dxfs, warningManager) {
         const rule = cf.cfRules[0];
         let operator;
         const values = [];
+        const cfAdditionalProperties = {};
         if (rule.dxfId === undefined &&
             !(rule.type === "colorScale" || rule.type === "iconSet" || rule.type === "dataBar"))
             continue;
@@ -22937,7 +22953,6 @@ function convertConditionalFormats(xlsxCfs, dxfs, warningManager) {
             case "containsErrors":
             case "notContainsErrors":
             case "duplicateValues":
-            case "top10":
             case "uniqueValues":
             case "timePeriod":
                 // Not supported
@@ -22988,6 +23003,18 @@ function convertConditionalFormats(xlsxCfs, dxfs, warningManager) {
                     values.push(prefixFormulaWithEqual(rule.formula[1]));
                 }
                 break;
+            case "top10":
+                if (rule.rank === undefined)
+                    continue;
+                operator = CF_OPERATOR_TYPE_CONVERSION_MAP[rule.type];
+                values.push(rule.rank.toString());
+                if (rule.percent) {
+                    cfAdditionalProperties.isPercent = true;
+                }
+                if (rule.bottom) {
+                    cfAdditionalProperties.isBottom = true;
+                }
+                break;
         }
         if (operator && rule.dxfId !== undefined) {
             cfs.push({
@@ -22998,6 +23025,7 @@ function convertConditionalFormats(xlsxCfs, dxfs, warningManager) {
                     type: "CellIsRule",
                     operator: operator,
                     values: values,
+                    ...cfAdditionalProperties,
                     style: convertStyle({ fontStyle: dxfs[rule.dxfId].font, fillStyle: dxfs[rule.dxfId].fill }, warningManager),
                 },
             });
@@ -23291,6 +23319,8 @@ function convertOperator(operator) {
             return "greaterThanOrEqual";
         case "dateIsOnOrBefore":
             return "lessThanOrEqual";
+        case "top10":
+            return "top10";
     }
 }
 // -------------------------------------
@@ -23910,17 +23940,41 @@ function toCriterionDateNumber(dateValue) {
     const today = DateTime.now();
     switch (dateValue) {
         case "today":
-            return jsDateToNumber(today);
-        case "yesterday":
-            return jsDateToNumber(DateTime.fromTimestamp(today.setDate(today.getDate() - 1)));
-        case "tomorrow":
-            return jsDateToNumber(DateTime.fromTimestamp(today.setDate(today.getDate() + 1)));
+            return Math.floor(jsDateToNumber(today));
+        case "yesterday": {
+            today.setDate(today.getDate() - 1);
+            return Math.floor(jsDateToNumber(today));
+        }
+        case "tomorrow": {
+            today.setDate(today.getDate() + 1);
+            return Math.floor(jsDateToNumber(today));
+        }
         case "lastWeek":
-            return jsDateToNumber(DateTime.fromTimestamp(today.setDate(today.getDate() - 7)));
-        case "lastMonth":
-            return jsDateToNumber(DateTime.fromTimestamp(today.setMonth(today.getMonth() - 1)));
+            today.setDate(today.getDate() - 6);
+            return Math.floor(jsDateToNumber(today));
+        case "lastMonth": {
+            const lastMonth = today.getMonth() === 0 ? 11 : today.getMonth() - 1;
+            const dateInLastMonth = new DateTime(today.getFullYear(), lastMonth, 1);
+            if (today.getDate() > getDaysInMonth(dateInLastMonth)) {
+                today.setDate(1);
+            }
+            else {
+                today.setDate(today.getDate() + 1);
+                today.setMonth(today.getMonth() - 1);
+            }
+            return Math.floor(jsDateToNumber(today));
+        }
         case "lastYear":
-            return jsDateToNumber(DateTime.fromTimestamp(today.setFullYear(today.getFullYear() - 1)));
+            // Handle leap year case
+            if (today.getMonth() === 1 && today.getDate() === 29) {
+                today.setDate(28);
+                today.setFullYear(today.getFullYear() - 1);
+            }
+            else {
+                today.setDate(today.getDate() + 1);
+                today.setFullYear(today.getFullYear() - 1);
+            }
+            return Math.floor(jsDateToNumber(today));
     }
 }
 /** Get all the dates values of a criterion converted to numbers, converting date values such as "today" to actual dates  */
@@ -28945,7 +28999,7 @@ criterionEvaluatorRegistry.add("dateIs", {
             return false;
         }
         if (["lastWeek", "lastMonth", "lastYear"].includes(criterion.dateValue)) {
-            const today = jsDateToRoundNumber(DateTime.now());
+            const today = Math.floor(jsDateToNumber(DateTime.now()));
             return isDateBetween(dateValue, today, criterionValue);
         }
         return areDatesSameDay(dateValue, criterionValue);
@@ -29327,15 +29381,20 @@ criterionEvaluatorRegistry.add("isValueInList", {
     getPreview: (criterion) => _t("Value one of: %s", criterion.values.join(", ")),
 });
 criterionEvaluatorRegistry.add("isValueInRange", {
-    type: "isValueInList",
-    isValueValid: (value, criterion, getters, sheetId) => {
+    type: "isValueInRange",
+    preComputeCriterion: (criterion, criterionRanges, getters) => {
+        if (criterionRanges.length === 0) {
+            return new Set();
+        }
+        const sheetId = criterionRanges[0].sheetId;
+        const criterionValues = getters.getDataValidationRangeValues(sheetId, criterion);
+        return new Set(criterionValues.map((value) => value.value.toString().toLowerCase()));
+    },
+    isValueValid: (value, criterion, valuesSet) => {
         if (!value) {
             return false;
         }
-        const criterionValues = getters.getDataValidationRangeValues(sheetId, criterion);
-        return criterionValues
-            .map((value) => value.value.toLowerCase())
-            .includes(value.toString().toLowerCase());
+        return valuesSet.has(value.toString().toLowerCase());
     },
     getErrorString: (criterion) => _t("The value must be a value in the range %s", String(criterion.values[0])),
     isCriterionValueValid: (value) => rangeReference.test(value),
@@ -29412,6 +29471,67 @@ criterionEvaluatorRegistry.add("isNotEmpty", {
     name: _t("Is not empty"),
     getPreview: () => _t("Is not empty"),
 });
+criterionEvaluatorRegistry.add("top10", {
+    type: "top10",
+    preComputeCriterion: (criterion, criterionRanges, getters) => {
+        let value = tryToNumber(criterion.values[0], DEFAULT_LOCALE);
+        if (value === undefined || value <= 0) {
+            return undefined;
+        }
+        const numberValues = [];
+        for (const range of criterionRanges) {
+            for (const value of getters.getRangeValues(range)) {
+                if (typeof value === "number") {
+                    numberValues.push(value);
+                }
+            }
+        }
+        const sortedValues = numberValues.sort((a, b) => a - b);
+        if (criterion.isPercent) {
+            value = clip(value, 1, 100);
+        }
+        let index = 0;
+        if (criterion.isBottom && !criterion.isPercent) {
+            index = value - 1;
+        }
+        else if (criterion.isBottom && criterion.isPercent) {
+            index = Math.floor((sortedValues.length * value) / 100) - 1;
+        }
+        else if (!criterion.isBottom && criterion.isPercent) {
+            index = sortedValues.length - Math.floor((sortedValues.length * value) / 100);
+        }
+        else {
+            index = sortedValues.length - value;
+        }
+        index = clip(index, 0, sortedValues.length - 1);
+        return sortedValues[index];
+    },
+    isValueValid: (value, criterion, threshold) => {
+        if (typeof value !== "number" || threshold === undefined) {
+            return false;
+        }
+        return criterion.isBottom ? value <= threshold : value >= threshold;
+    },
+    getErrorString: (criterion) => {
+        const args = {
+            value: String(criterion.values[0]),
+            percentSymbol: criterion.isPercent ? "%" : "",
+        };
+        return criterion.isBottom
+            ? _t("The value must be in bottom %(value)s%(percentSymbol)s", args)
+            : _t("The value must be in top %(value)s%(percentSymbol)s", args);
+    },
+    isCriterionValueValid: (value) => checkValueIsPositiveNumber(value),
+    criterionValueErrorString: DVTerms.CriterionError.positiveNumber,
+    numberOfValues: () => 1,
+    name: _t("Is in Top/Bottom ranking"),
+    getPreview: (criterion) => {
+        const args = { value: criterion.values[0], percentSymbol: criterion.isPercent ? "%" : "" };
+        return criterion.isBottom
+            ? _t("Value is in bottom %(value)s%(percentSymbol)s", args)
+            : _t("Value is in top %(value)s%(percentSymbol)s", args);
+    },
+});
 function getNumberCriterionlocalizedValues(criterion, locale) {
     return criterion.values.map((value) => {
         return value !== undefined
@@ -29433,6 +29553,10 @@ function checkValueIsNumber(value) {
     const valueAsNumber = tryToNumber(value, DEFAULT_LOCALE);
     return valueAsNumber !== undefined;
 }
+function checkValueIsPositiveNumber(value) {
+    const valueAsNumber = tryToNumber(value, DEFAULT_LOCALE);
+    return valueAsNumber !== undefined && valueAsNumber > 0;
+}
 
 // -----------------------------------------------------------------------------
 // Constants
@@ -39763,6 +39887,10 @@ class EvaluationConditionalFormatPlugin extends CoreViewPlugin {
                     break;
                 case "CellIsRule":
                     const formulas = cf.rule.values.map((value) => value.startsWith("=") ? compile(value) : undefined);
+                    const evaluator = criterionEvaluatorRegistry.get(cf.rule.operator);
+                    const criterion = { ...cf.rule, type: cf.rule.operator };
+                    const ranges = cf.ranges.map((xc) => this.getters.getRangeFromSheetXC(sheetId, xc));
+                    const preComputedCriterion = evaluator.preComputeCriterion?.(criterion, ranges, this.getters);
                     for (const ref of cf.ranges) {
                         const zone = this.getters.getRangeFromSheetXC(sheetId, ref).zone;
                         for (let row = zone.top; row <= zone.bottom; row++) {
@@ -39775,7 +39903,7 @@ class EvaluationConditionalFormatPlugin extends CoreViewPlugin {
                                     }
                                     return value;
                                 });
-                                if (this.getRuleResultForTarget(target, { ...cf.rule, values })) {
+                                if (this.getRuleResultForTarget(target, { ...cf.rule, values }, preComputedCriterion)) {
                                     if (!computedStyle[col])
                                         computedStyle[col] = [];
                                     // we must combine all the properties of all the CF rules applied to the given cell
@@ -39938,7 +40066,7 @@ class EvaluationConditionalFormatPlugin extends CoreViewPlugin {
             }
         }
     }
-    getRuleResultForTarget(target, rule) {
+    getRuleResultForTarget(target, rule, preComputedCriterion) {
         const cell = this.getters.getEvaluatedCell(target);
         if (cell.type === CellValueType.error) {
             return false;
@@ -39955,11 +40083,12 @@ class EvaluationConditionalFormatPlugin extends CoreViewPlugin {
             return false;
         }
         const evaluatedCriterion = {
+            ...rule,
             type: rule.operator,
             values: evaluatedCriterionValues.map(toScalar),
             dateValue: rule.dateValue || "exactDate",
         };
-        return evaluator.isValueValid(cell.value ?? "", evaluatedCriterion, this.getters, sheetId);
+        return evaluator.isValueValid(cell.value ?? "", evaluatedCriterion, preComputedCriterion);
     }
 }
 
@@ -39976,17 +40105,20 @@ class EvaluationDataValidationPlugin extends CoreViewPlugin {
         "isDataValidationInvalid",
     ];
     validationResults = {};
+    criterionPreComputeResult = {};
     handle(cmd) {
         if (invalidateEvaluationCommands.has(cmd.type) ||
             cmd.type === "EVALUATE_CELLS" ||
             (cmd.type === "UPDATE_CELL" && ("content" in cmd || "format" in cmd))) {
             this.validationResults = {};
+            this.criterionPreComputeResult = {};
             return;
         }
         switch (cmd.type) {
             case "ADD_DATA_VALIDATION_RULE":
             case "REMOVE_DATA_VALIDATION_RULE":
                 delete this.validationResults[cmd.sheetId];
+                delete this.criterionPreComputeResult[cmd.sheetId];
                 break;
         }
     }
@@ -40129,7 +40261,15 @@ class EvaluationDataValidationPlugin extends CoreViewPlugin {
             return undefined;
         }
         const evaluatedCriterion = { ...criterion, values: evaluatedCriterionValues.map(toScalar) };
-        if (evaluator.isValueValid(cellValue, evaluatedCriterion, this.getters, sheetId)) {
+        if (!this.criterionPreComputeResult[sheetId]) {
+            this.criterionPreComputeResult[sheetId] = {};
+        }
+        let preComputedCriterion = this.criterionPreComputeResult[sheetId][rule.id];
+        if (preComputedCriterion === undefined) {
+            preComputedCriterion = evaluator.preComputeCriterion?.(rule.criterion, rule.ranges, this.getters);
+            this.criterionPreComputeResult[sheetId][rule.id] = preComputedCriterion;
+        }
+        if (evaluator.isValueValid(cellValue, evaluatedCriterion, preComputedCriterion)) {
             return undefined;
         }
         return evaluator.getErrorString(evaluatedCriterion, this.getters, sheetId);
@@ -45461,6 +45601,7 @@ class FilterEvaluationPlugin extends UIPlugin {
                 if (filterValue.type === "none")
                     continue;
                 const evaluator = criterionEvaluatorRegistry.get(filterValue.type);
+                const preComputedCriterion = evaluator.preComputeCriterion?.(filterValue, [filter.filteredRange], this.getters);
                 const evaluatedCriterionValues = filterValue.values.map((value) => {
                     if (!value.startsWith("=")) {
                         return parseLiteral(value, DEFAULT_LOCALE);
@@ -45478,7 +45619,7 @@ class FilterEvaluationPlugin extends UIPlugin {
                 for (let row = filteredZone.top; row <= filteredZone.bottom; row++) {
                     const position = { sheetId, col: filter.col, row };
                     const value = this.getters.getEvaluatedCell(position).value ?? "";
-                    if (!evaluator.isValueValid(value, evaluatedCriterion, this.getters, sheetId)) {
+                    if (!evaluator.isValueValid(value, evaluatedCriterion, preComputedCriterion)) {
                         hiddenRows.add(row);
                     }
                 }
@@ -49619,6 +49760,8 @@ function cellRuleFormula(ranges, rule) {
                 case undefined:
                     throw new Error("dateValue should be defined");
             }
+        case "top10":
+            return [];
     }
 }
 function cellRuleTypeAttributes(rule) {
@@ -49651,6 +49794,14 @@ function cellRuleTypeAttributes(rule) {
         case "dateIs":
         case "customFormula":
             return [["type", "expression"]];
+        case "top10": {
+            return [
+                ["type", "top10"],
+                ["rank", rule.values[0]],
+                ["percent", rule.isPercent ? "1" : "0"],
+                ["bottom", rule.isBottom ? "1" : "0"],
+            ];
+        }
     }
 }
 function addDataBarRule(cf, rule) {
@@ -51523,5 +51674,5 @@ export { BadExpressionError, BasePlugin, CellErrorType, CircularDependencyError,
 
 
 __info__.version = "19.1.0-alpha.3";
-__info__.date = "2025-12-26T10:19:48.559Z";
-__info__.hash = "3296c7e";
+__info__.date = "2026-01-07T16:20:57.293Z";
+__info__.hash = "ac2fa3e";