@fhss-web-team/fuzzy-dates 1.0.0

package/dist/fuzzyDate/gedcomX/toGedcomX.js

@@ -0,0 +1,31 @@
+export function toGedcomX(model) {
+    const startDate = toSimpleDate(model.start);
+    const endDate = toSimpleDate(model.end);
+    const gedcomModifierMap = {
+        NONE: startDate,
+        BEFORE: `/${endDate}`,
+        AFTER: `${startDate}/`,
+        EARLY: `${startDate}/${endDate}`,
+        MID: `${startDate}/${endDate}`,
+        LATE: `${startDate}/${endDate}`,
+        FROM: `${startDate}/${endDate}`,
+        BETWEEN: `${startDate}/${endDate}`,
+        ABOUT: `A${startDate}`,
+    };
+    return gedcomModifierMap[model.modifier];
+}
+function toSimpleDate(dateValue) {
+    const year = dateValue.minDate.getUTCFullYear();
+    const month = dateValue.minDate.getUTCMonth() + 1;
+    const day = dateValue.minDate.getUTCDate();
+    const sign = year >= 0 ? '+' : '-';
+    const yearAbs = Math.abs(year);
+    const yyyy = String(yearAbs).padStart(4, '0');
+    if (dateValue.format === 'YYYY' || dateValue.format === 'YYYYs')
+        return `${sign}${yyyy}`;
+    const mm = String(month).padStart(2, '0');
+    if (dateValue.format === 'MMMM_YYYY' || dateValue.format === 'SEASON_YYYY')
+        return `${sign}${yyyy}-${mm}`;
+    const dd = String(day).padStart(2, '0');
+    return `${sign}${yyyy}-${mm}-${dd}`;
+}

package/dist/fuzzyDate/normalize/normalize.d.ts

@@ -0,0 +1,2 @@
+import { FuzzyDateModel } from '../types';
+export declare function normalize(model: FuzzyDateModel): string;

package/dist/fuzzyDate/normalize/normalize.js

@@ -0,0 +1,47 @@
+import { SEASON_MONTH_MAP, isSeasonMonth, } from '../types';
+// Main function
+export function normalize(model) {
+    const startDate = normalizeDate(model.start.minDate, model.start.format);
+    const endDate = normalizeDate(model.end.minDate, model.end.format);
+    const normalModifierMap = {
+        NONE: startDate,
+        BEFORE: `before ${endDate}`,
+        AFTER: `after ${startDate}`,
+        EARLY: `early ${startDate}`,
+        MID: `mid ${startDate}`,
+        LATE: `late ${startDate}`,
+        FROM: `from ${startDate} to ${endDate}`,
+        BETWEEN: `between ${startDate} and ${endDate}`,
+        ABOUT: `about ${startDate}`,
+    };
+    return normalModifierMap[model.modifier];
+}
+// Helpers
+function normalizeDate(date, format) {
+    const options = { timeZone: 'UTC' };
+    switch (format) {
+        case 'YYYY':
+            options.year = 'numeric';
+            break;
+        case 'MMMM_YYYY':
+            options.month = 'long';
+            options.year = 'numeric';
+            break;
+        case 'D_MMMM_YYYY':
+            options.day = 'numeric';
+            options.month = 'long';
+            options.year = 'numeric';
+            break;
+        case 'SEASON_YYYY': {
+            const month = date.getUTCMonth() + 1;
+            if (!isSeasonMonth(month))
+                return ''; // month always returns 1 - 12 so this should never happen
+            return `${SEASON_MONTH_MAP[month]} ${date.getUTCFullYear()}`;
+        }
+        case 'YYYYs': {
+            const year = date.getUTCFullYear();
+            return `${year}s`;
+        }
+    }
+    return date.toLocaleDateString('en-GB', options);
+}

package/dist/fuzzyDate/parse/index.d.ts

@@ -0,0 +1,187 @@
+import { NormalFormat, FuzzyDateValue } from '../types';
+export declare function parse(input: string): {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "NONE";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "BEFORE";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "AFTER";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "ABOUT";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: false;
+    error: "Invalid \"BETWEEN\" modifier.";
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "BETWEEN";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: false;
+    error: "Invalid \"FROM\" modifier.";
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "FROM";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "EARLY";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "MID";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+} | {
+    ok: true;
+    value: {
+        readonly original: string;
+        readonly modifier: "LATE";
+        readonly start: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+        readonly end: {
+            readonly format: "YYYYs" | "YYYY" | "SEASON_YYYY" | "MMMM_YYYY" | "D_MMMM_YYYY";
+            readonly minDate: Date;
+            readonly maxDate: Date;
+        };
+    };
+};
+export declare function getTimes(date: FuzzyDateValue): {
+    start: number;
+    end: number;
+    half: number;
+};
+export declare function calculateMaxDate(start: Date, format: NormalFormat): Date;
+export declare function parseDateGroups(groups: {
+    day?: string;
+    month?: string;
+    year?: string;
+    decade?: string;
+}): {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        date: Date;
+    };
+};

package/dist/fuzzyDate/parse/index.js

@@ -0,0 +1,91 @@
+import { about, after, before, between, early, from, late, mid, none, } from './modifiers';
+import { ok, err, MONTH_NAME_MAP, MONTH_SEASON_MAP, isMonth, isSeason, } from '../types';
+// Main Parse Function
+export function parse(input) {
+    const cleanedInput = input
+        .toLowerCase() // lowercases
+        .replace(/(\d+)\s*(st|nd|rd|th|of)\b(\s*of)?/gi, '$1') // removes ordinal suffixes and 'of'
+        .replace(/[.,/\-_]+/g, ' ') // replaces separators with spaces
+        .replace(/\s+/g, ' ') // collapses multiple spaces to a single space
+        .trim(); // Removes trailing and leading spaces
+    if (cleanedInput.startsWith('before '))
+        return before(cleanedInput, input);
+    if (cleanedInput.startsWith('after '))
+        return after(cleanedInput, input);
+    if (cleanedInput.startsWith('about '))
+        return about(cleanedInput, input);
+    if (cleanedInput.startsWith('between '))
+        return between(cleanedInput, input);
+    if (cleanedInput.startsWith('from '))
+        return from(cleanedInput, input);
+    if (cleanedInput.startsWith('early '))
+        return early(cleanedInput, input);
+    if (cleanedInput.startsWith('mid '))
+        return mid(cleanedInput, input);
+    if (cleanedInput.startsWith('late '))
+        return late(cleanedInput, input);
+    return none(cleanedInput, input);
+}
+// Helpers
+export function getTimes(date) {
+    const start = date.minDate.getTime();
+    const end = date.maxDate.getTime() + 1; //Adds a milisecond for accurate date calculations
+    const half = (end - start) / 2;
+    return { start, end, half };
+}
+export function calculateMaxDate(start, format) {
+    const endDate = new Date(start);
+    if (format === 'MMMM_YYYY') {
+        endDate.setUTCMonth(endDate.getUTCMonth() + 1);
+        endDate.setMilliseconds(-1);
+    }
+    if (format === 'SEASON_YYYY') {
+        endDate.setUTCMonth(endDate.getUTCMonth() + 3);
+        endDate.setMilliseconds(-1);
+    }
+    if (format === 'YYYY') {
+        endDate.setUTCFullYear(endDate.getUTCFullYear() + 1);
+        endDate.setUTCMilliseconds(-1);
+    }
+    if (format === 'YYYYs') {
+        endDate.setUTCFullYear(endDate.getUTCFullYear() + 10);
+        endDate.setUTCMilliseconds(-1);
+    }
+    if (format === 'D_MMMM_YYYY') {
+        endDate.setUTCDate(endDate.getUTCDate() + 1);
+        endDate.setUTCMilliseconds(-1);
+    }
+    return endDate;
+}
+export function parseDateGroups(groups) {
+    if (!groups.year && !groups.decade)
+        return err('Year is required.');
+    const year = groups.decade
+        ? Number(groups.decade.replace(/(\d+)s$/, '$1')) // 'YYYYs' -> 'YYYY'
+        : Number(groups.year);
+    let month = 0; //default to January
+    if (groups.month) {
+        const result = resolveMonth(groups.month.toLowerCase());
+        if (!result.ok)
+            return result;
+        month = result.value.monthNumber;
+    }
+    let day = 1; //default to 1st day
+    if (groups.day) {
+        const dayToken = /^(?:0?[1-9]|[12][0-9]|3[01])$/.exec(groups.day)?.[0];
+        if (!dayToken)
+            return err('Unknown date format.');
+        day = Number(dayToken);
+    }
+    return ok({ date: new Date(Date.UTC(year, month, day)) });
+}
+function resolveMonth(rawMonth) {
+    const monthToken = /^(?:0?[1-9]|1[0-2])$/.exec(rawMonth)?.[0]; //Matches 01-09 or 1-9 or 10-12
+    if (monthToken)
+        return ok({ monthNumber: Number(monthToken) - 1 }); //months are zero-based
+    if (isMonth(rawMonth))
+        return ok({ monthNumber: MONTH_NAME_MAP[rawMonth] - 1 });
+    if (isSeason(rawMonth))
+        return ok({ monthNumber: MONTH_SEASON_MAP[rawMonth] - 1 });
+    return err('Unknown month.');
+}

package/dist/fuzzyDate/parse/inputDateFormats.d.ts

@@ -0,0 +1,204 @@
+export declare const year: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const monthStringYear: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "SEASON_YYYY" | "MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const yearMonthString: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "SEASON_YYYY" | "MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const dayMonthStringYear: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const monthStringDayYear: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const yearMonthStringDay: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const yearDayMonthString: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const monthDigitYear: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const yearMonthDigit: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const dayMonthDigitYear: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const yearMonthDigitDay: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "D_MMMM_YYYY";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;
+export declare const decade: (rawDate: string) => {
+    ok: false;
+    error: "Year is required.";
+} | {
+    ok: false;
+    error: "Unknown month.";
+} | {
+    ok: false;
+    error: "Unknown date format.";
+} | {
+    ok: true;
+    value: {
+        readonly format: "YYYYs";
+        readonly minDate: Date;
+        readonly maxDate: Date;
+    };
+} | null;