@fhss-web-team/fuzzy-dates 1.2.2 → 2.0.0

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

@@ -1,178 +0,0 @@
-import { FuzzyDateFormat, FuzzyDateValue } from '../helpers/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 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 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 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 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 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 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 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 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 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: FuzzyDateFormat): 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

@@ -1,92 +0,0 @@
-import { about, after, before, between, early, from, late, mid, none, } from './modifiers';
-import { err, ok } from '../helpers/result';
-import { isMonth, isSeason, MONTH_NAME_MAP, MONTH_SEASON_MAP, } from '../helpers/maps';
-// 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);
-    if (cleanedInput.startsWith('after '))
-        return after(cleanedInput);
-    if (cleanedInput.startsWith('about '))
-        return about(cleanedInput);
-    if (cleanedInput.startsWith('between '))
-        return between(cleanedInput);
-    if (cleanedInput.startsWith('from '))
-        return from(cleanedInput);
-    if (cleanedInput.startsWith('early '))
-        return early(cleanedInput);
-    if (cleanedInput.startsWith('mid '))
-        return mid(cleanedInput);
-    if (cleanedInput.startsWith('late '))
-        return late(cleanedInput);
-    return none(cleanedInput);
-}
-// 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/modifiers.d.ts

@@ -1,231 +0,0 @@
-export declare const none: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const before: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const after: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const about: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const between: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: false;
-    error: "Invalid \"BETWEEN\" modifier.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const from: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: false;
-    error: "Invalid \"FROM\" modifier.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const early: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const mid: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};
-export declare const late: (cleanedInput: string) => {
-    ok: false;
-    error: "Year is required.";
-} | {
-    ok: false;
-    error: "Unknown month.";
-} | {
-    ok: false;
-    error: "Unknown date format.";
-} | {
-    ok: true;
-    value: {
-        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;
-        };
-    };
-};

package/dist/fuzzyDate/parse/modifiers.js

@@ -1,185 +0,0 @@
-import { getTimes } from '.';
-import { DATE_NEG_INFINITY, DATE_POS_INFINITY } from '../helpers/constants';
-import { err, ok } from '../helpers/result';
-import { stringToDate } from './stringToDate';
-export const none = (cleanedInput) => {
-    const result = stringToDate(cleanedInput);
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    return ok({
-        modifier: 'NONE',
-        start: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-        end: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-    });
-};
-export const before = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('before '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    return ok({
-        modifier: 'BEFORE',
-        start: {
-            format: date.format,
-            minDate: DATE_NEG_INFINITY,
-            maxDate: date.minDate,
-        },
-        end: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-    });
-};
-export const after = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('after '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    return ok({
-        modifier: 'AFTER',
-        start: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-        end: {
-            format: date.format,
-            minDate: date.maxDate,
-            maxDate: DATE_POS_INFINITY,
-        },
-    });
-};
-export const about = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('about '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    return ok({
-        modifier: 'ABOUT',
-        start: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-        end: {
-            format: date.format,
-            minDate: date.minDate,
-            maxDate: date.maxDate,
-        },
-    });
-};
-export const between = (cleanedInput) => {
-    const dates = cleanedInput.slice('between '.length).split(' and ');
-    if (dates.length !== 2)
-        return err('Invalid "BETWEEN" modifier.');
-    const startResult = stringToDate(dates[0]);
-    const endDateResult = stringToDate(dates[1]);
-    if (!startResult.ok)
-        return startResult;
-    if (!endDateResult.ok)
-        return endDateResult;
-    const start = startResult.value;
-    const end = endDateResult.value;
-    return ok({
-        modifier: 'BETWEEN',
-        start: {
-            format: start.format,
-            minDate: start.minDate,
-            maxDate: start.maxDate,
-        },
-        end: { format: end.format, minDate: end.minDate, maxDate: end.maxDate },
-    });
-};
-export const from = (cleanedInput) => {
-    const dates = cleanedInput.slice('from '.length).split(' to ');
-    if (dates.length !== 2)
-        return err('Invalid "FROM" modifier.');
-    const startResult = stringToDate(dates[0]);
-    const endDateResult = stringToDate(dates[1]);
-    if (!startResult.ok)
-        return startResult;
-    if (!endDateResult.ok)
-        return endDateResult;
-    const start = startResult.value;
-    const end = endDateResult.value;
-    return ok({
-        modifier: 'FROM',
-        start: {
-            format: start.format,
-            minDate: start.minDate,
-            maxDate: start.maxDate,
-        },
-        end: { format: end.format, minDate: end.minDate, maxDate: end.maxDate },
-    });
-};
-export const early = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('early '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    const { start, half } = getTimes(date);
-    return ok({
-        modifier: 'EARLY',
-        start: {
-            format: date.format,
-            minDate: new Date(start),
-            maxDate: new Date(start + half),
-        },
-        end: {
-            format: date.format,
-            minDate: new Date(start),
-            maxDate: new Date(start + half),
-        },
-    });
-};
-export const mid = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('mid '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    console.log(date);
-    const { start, half } = getTimes(date);
-    return ok({
-        modifier: 'MID',
-        start: {
-            format: date.format,
-            minDate: new Date(start + half / 2),
-            maxDate: new Date(start + half),
-        },
-        end: {
-            format: date.format,
-            minDate: new Date(start + half / 2),
-            maxDate: new Date(start + half),
-        },
-    });
-};
-export const late = (cleanedInput) => {
-    const result = stringToDate(cleanedInput.slice('late '.length));
-    if (!result.ok)
-        return result;
-    const date = result.value;
-    const { start, half } = getTimes(date);
-    return ok({
-        modifier: 'LATE',
-        start: {
-            format: date.format,
-            minDate: new Date(start + half),
-            maxDate: date.maxDate,
-        },
-        end: {
-            format: date.format,
-            minDate: new Date(start + half),
-            maxDate: date.maxDate,
-        },
-    });
-};