@odoo/o-spreadsheet 16.2.26 → 16.2.27

package/dist/o-spreadsheet.cjs.js

@@ -290,15 +290,76 @@ const FONT_SIZES = [6, 7, 8, 9, 10, 11, 12, 14, 18, 24, 36];
 // -----------------------------------------------------------------------------
 // Date Type
 // -----------------------------------------------------------------------------
+/**
+ * A DateTime object that can be used to manipulate spreadsheet dates.
+ * Conceptually, a spreadsheet date is simply a number with a date format,
+ * and it is timezone-agnostic.
+ * This DateTime object consistently uses UTC time to represent a naive date and time.
+ */
+class DateTime {
+    constructor(year, month, day, hours = 0, minutes = 0, seconds = 0) {
+        this.jsDate = new Date(Date.UTC(year, month, day, hours, minutes, seconds, 0));
+    }
+    static fromTimestamp(timestamp) {
+        const date = new Date(timestamp);
+        return new DateTime(date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate(), date.getUTCHours(), date.getUTCMinutes(), date.getUTCSeconds());
+    }
+    static now() {
+        const now = new Date();
+        return new DateTime(now.getFullYear(), now.getMonth(), now.getDate(), now.getHours(), now.getMinutes(), now.getSeconds());
+    }
+    toString() {
+        return this.jsDate.toString();
+    }
+    getTime() {
+        return this.jsDate.getTime();
+    }
+    getFullYear() {
+        return this.jsDate.getUTCFullYear();
+    }
+    getMonth() {
+        return this.jsDate.getUTCMonth();
+    }
+    getDate() {
+        return this.jsDate.getUTCDate();
+    }
+    getDay() {
+        return this.jsDate.getUTCDay();
+    }
+    getHours() {
+        return this.jsDate.getUTCHours();
+    }
+    getMinutes() {
+        return this.jsDate.getUTCMinutes();
+    }
+    getSeconds() {
+        return this.jsDate.getUTCSeconds();
+    }
+    setFullYear(year) {
+        this.jsDate.setFullYear(year);
+    }
+    setDate(date) {
+        this.jsDate.setUTCDate(date);
+    }
+    setHours(hours) {
+        this.jsDate.setUTCHours(hours);
+    }
+    setMinutes(minutes) {
+        this.jsDate.setUTCMinutes(minutes);
+    }
+    setSeconds(seconds) {
+        this.jsDate.setUTCSeconds(seconds);
+    }
+}
 // -----------------------------------------------------------------------------
 // Parsing
 // -----------------------------------------------------------------------------
-const INITIAL_1900_DAY = new Date(1899, 11, 30);
+const INITIAL_1900_DAY = new DateTime(1899, 11, 30);
 const MS_PER_DAY = 24 * 60 * 60 * 1000;
 const CURRENT_MILLENIAL = 2000; // note: don't forget to update this in 2999
-const CURRENT_YEAR = new Date().getFullYear();
-const INITIAL_JS_DAY = new Date(0);
-const DATE_JS_1900_OFFSET = INITIAL_JS_DAY - INITIAL_1900_DAY;
+const CURRENT_YEAR = DateTime.now().getFullYear();
+const INITIAL_JS_DAY = DateTime.fromTimestamp(0);
+const DATE_JS_1900_OFFSET = INITIAL_JS_DAY.getTime() - INITIAL_1900_DAY.getTime();
 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+)?))$/;
@@ -347,7 +408,7 @@ function _parseDateTime(str) {
         return {
             value: date.value + time.value,
             format: date.format + " " + (time.format === "hhhh:mm:ss" ? "hh:mm:ss" : time.format),
-            jsDate: new Date(date.jsDate.getFullYear() + time.jsDate.getFullYear() - 1899, date.jsDate.getMonth() + time.jsDate.getMonth() - 11, date.jsDate.getDate() + time.jsDate.getDate() - 30, date.jsDate.getHours() + time.jsDate.getHours(), date.jsDate.getMinutes() + time.jsDate.getMinutes(), date.jsDate.getSeconds() + time.jsDate.getSeconds()),
+            jsDate: new DateTime(date.jsDate.getFullYear() + time.jsDate.getFullYear() - 1899, date.jsDate.getMonth() + time.jsDate.getMonth() - 11, date.jsDate.getDate() + time.jsDate.getDate() - 30, date.jsDate.getHours() + time.jsDate.getHours(), date.jsDate.getMinutes() + time.jsDate.getMinutes(), date.jsDate.getSeconds() + time.jsDate.getSeconds()),
         };
     }
     return date || time;
@@ -364,13 +425,13 @@ function parseDate(str, dateFormat) {
         const day = Number(parts[dayIndex]);
         const leadingZero = (parts[monthIndex].length === 2 && month < 10) || (parts[dayIndex].length === 2 && day < 10);
         const year = parts[yearIndex] ? inferYear(parts[yearIndex]) : CURRENT_YEAR;
-        const jsDate = new Date(year, month - 1, day);
+        const jsDate = new DateTime(year, month - 1, day);
         const sep = str.match(/\/|-|\s/)[0];
         if (jsDate.getMonth() !== month - 1 || jsDate.getDate() !== day) {
             // invalid date
             return null;
         }
-        const delta = jsDate - INITIAL_1900_DAY;
+        const delta = jsDate.getTime() - INITIAL_1900_DAY.getTime();
         let format = leadingZero ? `mm${sep}dd` : `m${sep}d`;
         if (parts[yearIndex]) {
             format = isMDY ? format + sep + "yyyy" : "yyyy" + sep + format;
@@ -430,7 +491,7 @@ function parseTime(str) {
         if (hours >= 24) {
             format = "hhhh:mm:ss";
         }
-        const jsDate = new Date(1899, 11, 30, hours, minutes, seconds);
+        const jsDate = new DateTime(1899, 11, 30, hours, minutes, seconds);
         return {
             value: hours / 24 + minutes / 1440 + seconds / 86400,
             format: format,
@@ -444,7 +505,7 @@ function parseTime(str) {
 // -----------------------------------------------------------------------------
 function numberToJsDate(value) {
     const truncValue = Math.trunc(value);
-    let date = new Date(truncValue * MS_PER_DAY - DATE_JS_1900_OFFSET);
+    let date = DateTime.fromTimestamp(truncValue * MS_PER_DAY - DATE_JS_1900_OFFSET);
     let time = value - truncValue;
     time = time < 0 ? 1 + time : time;
     const hours = Math.round(time * 24);
@@ -461,7 +522,7 @@ function jsDateToRoundNumber(date) {
 }
 /** Return the number of days in the current month of the given date */
 function getDaysInMonth(date) {
-    return new Date(date.getFullYear(), date.getMonth() + 1, 0).getDate();
+    return new DateTime(date.getFullYear(), date.getMonth() + 1, 0).getDate();
 }
 function isLastDayOfMonth(date) {
     return getDaysInMonth(date) === date.getDate();
@@ -479,7 +540,7 @@ function addMonthsToDate(date, months, keepEndOfMonth) {
     const yStart = date.getFullYear();
     const mStart = date.getMonth();
     const dStart = date.getDate();
-    const jsDate = new Date(yStart, mStart + months);
+    const jsDate = new DateTime(yStart, mStart + months, 1);
     if (keepEndOfMonth && dStart === getDaysInMonth(date)) {
         jsDate.setDate(getDaysInMonth(jsDate));
     }
@@ -1900,7 +1961,7 @@ function formatJSTime(jsDate, format) {
         .map((p) => {
         switch (p) {
             case "hhhh":
-                const helapsedHours = Math.floor((jsDate.getTime() - INITIAL_1900_DAY) / (60 * 60 * 1000));
+                const helapsedHours = Math.floor((jsDate.getTime() - INITIAL_1900_DAY.getTime()) / (60 * 60 * 1000));
                 return helapsedHours.toString();
             case "hh":
                 return hours.toString().padStart(2, "0");
@@ -9496,6 +9557,9 @@ function arg(definition, description = "") {
 function makeArg(str) {
     let parts = str.match(ARG_REGEXP);
     let name = parts[1].trim();
+    if (!name) {
+        throw new Error(`Function argument definition is missing a name: '${str}'.`);
+    }
     let types = [];
     let isOptional = false;
     let isRepeating = false;
@@ -11959,7 +12023,7 @@ const DATE = {
         if (_year < 1900) {
             _year += 1900;
         }
-        const jsDate = new Date(_year, _month - 1, _day);
+        const jsDate = new DateTime(_year, _month - 1, _day);
         const result = jsDateToRoundNumber(jsDate);
         assert(() => result >= 0, _lt(`The function [[FUNCTION_NAME]] result must be greater than or equal 01/01/1900.`));
         return result;
@@ -12067,7 +12131,7 @@ const EOMONTH = {
         const _months = Math.trunc(toNumber(months));
         const yStart = _startDate.getFullYear();
         const mStart = _startDate.getMonth();
-        const jsDate = new Date(yStart, mStart + _months + 1, 0);
+        const jsDate = new DateTime(yStart, mStart + _months + 1, 0);
         return jsDateToRoundNumber(jsDate);
     },
     isExported: true,
@@ -12104,17 +12168,17 @@ const ISOWEEKNUM = {
         // The first week of the year is the week that contains the first
         // Thursday of the year.
         let firstThursday = 1;
-        while (new Date(y, 0, firstThursday).getDay() !== 4) {
+        while (new DateTime(y, 0, firstThursday).getDay() !== 4) {
             firstThursday += 1;
         }
-        const firstDayOfFirstWeek = new Date(y, 0, firstThursday - 3);
+        const firstDayOfFirstWeek = new DateTime(y, 0, firstThursday - 3);
         // The last week of the year is the week that contains the last Thursday of
         // the year.
         let lastThursday = 31;
-        while (new Date(y, 11, lastThursday).getDay() !== 4) {
+        while (new DateTime(y, 11, lastThursday).getDay() !== 4) {
             lastThursday -= 1;
         }
-        const lastDayOfLastWeek = new Date(y, 11, lastThursday + 3);
+        const lastDayOfLastWeek = new DateTime(y, 11, lastThursday + 3);
         // B - If our date > lastDayOfLastWeek then it's in the weeks of the year after
         // If our date < firstDayOfFirstWeek then it's in the weeks of the year before
         let offsetYear;
@@ -12140,17 +12204,17 @@ const ISOWEEKNUM = {
             case 1:
                 // firstDay is the 1st day of the 1st week of the year after
                 // firstDay = lastDayOfLastWeek + 1 Day
-                firstDay = new Date(y, 11, lastThursday + 3 + 1);
+                firstDay = new DateTime(y, 11, lastThursday + 3 + 1);
                 break;
             case -1:
                 // firstDay is the 1st day of the 1st week of the previous year.
                 // The first week of the previous year is the week that contains the
                 // first Thursday of the previous year.
                 let firstThursdayPreviousYear = 1;
-                while (new Date(y - 1, 0, firstThursdayPreviousYear).getDay() !== 4) {
+                while (new DateTime(y - 1, 0, firstThursdayPreviousYear).getDay() !== 4) {
                     firstThursdayPreviousYear += 1;
                 }
-                firstDay = new Date(y - 1, 0, firstThursdayPreviousYear - 3);
+                firstDay = new DateTime(y - 1, 0, firstThursdayPreviousYear - 3);
                 break;
         }
         const diff = (_date.getTime() - firstDay.getTime()) / MS_PER_DAY;
@@ -12285,8 +12349,8 @@ const NETWORKDAYS_INTL = {
             });
         }
         const invertDate = _startDate.getTime() > _endDate.getTime();
-        const stopDate = new Date((invertDate ? _startDate : _endDate).getTime());
-        let stepDate = new Date((invertDate ? _endDate : _startDate).getTime());
+        const stopDate = DateTime.fromTimestamp((invertDate ? _startDate : _endDate).getTime());
+        let stepDate = DateTime.fromTimestamp((invertDate ? _endDate : _startDate).getTime());
         const timeStopDate = stopDate.getTime();
         let timeStepDate = stepDate.getTime();
         let netWorkingDay = 0;
@@ -12310,8 +12374,7 @@ const NOW = {
     returns: ["DATE"],
     computeFormat: () => "m/d/yyyy hh:mm:ss",
     compute: function () {
-        let today = new Date();
-        today.setMilliseconds(0);
+        let today = DateTime.now();
         const delta = today.getTime() - INITIAL_1900_DAY.getTime();
         const time = today.getHours() / 24 + today.getMinutes() / 1440 + today.getSeconds() / 86400;
         return Math.floor(delta / MS_PER_DAY) + time;
@@ -12381,8 +12444,8 @@ const TODAY = {
     returns: ["DATE"],
     computeFormat: () => "m/d/yyyy",
     compute: function () {
-        const today = new Date();
-        const jsDate = new Date(today.getFullYear(), today.getMonth(), today.getDate());
+        const today = DateTime.now();
+        const jsDate = new DateTime(today.getFullYear(), today.getMonth(), today.getDate());
         return jsDateToRoundNumber(jsDate);
     },
     isExported: true,
@@ -12437,10 +12500,10 @@ const WEEKNUM = {
         }
         const y = _date.getFullYear();
         let dayStart = 1;
-        let startDayOfFirstWeek = new Date(y, 0, dayStart);
+        let startDayOfFirstWeek = new DateTime(y, 0, dayStart);
         while (startDayOfFirstWeek.getDay() !== startDayOfWeek) {
             dayStart += 1;
-            startDayOfFirstWeek = new Date(y, 0, dayStart);
+            startDayOfFirstWeek = new DateTime(y, 0, dayStart);
         }
         const dif = (_date.getTime() - startDayOfFirstWeek.getTime()) / MS_PER_DAY;
         if (dif < 0) {
@@ -12494,7 +12557,7 @@ const WORKDAY_INTL = {
                 timesHoliday.add(holiday.getTime());
             });
         }
-        let stepDate = new Date(_startDate.getTime());
+        let stepDate = DateTime.fromTimestamp(_startDate.getTime());
         let timeStepDate = stepDate.getTime();
         const unitDay = Math.sign(_numDays);
         let stepDay = Math.abs(_numDays);
@@ -12556,7 +12619,7 @@ const MONTH_START = {
         const _startDate = toJsDate(date);
         const yStart = _startDate.getFullYear();
         const mStart = _startDate.getMonth();
-        const jsDate = new Date(yStart, mStart, 1);
+        const jsDate = new DateTime(yStart, mStart, 1);
         return jsDateToRoundNumber(jsDate);
     },
 };
@@ -12594,7 +12657,7 @@ const QUARTER_START = {
     compute: function (date) {
         const quarter = QUARTER.compute(date);
         const year = YEAR.compute(date);
-        const jsDate = new Date(year, (quarter - 1) * 3, 1);
+        const jsDate = new DateTime(year, (quarter - 1) * 3, 1);
         return jsDateToRoundNumber(jsDate);
     },
 };
@@ -12609,7 +12672,7 @@ const QUARTER_END = {
     compute: function (date) {
         const quarter = QUARTER.compute(date);
         const year = YEAR.compute(date);
-        const jsDate = new Date(year, quarter * 3, 0);
+        const jsDate = new DateTime(year, quarter * 3, 0);
         return jsDateToRoundNumber(jsDate);
     },
 };
@@ -12623,7 +12686,7 @@ const YEAR_START = {
     computeFormat: () => "m/d/yyyy",
     compute: function (date) {
         const year = YEAR.compute(date);
-        const jsDate = new Date(year, 0, 1);
+        const jsDate = new DateTime(year, 0, 1);
         return jsDateToRoundNumber(jsDate);
     },
 };
@@ -12637,7 +12700,7 @@ const YEAR_END = {
     computeFormat: () => "m/d/yyyy",
     compute: function (date) {
         const year = YEAR.compute(date);
-        const jsDate = new Date(year + 1, 0, 0);
+        const jsDate = new DateTime(year + 1, 0, 0);
         return jsDateToRoundNumber(jsDate);
     },
 };
@@ -12684,8 +12747,8 @@ const DEFAULT_DELTA_ARG = 0;
 const DELTA = {
     description: _lt("Compare two numeric values, returning 1 if they're equal."),
     args: [
-        arg(" (number)", _lt("The first number to compare.")),
-        arg(` (number, default=${DEFAULT_DELTA_ARG})`, _lt("The second number to compare.")),
+        arg("number1 (number)", _lt("The first number to compare.")),
+        arg(`number2 (number, default=${DEFAULT_DELTA_ARG})`, _lt("The second number to compare.")),
     ],
     returns: ["NUMBER"],
     compute: function (number1, number2 = DEFAULT_DELTA_ARG) {
@@ -12771,7 +12834,7 @@ function assertDeprecationFactorStrictlyPositive(factor) {
 function assertSettlementLessThanOneYearBeforeMaturity(settlement, maturity) {
     const startDate = toJsDate(settlement);
     const endDate = toJsDate(maturity);
-    const startDatePlusOneYear = new Date(startDate);
+    const startDatePlusOneYear = toJsDate(settlement);
     startDatePlusOneYear.setFullYear(startDate.getFullYear() + 1);
     assert(() => endDate.getTime() <= startDatePlusOneYear.getTime(), _lt("The settlement date (%s) must at most one year after the maturity date (%s).", settlement.toString(), maturity.toString()));
 }
@@ -12906,7 +12969,7 @@ const AMORLINC = {
         arg("salvage (number)", _lt("The value of the asset at the end of depreciation.")),
         arg("period (number)", _lt("The single period within life for which to calculate depreciation.")),
         arg("rate (number)", _lt("The deprecation rate.")),
-        arg(" (number, optional)", _lt("An indicator of what day count method to use.")),
+        arg("day_count_convention (number, optional)", _lt("An indicator of what day count method to use.")),
     ],
     returns: ["NUMBER"],
     compute: function (cost, purchaseDate, firstPeriodEnd, salvage, period, rate, dayCountConvention = DEFAULT_DAY_COUNT_CONVENTION) {
@@ -15850,8 +15913,8 @@ const MID = {
     description: _lt("A segment of a string."),
     args: [
         arg("text (string)", _lt("The string to extract a segment from.")),
-        arg(" (number)", _lt("The index from the left of string from which to begin extracting. The first character in string has the index 1.")),
-        arg(" (number)", _lt("The length of the segment to extract.")),
+        arg("starting_at (number)", _lt("The index from the left of string from which to begin extracting. The first character in string has the index 1.")),
+        arg("extract_length (number)", _lt("The length of the segment to extract.")),
     ],
     returns: ["STRING"],
     compute: function (text, starting_at, extract_length) {
@@ -45601,6 +45664,6 @@ exports.setTranslationMethod = setTranslationMethod;
 exports.tokenize = tokenize;
 
 
-__info__.version = '16.2.26';
-__info__.date = '2024-01-04T16:19:52.806Z';
-__info__.hash = 'ef51232';
+__info__.version = '16.2.27';
+__info__.date = '2024-01-12T13:42:07.889Z';
+__info__.hash = 'd8b1d67';

package/dist/o-spreadsheet.d.ts

@@ -202,6 +202,33 @@ declare function toCartesian(xc: string): Position$1;
  */
 declare function toXC(col: HeaderIndex, row: HeaderIndex, rangePart?: RangePart): string;
 
+/**
+ * A DateTime object that can be used to manipulate spreadsheet dates.
+ * Conceptually, a spreadsheet date is simply a number with a date format,
+ * and it is timezone-agnostic.
+ * This DateTime object consistently uses UTC time to represent a naive date and time.
+ */
+declare class DateTime {
+    private jsDate;
+    constructor(year: number, month: number, day: number, hours?: number, minutes?: number, seconds?: number);
+    static fromTimestamp(timestamp: number): DateTime;
+    static now(): DateTime;
+    toString(): string;
+    getTime(): number;
+    getFullYear(): number;
+    getMonth(): number;
+    getDate(): number;
+    getDay(): number;
+    getHours(): number;
+    getMinutes(): number;
+    getSeconds(): number;
+    setFullYear(year: number): void;
+    setDate(date: number): void;
+    setHours(hours: number): void;
+    setMinutes(minutes: number): void;
+    setSeconds(seconds: number): void;
+}
+
 /**
  * Formats a cell value with its format.
  */
@@ -6592,7 +6619,7 @@ declare class ChartPanel extends Component<Props, SpreadsheetChildEnv> {
 declare function toNumber(value: string | number | boolean | null | undefined): number;
 declare function toString(value: string | number | boolean | null | undefined): string;
 declare function toBoolean(value: string | number | boolean | null | undefined): boolean;
-declare function toJsDate(value: string | number | boolean | null | undefined): Date;
+declare function toJsDate(value: string | number | boolean | null | undefined): DateTime;
 
 declare function arg(definition: string, description?: string): ArgDefinition;