chrono-node 2.3.4 → 2.3.5

package/src/locales/zh/hant/parsers/ZHHantTimeExpressionParser.ts

@@ -0,0 +1,424 @@
+import dayjs from "dayjs";
+import { ParsingContext } from "../../../../chrono";
+import { AbstractParserWithWordBoundaryChecking } from "../../../../common/parsers/AbstractParserWithWordBoundary";
+import { NUMBER, zhStringToNumber } from "../constants";
+
+const FIRST_REG_PATTERN = new RegExp(
+    "(?:由|從|自)?" +
+        "(?:" +
+        "(今|明|前|大前|後|大後|聽|昨|尋|琴)(早|朝|晚)|" +
+        "(上(?:午|晝)|朝(?:早)|早(?:上)|下(?:午|晝)|晏(?:晝)|晚(?:上)|夜(?:晚)?|中(?:午)|凌(?:晨))|" +
+        "(今|明|前|大前|後|大後|聽|昨|尋|琴)(?:日|天)" +
+        "(?:[\\s,，]*)" +
+        "(?:(上(?:午|晝)|朝(?:早)|早(?:上)|下(?:午|晝)|晏(?:晝)|晚(?:上)|夜(?:晚)?|中(?:午)|凌(?:晨)))?" +
+        ")?" +
+        "(?:[\\s,，]*)" +
+        "(?:(\\d+|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)(?:\\s*)(?:點|時|:|：)" +
+        "(?:\\s*)" +
+        "(\\d+|半|正|整|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)?(?:\\s*)(?:分|:|：)?" +
+        "(?:\\s*)" +
+        "(\\d+|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)?(?:\\s*)(?:秒)?)" +
+        "(?:\\s*(A.M.|P.M.|AM?|PM?))?",
+    "i"
+);
+
+const SECOND_REG_PATTERN = new RegExp(
+    "(?:^\\s*(?:到|至|\\-|\\–|\\~|\\〜)\\s*)" +
+        "(?:" +
+        "(今|明|前|大前|後|大後|聽|昨|尋|琴)(早|朝|晚)|" +
+        "(上(?:午|晝)|朝(?:早)|早(?:上)|下(?:午|晝)|晏(?:晝)|晚(?:上)|夜(?:晚)?|中(?:午)|凌(?:晨))|" +
+        "(今|明|前|大前|後|大後|聽|昨|尋|琴)(?:日|天)" +
+        "(?:[\\s,，]*)" +
+        "(?:(上(?:午|晝)|朝(?:早)|早(?:上)|下(?:午|晝)|晏(?:晝)|晚(?:上)|夜(?:晚)?|中(?:午)|凌(?:晨)))?" +
+        ")?" +
+        "(?:[\\s,，]*)" +
+        "(?:(\\d+|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)(?:\\s*)(?:點|時|:|：)" +
+        "(?:\\s*)" +
+        "(\\d+|半|正|整|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)?(?:\\s*)(?:分|:|：)?" +
+        "(?:\\s*)" +
+        "(\\d+|[" +
+        Object.keys(NUMBER).join("") +
+        "]+)?(?:\\s*)(?:秒)?)" +
+        "(?:\\s*(A.M.|P.M.|AM?|PM?))?",
+    "i"
+);
+
+const DAY_GROUP_1 = 1;
+const ZH_AM_PM_HOUR_GROUP_1 = 2;
+const ZH_AM_PM_HOUR_GROUP_2 = 3;
+const DAY_GROUP_3 = 4;
+const ZH_AM_PM_HOUR_GROUP_3 = 5;
+const HOUR_GROUP = 6;
+const MINUTE_GROUP = 7;
+const SECOND_GROUP = 8;
+const AM_PM_HOUR_GROUP = 9;
+
+export default class ZHHantTimeExpressionParser extends AbstractParserWithWordBoundaryChecking {
+    innerPattern(): RegExp {
+        return FIRST_REG_PATTERN;
+    }
+
+    innerExtract(context: ParsingContext, match: RegExpMatchArray) {
+        // This pattern can be overlaped Ex. [12] AM, 1[2] AM
+        if (match.index > 0 && context.text[match.index - 1].match(/\w/)) {
+            return null;
+        }
+
+        const refMoment = dayjs(context.refDate);
+        const result = context.createParsingResult(match.index, match[0]);
+        const startMoment = refMoment.clone();
+
+        // ----- Day
+        if (match[DAY_GROUP_1]) {
+            var day1 = match[DAY_GROUP_1];
+            if (day1 == "明" || day1 == "聽") {
+                // Check not "Tomorrow" on late night
+                if (refMoment.hour() > 1) {
+                    startMoment.add(1, "day");
+                }
+            } else if (day1 == "昨" || day1 == "尋" || day1 == "琴") {
+                startMoment.add(-1, "day");
+            } else if (day1 == "前") {
+                startMoment.add(-2, "day");
+            } else if (day1 == "大前") {
+                startMoment.add(-3, "day");
+            } else if (day1 == "後") {
+                startMoment.add(2, "day");
+            } else if (day1 == "大後") {
+                startMoment.add(3, "day");
+            }
+            result.start.assign("day", startMoment.date());
+            result.start.assign("month", startMoment.month() + 1);
+            result.start.assign("year", startMoment.year());
+        } else if (match[DAY_GROUP_3]) {
+            var day3 = match[DAY_GROUP_3];
+            if (day3 == "明" || day3 == "聽") {
+                startMoment.add(1, "day");
+            } else if (day3 == "昨" || day3 == "尋" || day3 == "琴") {
+                startMoment.add(-1, "day");
+            } else if (day3 == "前") {
+                startMoment.add(-2, "day");
+            } else if (day3 == "大前") {
+                startMoment.add(-3, "day");
+            } else if (day3 == "後") {
+                startMoment.add(2, "day");
+            } else if (day3 == "大後") {
+                startMoment.add(3, "day");
+            }
+            result.start.assign("day", startMoment.date());
+            result.start.assign("month", startMoment.month() + 1);
+            result.start.assign("year", startMoment.year());
+        } else {
+            result.start.imply("day", startMoment.date());
+            result.start.imply("month", startMoment.month() + 1);
+            result.start.imply("year", startMoment.year());
+        }
+
+        let hour = 0;
+        let minute = 0;
+        let meridiem = -1;
+
+        // ----- Second
+        if (match[SECOND_GROUP]) {
+            var second = parseInt(match[SECOND_GROUP]);
+            if (isNaN(second)) {
+                second = zhStringToNumber(match[SECOND_GROUP]);
+            }
+            if (second >= 60) return null;
+            result.start.assign("second", second);
+        }
+
+        hour = parseInt(match[HOUR_GROUP]);
+        if (isNaN(hour)) {
+            hour = zhStringToNumber(match[HOUR_GROUP]);
+        }
+
+        // ----- Minutes
+        if (match[MINUTE_GROUP]) {
+            if (match[MINUTE_GROUP] == "半") {
+                minute = 30;
+            } else if (match[MINUTE_GROUP] == "正" || match[MINUTE_GROUP] == "整") {
+                minute = 0;
+            } else {
+                minute = parseInt(match[MINUTE_GROUP]);
+                if (isNaN(minute)) {
+                    minute = zhStringToNumber(match[MINUTE_GROUP]);
+                }
+            }
+        } else if (hour > 100) {
+            minute = hour % 100;
+            hour = Math.floor(hour / 100);
+        }
+
+        if (minute >= 60) {
+            return null;
+        }
+
+        if (hour > 24) {
+            return null;
+        }
+        if (hour >= 12) {
+            meridiem = 1;
+        }
+
+        // ----- AM & PM
+        if (match[AM_PM_HOUR_GROUP]) {
+            if (hour > 12) return null;
+            var ampm = match[AM_PM_HOUR_GROUP][0].toLowerCase();
+            if (ampm == "a") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            }
+
+            if (ampm == "p") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_1]) {
+            var zhAMPMString1 = match[ZH_AM_PM_HOUR_GROUP_1];
+            var zhAMPM1 = zhAMPMString1[0];
+            if (zhAMPM1 == "朝" || zhAMPM1 == "早") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM1 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_2]) {
+            var zhAMPMString2 = match[ZH_AM_PM_HOUR_GROUP_2];
+            var zhAMPM2 = zhAMPMString2[0];
+            if (zhAMPM2 == "上" || zhAMPM2 == "朝" || zhAMPM2 == "早" || zhAMPM2 == "凌") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM2 == "下" || zhAMPM2 == "晏" || zhAMPM2 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_3]) {
+            var zhAMPMString3 = match[ZH_AM_PM_HOUR_GROUP_3];
+            var zhAMPM3 = zhAMPMString3[0];
+            if (zhAMPM3 == "上" || zhAMPM3 == "朝" || zhAMPM3 == "早" || zhAMPM3 == "凌") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM3 == "下" || zhAMPM3 == "晏" || zhAMPM3 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        }
+
+        result.start.assign("hour", hour);
+        result.start.assign("minute", minute);
+
+        if (meridiem >= 0) {
+            result.start.assign("meridiem", meridiem);
+        } else {
+            if (hour < 12) {
+                result.start.imply("meridiem", 0);
+            } else {
+                result.start.imply("meridiem", 1);
+            }
+        }
+
+        // ==============================================================
+        //                  Extracting the 'to' chunk
+        // ==============================================================
+
+        match = SECOND_REG_PATTERN.exec(context.text.substring(result.index + result.text.length));
+        if (!match) {
+            // Not accept number only result
+            if (result.text.match(/^\d+$/)) {
+                return null;
+            }
+            return result;
+        }
+
+        const endMoment = startMoment.clone();
+        result.end = context.createParsingComponents();
+
+        // ----- Day
+        if (match[DAY_GROUP_1]) {
+            var day1 = match[DAY_GROUP_1];
+            if (day1 == "明" || day1 == "聽") {
+                // Check not "Tomorrow" on late night
+                if (refMoment.hour() > 1) {
+                    endMoment.add(1, "day");
+                }
+            } else if (day1 == "昨" || day1 == "尋" || day1 == "琴") {
+                endMoment.add(-1, "day");
+            } else if (day1 == "前") {
+                endMoment.add(-2, "day");
+            } else if (day1 == "大前") {
+                endMoment.add(-3, "day");
+            } else if (day1 == "後") {
+                endMoment.add(2, "day");
+            } else if (day1 == "大後") {
+                endMoment.add(3, "day");
+            }
+            result.end.assign("day", endMoment.date());
+            result.end.assign("month", endMoment.month() + 1);
+            result.end.assign("year", endMoment.year());
+        } else if (match[DAY_GROUP_3]) {
+            var day3 = match[DAY_GROUP_3];
+            if (day3 == "明" || day3 == "聽") {
+                endMoment.add(1, "day");
+            } else if (day3 == "昨" || day3 == "尋" || day3 == "琴") {
+                endMoment.add(-1, "day");
+            } else if (day3 == "前") {
+                endMoment.add(-2, "day");
+            } else if (day3 == "大前") {
+                endMoment.add(-3, "day");
+            } else if (day3 == "後") {
+                endMoment.add(2, "day");
+            } else if (day3 == "大後") {
+                endMoment.add(3, "day");
+            }
+            result.end.assign("day", endMoment.date());
+            result.end.assign("month", endMoment.month() + 1);
+            result.end.assign("year", endMoment.year());
+        } else {
+            result.end.imply("day", endMoment.date());
+            result.end.imply("month", endMoment.month() + 1);
+            result.end.imply("year", endMoment.year());
+        }
+
+        hour = 0;
+        minute = 0;
+        meridiem = -1;
+
+        // ----- Second
+        if (match[SECOND_GROUP]) {
+            var second = parseInt(match[SECOND_GROUP]);
+            if (isNaN(second)) {
+                second = zhStringToNumber(match[SECOND_GROUP]);
+            }
+
+            if (second >= 60) return null;
+            result.end.assign("second", second);
+        }
+
+        hour = parseInt(match[HOUR_GROUP]);
+        if (isNaN(hour)) {
+            hour = zhStringToNumber(match[HOUR_GROUP]);
+        }
+
+        // ----- Minutes
+        if (match[MINUTE_GROUP]) {
+            if (match[MINUTE_GROUP] == "半") {
+                minute = 30;
+            } else if (match[MINUTE_GROUP] == "正" || match[MINUTE_GROUP] == "整") {
+                minute = 0;
+            } else {
+                minute = parseInt(match[MINUTE_GROUP]);
+                if (isNaN(minute)) {
+                    minute = zhStringToNumber(match[MINUTE_GROUP]);
+                }
+            }
+        } else if (hour > 100) {
+            minute = hour % 100;
+            hour = Math.floor(hour / 100);
+        }
+
+        if (minute >= 60) {
+            return null;
+        }
+
+        if (hour > 24) {
+            return null;
+        }
+        if (hour >= 12) {
+            meridiem = 1;
+        }
+
+        // ----- AM & PM
+        if (match[AM_PM_HOUR_GROUP]) {
+            if (hour > 12) return null;
+            var ampm = match[AM_PM_HOUR_GROUP][0].toLowerCase();
+            if (ampm == "a") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            }
+
+            if (ampm == "p") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+
+            if (!result.start.isCertain("meridiem")) {
+                if (meridiem == 0) {
+                    result.start.imply("meridiem", 0);
+
+                    if (result.start.get("hour") == 12) {
+                        result.start.assign("hour", 0);
+                    }
+                } else {
+                    result.start.imply("meridiem", 1);
+
+                    if (result.start.get("hour") != 12) {
+                        result.start.assign("hour", result.start.get("hour") + 12);
+                    }
+                }
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_1]) {
+            var zhAMPMString1 = match[ZH_AM_PM_HOUR_GROUP_1];
+            var zhAMPM1 = zhAMPMString1[0];
+            if (zhAMPM1 == "朝" || zhAMPM1 == "早") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM1 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_2]) {
+            var zhAMPMString2 = match[ZH_AM_PM_HOUR_GROUP_2];
+            var zhAMPM2 = zhAMPMString2[0];
+            if (zhAMPM2 == "上" || zhAMPM2 == "朝" || zhAMPM2 == "早" || zhAMPM2 == "凌") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM2 == "下" || zhAMPM2 == "晏" || zhAMPM2 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        } else if (match[ZH_AM_PM_HOUR_GROUP_3]) {
+            var zhAMPMString3 = match[ZH_AM_PM_HOUR_GROUP_3];
+            var zhAMPM3 = zhAMPMString3[0];
+            if (zhAMPM3 == "上" || zhAMPM3 == "朝" || zhAMPM3 == "早" || zhAMPM3 == "凌") {
+                meridiem = 0;
+                if (hour == 12) hour = 0;
+            } else if (zhAMPM3 == "下" || zhAMPM3 == "晏" || zhAMPM3 == "晚") {
+                meridiem = 1;
+                if (hour != 12) hour += 12;
+            }
+        }
+
+        result.text = result.text + match[0];
+        result.end.assign("hour", hour);
+        result.end.assign("minute", minute);
+        if (meridiem >= 0) {
+            result.end.assign("meridiem", meridiem);
+        } else {
+            const startAtPM = result.start.isCertain("meridiem") && result.start.get("meridiem") == 1;
+            if (startAtPM && result.start.get("hour") > hour) {
+                // 10pm - 1 (am)
+                result.end.imply("meridiem", 0);
+            } else if (hour > 12) {
+                result.end.imply("meridiem", 1);
+            }
+        }
+
+        if (result.end.date().getTime() < result.start.date().getTime()) {
+            result.end.imply("day", result.end.get("day") + 1);
+        }
+
+        return result;
+    }
+}

package/src/locales/zh/hant/parsers/ZHHantWeekdayParser.ts

@@ -0,0 +1,46 @@
+import dayjs from "dayjs";
+import { ParsingContext } from "../../../../chrono";
+import { AbstractParserWithWordBoundaryChecking } from "../../../../common/parsers/AbstractParserWithWordBoundary";
+import { ParsingResult } from "../../../../results";
+import { WEEKDAY_OFFSET } from "../constants";
+
+const PATTERN = new RegExp("(?:星期|禮拜|週)(?<weekday>" + Object.keys(WEEKDAY_OFFSET).join("|") + ")");
+
+export default class ZHHantWeekdayParser extends AbstractParserWithWordBoundaryChecking {
+    innerPattern(): RegExp {
+        return PATTERN;
+    }
+
+    innerExtract(context: ParsingContext, match: RegExpMatchArray): ParsingResult {
+        const result = context.createParsingResult(match.index, match[0]);
+
+        const dayOfWeek = match.groups.weekday;
+        const offset = WEEKDAY_OFFSET[dayOfWeek];
+        if (offset === undefined) return null;
+
+        let startMoment = dayjs(context.refDate);
+        const startMomentFixed = false;
+        const refOffset = startMoment.day();
+
+        if (Math.abs(offset - 7 - refOffset) < Math.abs(offset - refOffset)) {
+            startMoment = startMoment.day(offset - 7);
+        } else if (Math.abs(offset + 7 - refOffset) < Math.abs(offset - refOffset)) {
+            startMoment = startMoment.day(offset + 7);
+        } else {
+            startMoment = startMoment.day(offset);
+        }
+
+        result.start.assign("weekday", offset);
+        if (startMomentFixed) {
+            result.start.assign("day", startMoment.date());
+            result.start.assign("month", startMoment.month() + 1);
+            result.start.assign("year", startMoment.year());
+        } else {
+            result.start.imply("day", startMoment.date());
+            result.start.imply("month", startMoment.month() + 1);
+            result.start.imply("year", startMoment.year());
+        }
+
+        return result;
+    }
+}

package/src/locales/zh/hant/refiners/ZHHantMergeDateRangeRefiner.ts

@@ -0,0 +1,7 @@
+import AbstractMergeDateRangeRefiner from "../../../../common/refiners/AbstractMergeDateRangeRefiner";
+
+export default class ZHHantMergeDateRangeRefiner extends AbstractMergeDateRangeRefiner {
+    patternBetween(): RegExp {
+        return /^\s*(至|到|\-|\~|～|－|ー)\s*$/i;
+    }
+}

package/src/locales/zh/hant/refiners/ZHHantMergeDateTimeRefiner.ts

@@ -0,0 +1,7 @@
+import AbstractMergeDateTimeRefiner from "../../../../common/refiners/AbstractMergeDateTimeRefiner";
+
+export default class ZHHantMergeDateTimeRefiner extends AbstractMergeDateTimeRefiner {
+    patternBetween(): RegExp {
+        return /^\s*$/i;
+    }
+}

package/src/locales/zh/index.ts

@@ -0,0 +1,63 @@
+/**
+ * Chrono components for zh support
+ * TODO: Complete general zh support (current support only zh-Hant)
+ */
+
+import { Chrono, Configuration } from "../../chrono";
+import ExtractTimezoneOffsetRefiner from "../../common/refiners/ExtractTimezoneOffsetRefiner";
+import { includeCommonConfiguration } from "../../configurations";
+import { ParsedResult, ParsingOption } from "../../index";
+import ZHHantCasualDateParser from "./hant/parsers/ZHHantCasualDateParser";
+import ZHHantDateParser from "./hant/parsers/ZHHantDateParser";
+import ZHHantDeadlineFormatParser from "./hant/parsers/ZHHantDeadlineFormatParser";
+import ZHHantRelationWeekdayParser from "./hant/parsers/ZHHantRelationWeekdayParser";
+import ZHHantTimeExpressionParser from "./hant/parsers/ZHHantTimeExpressionParser";
+import ZHHantWeekdayParser from "./hant/parsers/ZHHantWeekdayParser";
+import ZHHantMergeDateRangeRefiner from "./hant/refiners/ZHHantMergeDateRangeRefiner";
+import ZHHantMergeDateTimeRefiner from "./hant/refiners/ZHHantMergeDateTimeRefiner";
+
+// Shortcuts
+export const hant = new Chrono(createCasualConfiguration());
+
+export const casual = new Chrono(createCasualConfiguration());
+export const strict = new Chrono(createConfiguration());
+
+export function parse(text: string, ref?: Date, option?: ParsingOption): ParsedResult[] {
+    return casual.parse(text, ref, option);
+}
+
+export function parseDate(text: string, ref?: Date, option?: ParsingOption): Date {
+    return casual.parseDate(text, ref, option);
+}
+
+/**
+ * @ignore (to be documented later)
+ */
+export function createCasualConfiguration(): Configuration {
+    const option = createConfiguration();
+    option.parsers.unshift(new ZHHantCasualDateParser());
+    return option;
+}
+
+/**
+ * @ignore (to be documented later)
+ */
+export function createConfiguration(): Configuration {
+    const configuration = includeCommonConfiguration({
+        parsers: [
+            new ZHHantDateParser(),
+            new ZHHantRelationWeekdayParser(),
+            new ZHHantWeekdayParser(),
+            new ZHHantTimeExpressionParser(),
+            new ZHHantDeadlineFormatParser(),
+        ],
+        refiners: [new ZHHantMergeDateRangeRefiner(), new ZHHantMergeDateTimeRefiner()],
+    });
+
+    // REMOVE ExtractTimezoneOffsetRefiner
+    configuration.refiners = configuration.refiners.filter(
+        (refiner) => !(refiner instanceof ExtractTimezoneOffsetRefiner)
+    );
+
+    return configuration;
+}

package/src/utils/dayjs.ts

@@ -1,5 +1,6 @@
 import { ParsingComponents } from "../results";
 import dayjs from "dayjs";
+import { Meridiem } from "../index";
 
 export function assignTheNextDay(component: ParsingComponents, targetDayJs: dayjs.Dayjs) {
     targetDayJs = targetDayJs.add(1, "day");
@@ -18,6 +19,11 @@ export function assignSimilarTime(component: ParsingComponents, targetDayJs: day
     component.assign("minute", targetDayJs.minute());
     component.assign("second", targetDayJs.second());
     component.assign("millisecond", targetDayJs.millisecond());
+    if (component.get("hour") < 12) {
+        component.assign("meridiem", Meridiem.AM);
+    } else {
+        component.assign("meridiem", Meridiem.PM);
+    }
 }
 
 export function implySimilarTime(component: ParsingComponents, targetDayJs: dayjs.Dayjs) {