@odoo/o-spreadsheet 16.2.0 → 16.3.0-alpha.1

package/dist/o-spreadsheet.esm.js

@@ -106,6 +106,7 @@ const HEADER_BORDER_COLOR = "#C0C0C0";
 const CELL_BORDER_COLOR = "#E2E3E3";
 const BACKGROUND_CHART_COLOR = "#FFFFFF";
 const MENU_ITEM_DISABLED_COLOR = "#CACACA";
+const BG_HOVER_COLOR = "#EBEBEB";
 const DEFAULT_COLOR_SCALE_MIDPOINT_COLOR = 0xb6d7a8;
 const LINK_COLOR = "#01666b";
 const FILTERS_COLOR = "#188038";
@@ -590,6 +591,38 @@ function getYearFrac(startDate, endDate, _dayCountConvention) {
             break;
     }
     return yearsEnd - yearsStart;
+}
+/**
+ * Get the number of whole months between two dates.
+ * e.g.
+ *  2002/01/01 -> 2002/02/01 = 1 month,
+ *  2002/01/01 -> 2003/02/01 = 13 months
+ * @param startDate
+ * @param endDate
+ * @returns
+ */
+function getTimeDifferenceInWholeMonths(startDate, endDate) {
+    const months = (endDate.getFullYear() - startDate.getFullYear()) * 12 +
+        endDate.getMonth() -
+        startDate.getMonth();
+    return startDate.getDate() > endDate.getDate() ? months - 1 : months;
+}
+function getTimeDifferenceInWholeDays(startDate, endDate) {
+    const startUtc = startDate.getTime();
+    const endUtc = endDate.getTime();
+    return Math.floor((endUtc - startUtc) / MS_PER_DAY);
+}
+function getTimeDifferenceInWholeYears(startDate, endDate) {
+    const years = endDate.getFullYear() - startDate.getFullYear();
+    const monthStart = startDate.getMonth();
+    const monthEnd = endDate.getMonth();
+    const dateStart = startDate.getDate();
+    const dateEnd = endDate.getDate();
+    const isEndMonthDateBigger = monthEnd > monthStart || (monthEnd === monthStart && dateEnd >= dateStart);
+    return isEndMonthDateBigger ? years : years - 1;
+}
+function areTwoDatesWithinOneYear(startDate, endDate) {
+    return getYearFrac(startDate, endDate, 1) < 1;
 }
 
 //------------------------------------------------------------------------------
@@ -3405,6 +3438,11 @@ function assert(condition, message) {
 // FORMAT FUNCTIONS
 // -----------------------------------------------------------------------------
 const expectNumberValueError = (value) => _lt("The function [[FUNCTION_NAME]] expects a number value, but '%s' is a string, and cannot be coerced to a number.", value);
+const expectNumberRangeError = (lowerBound, upperBound, value) => _lt("The function [[FUNCTION_NAME]] expects a number value between %s and %s inclusive, but receives %s.", lowerBound.toString(), upperBound.toString(), value.toString());
+const expectStringSetError = (stringSet, value) => {
+    const stringSetString = stringSet.map((str) => `'${str}'`).join(", ");
+    return _lt("The function [[FUNCTION_NAME]] has an argument with value '%s'. It should be one of: %s.", value, stringSetString);
+};
 function toNumber(value) {
     switch (typeof value) {
         case "number":
@@ -3430,6 +3468,12 @@ function strictToNumber(value) {
     }
     return toNumber(value);
 }
+function strictToInteger(value) {
+    return Math.trunc(strictToNumber(value));
+}
+function assertNumberGreaterThanOrEqualToOne(value) {
+    assert(() => value >= 1, _lt("The function [[FUNCTION_NAME]] expects a number value to be greater than or equal to 1, but receives %s.", value.toString()));
+}
 function toString(value) {
     switch (typeof value) {
         case "string":
@@ -4663,6 +4707,7 @@ const CSS$2 = css /* scss */ `
     .o-search-icon {
       right: 5px;
       top: 4px;
+      opacity: 0.4;
 
       svg {
         height: 16px;
@@ -5288,7 +5333,7 @@ css /* scss */ `
       &:not(.disabled) {
         &:hover,
         &.o-menu-item-active {
-          background-color: #ebebeb;
+          background-color: ${BG_HOVER_COLOR};
         }
         .o-menu-item-description {
           color: grey;
@@ -11749,6 +11794,15 @@ var database = /*#__PURE__*/Object.freeze({
 
 const DEFAULT_TYPE = 1;
 const DEFAULT_WEEKEND = 1;
+var TIME_UNIT;
+(function (TIME_UNIT) {
+    TIME_UNIT["WHOLE_YEARS"] = "Y";
+    TIME_UNIT["WHOLE_MONTHS"] = "M";
+    TIME_UNIT["WHOLE_DAYS"] = "D";
+    TIME_UNIT["DAYS_WITHOUT_WHOLE_MONTHS"] = "MD";
+    TIME_UNIT["MONTH_WITHOUT_WHOLE_YEARS"] = "YM";
+    TIME_UNIT["DAYS_BETWEEN_NO_MORE_THAN_ONE_YEAR"] = "YD";
+})(TIME_UNIT || (TIME_UNIT = {}));
 // -----------------------------------------------------------------------------
 // DATE
 // -----------------------------------------------------------------------------
@@ -11779,6 +11833,63 @@ const DATE = {
     isExported: true,
 };
 // -----------------------------------------------------------------------------
+// DATEDIF
+// -----------------------------------------------------------------------------
+const DATEDIF = {
+    description: _lt("Calculates the number of days, months, or years between two dates."),
+    args: [
+        arg("start_date (date)", _lt("The start date to consider in the calculation. Must be a reference to a cell containing a DATE, a function returning a DATE type, or a number.")),
+        arg("end_date (date)", _lt("The end date to consider in the calculation. Must be a reference to a cell containing a DATE, a function returning a DATE type, or a number.")),
+        arg("unit (string)", _lt(`A text abbreviation for unit of time. Accepted values are "Y" (the number of whole years between start_date and end_date), "M" (the number of whole months between start_date and end_date), "D" (the number of days between start_date and end_date), "MD" (the number of days between start_date and end_date after subtracting whole months), "YM" (the number of whole months between start_date and end_date after subtracting whole years), "YD" (the number of days between start_date and end_date, assuming start_date and end_date were no more than one year apart).`)),
+    ],
+    returns: ["NUMBER"],
+    compute: function (startDate, endDate, unit) {
+        const _unit = toString(unit).toUpperCase();
+        assert(() => Object.values(TIME_UNIT).includes(_unit), expectStringSetError(Object.values(TIME_UNIT), toString(unit)));
+        const _startDate = Math.trunc(toNumber(startDate));
+        const _endDate = Math.trunc(toNumber(endDate));
+        const jsStartDate = numberToJsDate(_startDate);
+        const jsEndDate = numberToJsDate(_endDate);
+        assert(() => _endDate >= _startDate, _lt("start_date (%s) should be on or before end_date (%s).", jsStartDate.toLocaleDateString(), jsEndDate.toLocaleDateString()));
+        switch (_unit) {
+            case TIME_UNIT.WHOLE_YEARS:
+                return getTimeDifferenceInWholeYears(jsStartDate, jsEndDate);
+            case TIME_UNIT.WHOLE_MONTHS:
+                return getTimeDifferenceInWholeMonths(jsStartDate, jsEndDate);
+            case TIME_UNIT.WHOLE_DAYS: {
+                return getTimeDifferenceInWholeDays(jsStartDate, jsEndDate);
+            }
+            case TIME_UNIT.MONTH_WITHOUT_WHOLE_YEARS: {
+                return (getTimeDifferenceInWholeMonths(jsStartDate, jsEndDate) -
+                    getTimeDifferenceInWholeYears(jsStartDate, jsEndDate) * 12);
+            }
+            case TIME_UNIT.DAYS_WITHOUT_WHOLE_MONTHS:
+                // Using "MD" may get incorrect result in Excel
+                // See: https://support.microsoft.com/en-us/office/datedif-function-25dba1a4-2812-480b-84dd-8b32a451b35c
+                let days = jsEndDate.getDate() - jsStartDate.getDate();
+                if (days < 0) {
+                    const monthBeforeEndMonth = new Date(jsEndDate.getFullYear(), jsEndDate.getMonth() - 1, 1);
+                    const daysInMonthBeforeEndMonth = getDaysInMonth(monthBeforeEndMonth);
+                    days = daysInMonthBeforeEndMonth - Math.abs(days);
+                }
+                return days;
+            case TIME_UNIT.DAYS_BETWEEN_NO_MORE_THAN_ONE_YEAR: {
+                if (areTwoDatesWithinOneYear(_startDate, _endDate)) {
+                    return getTimeDifferenceInWholeDays(jsStartDate, jsEndDate);
+                }
+                const endDateWithinOneYear = new Date(jsStartDate.getFullYear(), jsEndDate.getMonth(), jsEndDate.getDate());
+                let days = getTimeDifferenceInWholeDays(jsStartDate, endDateWithinOneYear);
+                if (days < 0) {
+                    endDateWithinOneYear.setFullYear(jsStartDate.getFullYear() + 1);
+                    days = getTimeDifferenceInWholeDays(jsStartDate, endDateWithinOneYear);
+                }
+                return days;
+            }
+        }
+    },
+    isExported: true,
+};
+// -----------------------------------------------------------------------------
 // DATEVALUE
 // -----------------------------------------------------------------------------
 const DATEVALUE = {
@@ -12457,6 +12568,7 @@ const YEAR_END = {
 var date = /*#__PURE__*/Object.freeze({
   __proto__: null,
   DATE: DATE,
+  DATEDIF: DATEDIF,
   DATEVALUE: DATEVALUE,
   DAY: DAY,
   DAYS: DAYS,
@@ -14940,12 +15052,54 @@ var logical = /*#__PURE__*/Object.freeze({
 const DEFAULT_IS_SORTED = true;
 const DEFAULT_MATCH_MODE = 0;
 const DEFAULT_SEARCH_MODE = 1;
+const DEFAULT_ABSOLUTE_RELATIVE_MODE = 1;
 function assertAvailable(variable, searchKey) {
     if (variable === undefined) {
         throw new NotAvailableError(_lt("Did not find value '%s' in [[FUNCTION_NAME]] evaluation.", toString(searchKey)));
     }
 }
 // -----------------------------------------------------------------------------
+// ADDRESS
+// -----------------------------------------------------------------------------
+const ADDRESS = {
+    description: _lt("Returns a cell reference as a string. "),
+    args: [
+        arg("row (number)", _lt("The row number of the cell reference. ")),
+        arg("column (number)", _lt("The column number (not name) of the cell reference. A is column number 1. ")),
+        arg(`absolute_relative_mode (number, default=${DEFAULT_ABSOLUTE_RELATIVE_MODE})`, _lt("An indicator of whether the reference is row/column absolute. 1 is row and column absolute (e.g. $A$1), 2 is row absolute and column relative (e.g. A$1), 3 is row relative and column absolute (e.g. $A1), and 4 is row and column relative (e.g. A1).")),
+        arg("use_a1_notation (boolean, default=TRUE)", _lt("A boolean indicating whether to use A1 style notation (TRUE) or R1C1 style notation (FALSE).")),
+        arg("sheet (string, optional)", _lt("A string indicating the name of the sheet into which the address points.")),
+    ],
+    returns: ["STRING"],
+    compute: function (row, column, absoluteRelativeMode = DEFAULT_ABSOLUTE_RELATIVE_MODE, useA1Notation = true, sheet) {
+        const rowNumber = strictToInteger(row);
+        const colNumber = strictToInteger(column);
+        assertNumberGreaterThanOrEqualToOne(rowNumber);
+        assertNumberGreaterThanOrEqualToOne(colNumber);
+        const _absoluteRelativeMode = strictToInteger(absoluteRelativeMode);
+        assert(() => [1, 2, 3, 4].includes(_absoluteRelativeMode), expectNumberRangeError(1, 4, _absoluteRelativeMode));
+        const _useA1Notation = toBoolean(useA1Notation);
+        let cellReference;
+        if (_useA1Notation) {
+            const rangePart = {
+                rowFixed: [1, 2].includes(_absoluteRelativeMode) ? true : false,
+                colFixed: [1, 3].includes(_absoluteRelativeMode) ? true : false,
+            };
+            cellReference = toXC(colNumber - 1, rowNumber - 1, rangePart);
+        }
+        else {
+            const rowPart = [1, 2].includes(_absoluteRelativeMode) ? `R${rowNumber}` : `R[${rowNumber}]`;
+            const colPart = [1, 3].includes(_absoluteRelativeMode) ? `C${colNumber}` : `C[${colNumber}]`;
+            cellReference = rowPart + colPart;
+        }
+        if (sheet !== undefined) {
+            return `${getComposerSheetName(toString(sheet))}!${cellReference}`;
+        }
+        return cellReference;
+    },
+    isExported: true,
+};
+// -----------------------------------------------------------------------------
 // COLUMN
 // -----------------------------------------------------------------------------
 const COLUMN = {
@@ -15194,6 +15348,7 @@ const XLOOKUP = {
 
 var lookup = /*#__PURE__*/Object.freeze({
   __proto__: null,
+  ADDRESS: ADDRESS,
   COLUMN: COLUMN,
   COLUMNS: COLUMNS,
   HLOOKUP: HLOOKUP,
@@ -19549,6 +19704,13 @@ css /* scss */ `
       pointer-events: none;
     }
   }
+
+  .o-topbar-composer .o-composer:empty:not(:focus)::before {
+    /* svg free of use from https://uxwing.com/formula-fx-icon/ */
+    content: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 121.8 122.9' width='16' height='16' focusable='false'%3E%3Cpath d='m28 34-4 5v2h10l-6 40c-4 22-6 28-7 30-2 2-3 3-5 3-3 0-7-2-9-4H4c-2 2-4 4-4 7s4 6 8 6 9-2 15-8c8-7 13-17 18-39l7-35 13-1 3-6H49c4-23 7-27 11-27 2 0 5 2 8 6h4c1-1 4-4 4-7 0-2-3-6-9-6-5 0-13 4-20 10-6 7-9 14-11 24h-8zm41 16c4-5 7-7 8-7s2 1 5 9l3 12c-7 11-12 17-16 17l-3-1-2-1c-3 0-6 3-6 7s3 7 7 7c6 0 12-6 22-23l3 10c3 9 6 13 10 13 5 0 11-4 18-15l-3-4c-4 6-7 8-8 8-2 0-4-3-6-10l-5-15 8-10 6-4 3 1 3 2c2 0 6-3 6-7s-2-7-6-7c-6 0-11 5-21 20l-2-6c-3-9-5-14-9-14-5 0-12 6-18 15l3 3z' fill='%23BDBDBD' /%3E%3C/svg%3E");
+    position: relative;
+    top: 20%;
+  }
 `;
 class Composer extends Component {
     constructor() {
@@ -20199,20 +20361,10 @@ const CSS$1 = css /* scss */ `
     justify-content: center;
     width: ${FILTER_ICON_EDGE_LENGTH}px;
     height: ${FILTER_ICON_EDGE_LENGTH}px;
-
-    svg {
-      path {
-        fill: ${FILTERS_COLOR};
-      }
-    }
   }
   .o-filter-icon:hover {
     background: ${FILTERS_COLOR};
-    svg {
-      path {
-        fill: white;
-      }
-    }
+    color: #fff;
   }
 `;
 class FilterIcon extends Component {
@@ -39421,7 +39573,6 @@ function interactiveRenameSheet(env, sheetId, name, errorCallback) {
 
 css /* scss */ `
   .o-sheet {
-    color: #666;
     padding: 0 15px;
     padding-right: 10px;
     height: ${BOTTOMBAR_HEIGHT}px;
@@ -39809,6 +39960,7 @@ class DOMDndHelper {
 const MENU_MAX_HEIGHT = 250;
 css /* scss */ `
   .o-spreadsheet-bottom-bar {
+    color: ${TEXT_HEADER_COLOR};
     background-color: ${BACKGROUND_GRAY_COLOR};
     padding-left: ${HEADER_WIDTH}px;
     font-size: 15px;
@@ -40472,6 +40624,7 @@ TopBarComposer.props = {
 css /* scss */ `
   .o-font-size-editor {
     input.o-font-size {
+      outline-color: ${SELECTION_BORDER_COLOR};
       height: 20px;
       width: 23px;
     }
@@ -40584,52 +40737,53 @@ const FORMATS = [
 const CUSTOM_FORMATS = [
     { name: "custom_currency", text: NumberFormatTerms.CustomCurrency, sidePanel: "CustomCurrency" },
 ];
-const FONT_COLOR = "#4a4f59";
-const ACTIVE_BG_COLOR = "#E6F4EA";
-const ACTIVE_FG_COLOR = "#188038";
-const HOVERED_BG_COLOR = "#f6f7fa";
-const HOVERED_FG_COLOR = "#000000";
+const ICONS_COLOR = "#4A4F59";
+// If we ever change these colors, make sure the filter tool stays green to match the icon in the grid
+const ACTIVE_BG_COLOR = BACKGROUND_HEADER_FILTER_COLOR;
+const ACTIVE_FONT_COLOR = FILTERS_COLOR;
+const HOVERED_BG_COLOR = BG_HOVER_COLOR;
+const HOVERED_FONT_COLOR = "#000";
 // -----------------------------------------------------------------------------
 // TopBar
 // -----------------------------------------------------------------------------
 css /* scss */ `
   .o-spreadsheet-topbar {
-    background-color: white;
     line-height: 1.2;
-    display: flex;
-    flex-direction: column;
     font-size: 13px;
-    line-height: 1.2;
-    user-select: none;
     font-weight: 500;
-    color: ${FONT_COLOR};
+
+    .o-topbar-hoverable {
+      cursor: pointer;
+      .o-icon {
+        color: ${ICONS_COLOR};
+      }
+      &:not(.o-disabled):not(.active):hover {
+        background-color: ${HOVERED_BG_COLOR};
+        color: ${HOVERED_FONT_COLOR};
+        .o-icon {
+          color: ${HOVERED_FONT_COLOR};
+        }
+      }
+      &.active {
+        background-color: ${ACTIVE_BG_COLOR};
+        color: ${ACTIVE_FONT_COLOR};
+        .o-icon {
+          color: ${ACTIVE_FONT_COLOR};
+        }
+      }
+    }
 
     .o-topbar-top {
       border-bottom: 1px solid ${SEPARATOR_COLOR};
-      display: flex;
       padding: 2px 10px;
-      justify-content: space-between;
 
       /* Menus */
       .o-topbar-topleft {
-        display: flex;
         .o-topbar-menu {
           padding: 4px 6px;
           margin: 0 2px;
-          cursor: pointer;
-        }
-
-        .o-topbar-menu:hover,
-        .o-topbar-menu-active {
-          background-color: #f1f3f4;
-          border-radius: 2px;
         }
       }
-
-      .o-topbar-topright {
-        display: flex;
-        justify-content: flex-end;
-      }
     }
 
     .o-topbar-composer {
@@ -40638,13 +40792,9 @@ css /* scss */ `
 
     /* Toolbar */
     .o-topbar-toolbar {
-      flex-shrink: 0;
-      display: flex;
       height: ${TOPBAR_TOOLBAR_HEIGHT}px;
 
       .o-readonly-toolbar {
-        display: flex;
-        align-items: center;
         background-color: ${BACKGROUND_HEADER_COLOR};
         padding-left: 18px;
         padding-right: 18px;
@@ -40652,11 +40802,6 @@ css /* scss */ `
 
       /* Toolbar */
       .o-toolbar-tools {
-        display: flex;
-        flex-shrink: 0;
-        margin-left: 16px;
-        cursor: default;
-
         .o-tool {
           display: flex;
           justify-content: center;
@@ -40664,40 +40809,13 @@ css /* scss */ `
           margin: 2px;
           padding: 0px 3px;
           border-radius: 2px;
-          cursor: pointer;
           min-width: 20px;
-          svg path,
-          polygon,
-          rect {
-            fill: ${FONT_COLOR};
-          }
-        }
-
-        .o-tool-outlined {
-          background-color: rgba(0, 0, 0, 0.08);
         }
 
         .o-filter-tool {
           margin-right: 8px;
         }
 
-        .o-tool.active {
-          background-color: ${ACTIVE_BG_COLOR};
-          svg path,
-          polygon,
-          rect {
-            fill: ${ACTIVE_FG_COLOR};
-          }
-        }
-        .o-tool:not(.o-disabled):hover {
-          background-color: ${HOVERED_BG_COLOR};
-          svg path,
-          polygon,
-          rect {
-            fill: ${HOVERED_FG_COLOR};
-          }
-        }
-
         .o-border-dropdown {
           padding: 4px;
         }
@@ -40723,10 +40841,6 @@ css /* scss */ `
             height: 30px;
           }
 
-          .o-text-icon {
-            line-height: 30px;
-          }
-
           .o-text-options > div {
             line-height: 26px;
             padding: 3px 12px;
@@ -40745,14 +40859,6 @@ css /* scss */ `
             box-shadow: 1px 2px 5px 2px rgba(51, 51, 51, 0.15);
             background-color: white;
 
-            .o-dropdown-item {
-              cursor: pointer;
-            }
-
-            .o-dropdown-item:hover {
-              background-color: rgba(0, 0, 0, 0.08);
-            }
-
             .o-dropdown-line {
               display: flex;
               margin: 1px;
@@ -40761,11 +40867,6 @@ css /* scss */ `
                 padding: 4px;
                 width: 18px;
                 height: 18px;
-                cursor: pointer;
-
-                &:hover {
-                  background-color: rgba(0, 0, 0, 0.08);
-                }
               }
             }
 
@@ -40777,7 +40878,7 @@ css /* scss */ `
                 padding: 0 20px;
                 white-space: nowrap;
 
-                &.active:before {
+                &.o-dropdown-active:before {
                   content: "✓";
                   font-weight: bold;
                   position: absolute;
@@ -44945,6 +45046,6 @@ function addFunction(functionName, functionDescription) {
 export { AbstractChart, CommandResult, CorePlugin, DATETIME_FORMAT, DispatchResult, EvaluationError, Model, Registry, Revision, SPREADSHEET_DIMENSIONS, Spreadsheet, UIPlugin, __info__, addFunction, astToFormula, compile, components, convertAstNodes, coreTypes, findCellInNewZone, functionCache, helpers, invalidateEvaluationCommands, links, load, parse, readonlyAllowedCommands, registries, setTranslationMethod, tokenize };
 
 
-__info__.version = '16.2.0';
-__info__.date = '2023-03-15T15:03:34.107Z';
-__info__.hash = 'c74b1d1';
+__info__.version = '16.3.0-alpha.1';
+__info__.date = '2023-03-16T12:12:26.034Z';
+__info__.hash = 'f41d64a';