ts-time-utils 1.0.0 → 2.0.0

package/dist/esm/iterate.js

@@ -0,0 +1,409 @@
+/**
+ * @fileoverview Date iteration utilities for generating date sequences
+ */
+/**
+ * Generate an array of dates for each day in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of dates, one per day
+ * @example
+ * eachDay(new Date('2024-01-01'), new Date('2024-01-05'))
+ * // [Jan 1, Jan 2, Jan 3, Jan 4, Jan 5]
+ */
+export function eachDay(start, end) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setDate(current.getDate() + 1);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for each weekday (Mon-Fri) in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of weekday dates
+ * @example
+ * eachWeekday(new Date('2024-01-01'), new Date('2024-01-07'))
+ * // [Jan 1 (Mon), Jan 2 (Tue), Jan 3 (Wed), Jan 4 (Thu), Jan 5 (Fri)]
+ */
+export function eachWeekday(start, end) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        const day = current.getDay();
+        if (day !== 0 && day !== 6) {
+            result.push(new Date(current));
+        }
+        current.setDate(current.getDate() + 1);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for each weekend day (Sat-Sun) in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of weekend dates
+ */
+export function eachWeekend(start, end) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        const day = current.getDay();
+        if (day === 0 || day === 6) {
+            result.push(new Date(current));
+        }
+        current.setDate(current.getDate() + 1);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for each week start in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @param weekStartsOn - Day week starts on (0=Sunday, 1=Monday, default: 0)
+ * @returns Array of week start dates
+ * @example
+ * eachWeek(new Date('2024-01-01'), new Date('2024-01-31'))
+ * // [Jan 7, Jan 14, Jan 21, Jan 28] (Sundays)
+ */
+export function eachWeek(start, end, weekStartsOn = 0) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    // Move to first week start on or after start date
+    const dayDiff = (current.getDay() - weekStartsOn + 7) % 7;
+    if (dayDiff > 0) {
+        current.setDate(current.getDate() + (7 - dayDiff));
+    }
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setDate(current.getDate() + 7);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for the first day of each month in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of first-of-month dates
+ * @example
+ * eachMonth(new Date('2024-01-15'), new Date('2024-04-15'))
+ * // [Feb 1, Mar 1, Apr 1]
+ */
+export function eachMonth(start, end) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth() + 1, 1);
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setMonth(current.getMonth() + 1);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for the first day of each quarter in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of quarter start dates
+ */
+export function eachQuarter(start, end) {
+    const result = [];
+    // Start from beginning of next quarter after start date
+    const startMonth = start.getMonth();
+    const nextQuarterMonth = Math.ceil((startMonth + 1) / 3) * 3;
+    const current = new Date(nextQuarterMonth > 11 ? start.getFullYear() + 1 : start.getFullYear(), nextQuarterMonth % 12, 1);
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setMonth(current.getMonth() + 3);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for January 1st of each year in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Array of year start dates
+ */
+export function eachYear(start, end) {
+    const result = [];
+    const startYear = start.getMonth() === 0 && start.getDate() === 1
+        ? start.getFullYear()
+        : start.getFullYear() + 1;
+    const endYear = end.getFullYear();
+    for (let year = startYear; year <= endYear; year++) {
+        result.push(new Date(year, 0, 1));
+    }
+    return result;
+}
+/**
+ * Generate an array of dates at regular hour intervals
+ * @param start - Start date/time (inclusive)
+ * @param end - End date/time (inclusive)
+ * @param step - Hour interval (default: 1)
+ * @returns Array of dates at each interval
+ * @example
+ * eachHour(new Date('2024-01-01T09:00'), new Date('2024-01-01T12:00'))
+ * // [9:00, 10:00, 11:00, 12:00]
+ */
+export function eachHour(start, end, step = 1) {
+    const result = [];
+    const current = new Date(start);
+    current.setMinutes(0, 0, 0);
+    while (current <= end) {
+        result.push(new Date(current));
+        current.setHours(current.getHours() + step);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates at regular minute intervals
+ * @param start - Start date/time (inclusive)
+ * @param end - End date/time (inclusive)
+ * @param step - Minute interval (default: 1)
+ * @returns Array of dates at each interval
+ * @example
+ * eachMinute(new Date('2024-01-01T09:00'), new Date('2024-01-01T09:05'))
+ * // [9:00, 9:01, 9:02, 9:03, 9:04, 9:05]
+ */
+export function eachMinute(start, end, step = 1) {
+    const result = [];
+    const current = new Date(start);
+    current.setSeconds(0, 0);
+    while (current <= end) {
+        result.push(new Date(current));
+        current.setMinutes(current.getMinutes() + step);
+    }
+    return result;
+}
+/**
+ * Generate an array of dates for a specific day of the week in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @param dayOfWeek - Day of week (0=Sunday, 1=Monday, ..., 6=Saturday)
+ * @returns Array of dates for that day of week
+ * @example
+ * eachDayOfWeek(new Date('2024-01-01'), new Date('2024-01-31'), 1)
+ * // All Mondays in January 2024
+ */
+export function eachDayOfWeek(start, end, dayOfWeek) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    // Move to first occurrence of dayOfWeek
+    const diff = (dayOfWeek - current.getDay() + 7) % 7;
+    current.setDate(current.getDate() + diff);
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setDate(current.getDate() + 7);
+    }
+    return result;
+}
+/**
+ * Generate dates at a custom interval
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @param interval - Interval configuration
+ * @returns Array of dates at each interval
+ * @example
+ * eachInterval(start, end, { days: 3 }) // Every 3 days
+ * eachInterval(start, end, { weeks: 2 }) // Every 2 weeks
+ * eachInterval(start, end, { hours: 6 }) // Every 6 hours
+ */
+export function eachInterval(start, end, interval) {
+    const result = [];
+    const current = new Date(start);
+    while (current <= end) {
+        result.push(new Date(current));
+        if (interval.years) {
+            current.setFullYear(current.getFullYear() + interval.years);
+        }
+        if (interval.months) {
+            current.setMonth(current.getMonth() + interval.months);
+        }
+        if (interval.weeks) {
+            current.setDate(current.getDate() + interval.weeks * 7);
+        }
+        if (interval.days) {
+            current.setDate(current.getDate() + interval.days);
+        }
+        if (interval.hours) {
+            current.setHours(current.getHours() + interval.hours);
+        }
+        if (interval.minutes) {
+            current.setMinutes(current.getMinutes() + interval.minutes);
+        }
+        if (interval.seconds) {
+            current.setSeconds(current.getSeconds() + interval.seconds);
+        }
+    }
+    return result;
+}
+/**
+ * Count the number of days in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Number of days
+ */
+export function countDays(start, end) {
+    const startDay = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    const endDay = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    return Math.round((endDay.getTime() - startDay.getTime()) / 86400000) + 1;
+}
+/**
+ * Count the number of weekdays in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Number of weekdays
+ */
+export function countWeekdays(start, end) {
+    return eachWeekday(start, end).length;
+}
+/**
+ * Count the number of weekend days in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Number of weekend days
+ */
+export function countWeekendDays(start, end) {
+    return eachWeekend(start, end).length;
+}
+/**
+ * Count the number of weeks (complete or partial) in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Number of weeks
+ */
+export function countWeeks(start, end) {
+    const days = countDays(start, end);
+    return Math.ceil(days / 7);
+}
+/**
+ * Count the number of months in a range
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @returns Number of months (partial months count as 1)
+ */
+export function countMonths(start, end) {
+    const yearDiff = end.getFullYear() - start.getFullYear();
+    const monthDiff = end.getMonth() - start.getMonth();
+    return yearDiff * 12 + monthDiff + 1;
+}
+/**
+ * Iterator for lazy date generation (memory efficient for large ranges)
+ * @param start - Start date (inclusive)
+ * @param end - End date (inclusive)
+ * @param step - Step function to advance the date
+ * @yields Date objects
+ */
+export function* iterateDates(start, end, step = (d) => d.setDate(d.getDate() + 1)) {
+    const current = new Date(start);
+    while (current <= end) {
+        yield new Date(current);
+        step(current);
+    }
+}
+/**
+ * Create a lazy day iterator
+ * @param start - Start date
+ * @param end - End date
+ * @yields Each day in the range
+ */
+export function* iterateDays(start, end) {
+    yield* iterateDates(start, end, (d) => d.setDate(d.getDate() + 1));
+}
+/**
+ * Create a lazy weekday iterator
+ * @param start - Start date
+ * @param end - End date
+ * @yields Each weekday in the range
+ */
+export function* iterateWeekdays(start, end) {
+    const current = new Date(start.getFullYear(), start.getMonth(), start.getDate());
+    while (current <= end) {
+        const day = current.getDay();
+        if (day !== 0 && day !== 6) {
+            yield new Date(current);
+        }
+        current.setDate(current.getDate() + 1);
+    }
+}
+/**
+ * Create a lazy month iterator
+ * @param start - Start date
+ * @param end - End date
+ * @yields First day of each month in the range
+ */
+export function* iterateMonths(start, end) {
+    const current = new Date(start.getFullYear(), start.getMonth(), 1);
+    while (current <= end) {
+        yield new Date(current);
+        current.setMonth(current.getMonth() + 1);
+    }
+}
+/**
+ * Generate dates by applying a filter to a range
+ * @param start - Start date
+ * @param end - End date
+ * @param filter - Filter function (return true to include date)
+ * @returns Array of filtered dates
+ * @example
+ * // Get all 15th days of each month
+ * filterDays(start, end, d => d.getDate() === 15)
+ */
+export function filterDays(start, end, filter) {
+    const result = [];
+    for (const date of iterateDays(start, end)) {
+        if (filter(date)) {
+            result.push(date);
+        }
+    }
+    return result;
+}
+/**
+ * Generate the last day of each month in a range
+ * @param start - Start date
+ * @param end - End date
+ * @returns Array of last-of-month dates
+ */
+export function eachMonthEnd(start, end) {
+    const result = [];
+    const current = new Date(start.getFullYear(), start.getMonth() + 1, 0);
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        result.push(new Date(current));
+        current.setMonth(current.getMonth() + 2);
+        current.setDate(0); // Last day of previous month
+    }
+    return result;
+}
+/**
+ * Generate specific day of each month in a range
+ * @param start - Start date
+ * @param end - End date
+ * @param dayOfMonth - Day of month (1-31, will cap at month's max)
+ * @returns Array of dates
+ * @example
+ * eachNthDayOfMonth(start, end, 15) // 15th of each month
+ * eachNthDayOfMonth(start, end, 31) // Last day of short months, 31st otherwise
+ */
+export function eachNthDayOfMonth(start, end, dayOfMonth) {
+    const result = [];
+    let current = new Date(start.getFullYear(), start.getMonth(), 1);
+    const endDate = new Date(end.getFullYear(), end.getMonth(), end.getDate());
+    while (current <= endDate) {
+        const daysInMonth = new Date(current.getFullYear(), current.getMonth() + 1, 0).getDate();
+        const actualDay = Math.min(dayOfMonth, daysInMonth);
+        const date = new Date(current.getFullYear(), current.getMonth(), actualDay);
+        if (date >= start && date <= endDate) {
+            result.push(date);
+        }
+        current.setMonth(current.getMonth() + 1);
+    }
+    return result;
+}

package/dist/esm/naturalLanguage.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @fileoverview Natural language date parsing utilities
+ * Provides intelligent parsing of human-readable date strings
+ */
+/**
+ * Options for natural language parsing
+ */
+export interface NaturalParseOptions {
+    /** Reference date for relative parsing (defaults to now) */
+    referenceDate?: Date;
+    /** Preferred time for dates without time specified */
+    defaultTime?: {
+        hour: number;
+        minute: number;
+        second?: number;
+    };
+    /** Locale for language-specific parsing */
+    locale?: string;
+    /** Whether to use strict parsing */
+    strict?: boolean;
+}
+/**
+ * Extracted date information from text
+ */
+export interface ExtractedDate {
+    /** The parsed date */
+    date: Date;
+    /** The original text that was matched */
+    text: string;
+    /** Starting position in the original text */
+    index: number;
+    /** Type of date pattern matched */
+    type: 'absolute' | 'relative' | 'range' | 'time';
+    /** Confidence score (0-1) */
+    confidence: number;
+}
+/**
+ * Parses natural language date strings into Date objects
+ * @param input - Natural language date string
+ * @param options - Parsing options
+ * @returns Parsed date or null if unable to parse
+ *
+ * @example
+ * ```ts
+ * parseNaturalDate('tomorrow at 3pm');
+ * // Date for tomorrow at 15:00
+ *
+ * parseNaturalDate('next Friday');
+ * // Date for next Friday
+ *
+ * parseNaturalDate('in 2 weeks');
+ * // Date 2 weeks from now
+ *
+ * parseNaturalDate('December 25th');
+ * // Date for Dec 25 this year (or next if passed)
+ * ```
+ */
+export declare function parseNaturalDate(input: string, options?: NaturalParseOptions): Date | null;
+/**
+ * Parses a relative time phrase into a Date
+ * @param input - Relative time phrase
+ * @param referenceDate - Reference date (defaults to now)
+ * @returns Parsed date or null
+ *
+ * @example
+ * ```ts
+ * parseRelativePhrase('in 2 hours'); // 2 hours from now
+ * parseRelativePhrase('5 minutes ago'); // 5 minutes ago
+ * parseRelativePhrase('next week'); // 7 days from now
+ * ```
+ */
+export declare function parseRelativePhrase(input: string, referenceDate?: Date): Date | null;
+/**
+ * Extracts all dates from a text string
+ * @param text - Text to extract dates from
+ * @param options - Extraction options
+ * @returns Array of extracted date information
+ *
+ * @example
+ * ```ts
+ * const text = "Meeting tomorrow at 3pm and dinner next Friday at 7pm";
+ * const dates = extractDatesFromText(text);
+ * // [
+ * //   { date: Date(...), text: 'tomorrow at 3pm', index: 8, ... },
+ * //   { date: Date(...), text: 'next Friday at 7pm', index: 37, ... }
+ * // ]
+ * ```
+ */
+export declare function extractDatesFromText(text: string, options?: NaturalParseOptions): ExtractedDate[];
+/**
+ * Suggests possible dates based on context
+ * @param context - Context string to analyze
+ * @param options - Parsing options
+ * @returns Array of suggested dates with confidence scores
+ *
+ * @example
+ * ```ts
+ * suggestDateFromContext('deadline is end of month');
+ * // [{ date: Date(last day of current month), confidence: 0.8, ... }]
+ * ```
+ */
+export declare function suggestDateFromContext(context: string, options?: NaturalParseOptions): Array<{
+    date: Date;
+    text: string;
+    confidence: number;
+}>;
+//# sourceMappingURL=naturalLanguage.d.ts.map

package/dist/esm/naturalLanguage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naturalLanguage.d.ts","sourceRoot":"","sources":["../../src/naturalLanguage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4DAA4D;IAC5D,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,sDAAsD;IACtD,WAAW,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,sBAAsB;IACtB,IAAI,EAAE,IAAI,CAAC;IACX,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAC;IACjD,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,IAAI,GAAG,IAAI,CA8C9F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,GAAE,IAAiB,GAAG,IAAI,GAAG,IAAI,CA6DhG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,mBAAwB,GAChC,aAAa,EAAE,CAkDjB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,mBAAwB,GAChC,KAAK,CAAC;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAkDzD"}