chrono-node 2.8.2 → 2.8.3

package/src/utils/timeunits.ts

@@ -1,8 +1,14 @@
 import { OpUnitType, QUnitType } from "dayjs";
 import { ParsingComponents } from "../results";
 
+/**
+ * @deprecated Use `calculation.duration.Duration`.
+ */
 export type TimeUnits = { [c in OpUnitType | QUnitType]?: number };
 
+/**
+ * @deprecated Use `calculation.duration.*`.
+ */
 export function reverseTimeUnits(timeUnits: TimeUnits): TimeUnits {
     const reversed = {};
     for (const key in timeUnits) {
@@ -13,6 +19,9 @@ export function reverseTimeUnits(timeUnits: TimeUnits): TimeUnits {
     return reversed as TimeUnits;
 }
 
+/**
+ * @deprecated Use `calculation.duration.*`.
+ */
 export function addImpliedTimeUnits(components: ParsingComponents, timeUnits: TimeUnits): ParsingComponents {
     const output = components.clone();
 

package/test/calculation_duration.test.ts

@@ -0,0 +1,165 @@
+import { addDuration, reverseDuration } from "../src/calculation/duration";
+
+test("Test - Adding Duration w/ single timeunit", () => {
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "year": 1 });
+        expect(output).toStrictEqual(new Date("Sun, Aug 27 2023 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "month": 1 });
+        expect(output).toStrictEqual(new Date("Wed, Sep 27 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "week": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Sep 3 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "day": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 28 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "hour": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 13:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "minute": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:53:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "second": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:12"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11:00");
+        const output = addDuration(reference, { "millisecond": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:11:01"));
+    }
+});
+
+test("Test - Adding Duration w/ single timeunit shorten", () => {
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "y": 1 });
+        expect(output).toStrictEqual(new Date("Sun, Aug 27 2023 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "M": 1 });
+        expect(output).toStrictEqual(new Date("Wed, Sep 27 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "w": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Sep 3 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "d": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 28 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "h": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 13:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "m": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:53:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "s": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:12"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11:00");
+        const output = addDuration(reference, { "ms": 1 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:11:01"));
+    }
+});
+
+test("Test - Adding Duration w/ multiple timeunits", () => {
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "month": 1, "day": 4 });
+        expect(output).toStrictEqual(new Date("Wed, Oct 1 2022 12:52:11"));
+    }
+    {
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "month": 1, "day": 4, "hour": 12 });
+        expect(output).toStrictEqual(new Date("Wed, Oct 2 2022 00:52:11"));
+    }
+});
+
+test("Test - Adding Duration w/ fractions", () => {
+    {
+        // 0.5 year (aka. half year) => 6 months
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "year": 0.5 });
+        expect(output).toStrictEqual(new Date("Mon, Feb 27 2023 12:52:11"));
+    }
+    {
+        // 0.5 month => 2 weeks
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "month": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Sep 10 2022 12:52:11"));
+    }
+    {
+        // 0.5 week => 4 days (actually 3.5 days, but we round up to 4 days)
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "week": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 31 2022 12:52:11"));
+    }
+    {
+        // 0.5 day (aka. half day) => 12 hours
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "day": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 28 2022 00:52:11"));
+    }
+    {
+        // 0.5 hour (aka. half hour) => 30 minutes
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "hour": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 13:22:11"));
+    }
+    {
+        // 0.5 minute (aka. half minute) => 30 seconds
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "minute": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:41"));
+    }
+    {
+        // 0.5 second (aka. half second) => 500 milliseconds
+        const reference = new Date("Sat, Aug 27 2022 12:52:11:00");
+        const output = addDuration(reference, { "second": 0.5 });
+        expect(output).toStrictEqual(new Date("Sat, Aug 27 2022 12:52:11:500"));
+    }
+});
+
+test("Test - Adding Duration w/ multiple fractions", () => {
+    {
+        // 0.5 year (aka. half year) => 6 months
+        const reference = new Date("Sat, Aug 27 2022 12:52:11");
+        const output = addDuration(reference, { "year": 0.5, "month": 2 });
+        expect(output).toStrictEqual(new Date("Thu, April 27 2023 12:52:11"));
+    }
+});
+
+test("Test - Reverse Duration", () => {
+    {
+        const timeunits = { year: 5, month: 5 };
+        expect(reverseDuration(timeunits)).toStrictEqual({ year: -5, month: -5 });
+    }
+    {
+        const timeunits = { year: -5, month: -5 };
+        expect(reverseDuration(timeunits)).toStrictEqual({ year: 5, month: 5 });
+    }
+});

package/test/{calculation.test.ts → calculation_weekdays.test.ts}

@@ -1,4 +1,4 @@
-import { createParsingComponentsAtWeekday, getDaysToWeekday } from "../src/common/calculation/weekdays";
+import { createParsingComponentsAtWeekday, getDaysToWeekday } from "../src/calculation/weekdays";
 import { Weekday } from "../src";
 import { ReferenceWithTimezone } from "../src/results";
 

package/test/en/en_month_name_little_endian.test.ts

@@ -212,6 +212,25 @@ test("Test - Range expression", () => {
         expect(result.end).toBeDate(new Date(2013, 9 - 1, 12, 12));
     });
 
+    testSingleCase(chrono, "10 August 2013 - 12 September", new Date(2012, 7, 10), (result) => {
+        expect(result.index).toBe(0);
+        expect(result.text).toBe("10 August 2013 - 12 September");
+
+        expect(result.start).not.toBeNull();
+        expect(result.start.get("year")).toBe(2013);
+        expect(result.start.get("month")).toBe(8);
+        expect(result.start.get("day")).toBe(10);
+
+        expect(result.start).toBeDate(new Date(2013, 8 - 1, 10, 12));
+
+        expect(result.end).not.toBeNull();
+        expect(result.end.get("year")).toBe(2013);
+        expect(result.end.get("month")).toBe(9);
+        expect(result.end.get("day")).toBe(12);
+
+        expect(result.end).toBeDate(new Date(2013, 9 - 1, 12, 12));
+    });
+
     testSingleCase(chrono, " 17 August 2013 to 19 August 2013", new Date(2012, 7, 10), (result) => {
         expect(result.text).toBe("17 August 2013 to 19 August 2013");
 

package/test/en/en_time_exp.test.ts

@@ -27,6 +27,20 @@ test("Test - Time expression", function () {
     });
 });
 
+test("Test - Time expression with clues", () => {
+    testSingleCase(chrono, "1 at night", new Date(2016, 10 - 1, 1, 8), (result, text) => {
+        expect(result.text).toBe(text);
+        expect(result.start.get("hour")).toBe(1);
+        expect(result.start.get("meridiem")).toBe(Meridiem.AM);
+    });
+
+    testSingleCase(chrono, "1 in the afternoon", new Date(2016, 10 - 1, 1, 8), (result, text) => {
+        expect(result.text).toBe(text);
+        expect(result.start.get("hour")).toBe(13);
+        expect(result.start.get("meridiem")).toBe(Meridiem.PM);
+    });
+});
+
 test("Test - Time expression after date", function () {
     testSingleCase(chrono, "05/31/2024 14:15", new Date(2016, 10 - 1, 1, 8), (result, text) => {
         expect(result.text).toBe(text);

package/test/en/en_year.test.ts

@@ -98,3 +98,41 @@ test("Test - Year number after date/time expression", () => {
         expect(result.start.get("timezoneOffset")).toBe(-240);
     });
 });
+
+test("Test - Year number after date/time range expression", () => {
+    testSingleCase(chrono, "Thu Oct 26 - 28, 11:00:09 2023", new Date(2016, 10 - 1, 1, 8), (result, text) => {
+        expect(result.start.get("year")).toBe(2023);
+        expect(result.start.get("month")).toBe(10);
+        expect(result.start.get("day")).toBe(26);
+        expect(result.start.get("hour")).toBe(11);
+        expect(result.start.get("minute")).toBe(0);
+        expect(result.start.get("second")).toBe(9);
+        expect(result.start.get("meridiem")).toBe(Meridiem.AM);
+
+        expect(result.end.get("year")).toBe(2023);
+        expect(result.end.get("month")).toBe(10);
+        expect(result.end.get("day")).toBe(28);
+        expect(result.end.get("hour")).toBe(11);
+        expect(result.end.get("minute")).toBe(0);
+        expect(result.end.get("second")).toBe(9);
+        expect(result.end.get("meridiem")).toBe(Meridiem.AM);
+    });
+
+    testSingleCase(chrono, "Thu Oct 26, 10:00 - 11:00:09 2023", new Date(2016, 10 - 1, 1, 8), (result, text) => {
+        expect(result.start.get("year")).toBe(2023);
+        expect(result.start.get("month")).toBe(10);
+        expect(result.start.get("day")).toBe(26);
+        expect(result.start.get("hour")).toBe(10);
+        expect(result.start.get("minute")).toBe(0);
+        expect(result.start.get("second")).toBe(0);
+        expect(result.start.get("meridiem")).toBe(Meridiem.AM);
+
+        expect(result.end.get("year")).toBe(2023);
+        expect(result.end.get("month")).toBe(10);
+        expect(result.end.get("day")).toBe(26);
+        expect(result.end.get("hour")).toBe(11);
+        expect(result.end.get("minute")).toBe(0);
+        expect(result.end.get("second")).toBe(9);
+        expect(result.end.get("meridiem")).toBe(Meridiem.AM);
+    });
+});

package/test/en/negative_cases.test.ts

@@ -67,6 +67,11 @@ test("Test - Skip impossible dates/times", () => {
     testUnexpectedResult(chrono, "An appointment on 13/31/2018");
 });
 
+test("Test - Skip impossible dates/times ranges", () => {
+    testUnexpectedResult(chrono, "February 20 - 29, 2022");
+    testUnexpectedResult(chrono, "June 10 - 31, 2022");
+});
+
 test("Test - Skip version number pattern", () => {
     testUnexpectedResult(chrono, "Version: 1.1.3");
 

package/dist/cjs/common/calculation/weekdays.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"weekdays.js","sourceRoot":"","sources":["../../../../src/common/calculation/weekdays.ts"],"names":[],"mappings":";;AAWA,4EAaC;AAQD,4CA+BC;AAED,0DAKC;AAED,0DAOC;AAED,4DAOC;AAxFD,uCAAsC;AACtC,2CAAyE;AACzE,qDAA4D;AAS5D,SAAgB,gCAAgC,CAC5C,SAAgC,EAChC,OAAgB,EAChB,QAAmC;IAEnC,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,EAAE,CAAC;IACxD,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEnE,IAAI,UAAU,GAAG,IAAI,2BAAiB,CAAC,SAAS,CAAC,CAAC;IAClD,UAAU,GAAG,IAAA,+BAAmB,EAAC,UAAU,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;IACvE,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEtC,OAAO,UAAU,CAAC;AACtB,CAAC;AAQD,SAAgB,gBAAgB,CAAC,OAAa,EAAE,OAAgB,EAAE,QAAmC;IACjG,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAa,CAAC;IAC/C,QAAQ,QAAQ,EAAE,CAAC;QACf,KAAK,MAAM;YACP,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,KAAK,MAAM;YACP,OAAO,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,KAAK,MAAM;YAGP,IAAI,UAAU,IAAI,eAAO,CAAC,MAAM,EAAE,CAAC;gBAC/B,OAAO,OAAO,IAAI,eAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,CAAC;YAID,IAAI,UAAU,IAAI,eAAO,CAAC,QAAQ,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,eAAO,CAAC,QAAQ;oBAAE,OAAO,CAAC,CAAC;gBAC1C,IAAI,OAAO,IAAI,eAAO,CAAC,MAAM;oBAAE,OAAO,CAAC,CAAC;gBACxC,OAAO,CAAC,GAAG,OAAO,CAAC;YACvB,CAAC;YAID,IAAI,OAAO,GAAG,UAAU,IAAI,OAAO,IAAI,eAAO,CAAC,MAAM,EAAE,CAAC;gBACpD,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACJ,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;IACT,CAAC;IACD,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAAa,EAAE,OAAgB;IACnE,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE1D,OAAO,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AACpD,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAAa,EAAE,OAAgB;IACnE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,YAAY,GAAG,OAAO,GAAG,UAAU,CAAC;IACxC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QACnB,YAAY,IAAI,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED,SAAgB,wBAAwB,CAAC,OAAa,EAAE,OAAgB;IACpE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,aAAa,GAAG,OAAO,GAAG,UAAU,CAAC;IACzC,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACrB,aAAa,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,aAAa,CAAC;AACzB,CAAC"}

package/dist/esm/common/calculation/weekdays.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"weekdays.js","sourceRoot":"","sources":["../../../../src/common/calculation/weekdays.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAyB,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAS5D,MAAM,UAAU,gCAAgC,CAC5C,SAAgC,EAChC,OAAgB,EAChB,QAAmC;IAEnC,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,EAAE,CAAC;IACxD,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEnE,IAAI,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAClD,UAAU,GAAG,mBAAmB,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;IACvE,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEtC,OAAO,UAAU,CAAC;AACtB,CAAC;AAQD,MAAM,UAAU,gBAAgB,CAAC,OAAa,EAAE,OAAgB,EAAE,QAAmC;IACjG,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAa,CAAC;IAC/C,QAAQ,QAAQ,EAAE,CAAC;QACf,KAAK,MAAM;YACP,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,KAAK,MAAM;YACP,OAAO,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,KAAK,MAAM;YAGP,IAAI,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC/B,OAAO,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,CAAC;YAID,IAAI,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ;oBAAE,OAAO,CAAC,CAAC;gBAC1C,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM;oBAAE,OAAO,CAAC,CAAC;gBACxC,OAAO,CAAC,GAAG,OAAO,CAAC;YACvB,CAAC;YAID,IAAI,OAAO,GAAG,UAAU,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACpD,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACJ,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;IACT,CAAC;IACD,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAAa,EAAE,OAAgB;IACnE,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE1D,OAAO,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAAa,EAAE,OAAgB;IACnE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,YAAY,GAAG,OAAO,GAAG,UAAU,CAAC;IACxC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QACnB,YAAY,IAAI,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAa,EAAE,OAAgB;IACpE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,aAAa,GAAG,OAAO,GAAG,UAAU,CAAC;IACzC,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACrB,aAAa,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,aAAa,CAAC;AACzB,CAAC"}