@timestamp-js/core 0.1.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,980 @@
+/**
+ * Matches supported date and date-time input.
+ *
+ * Accepts `YYYY-MM`, `YYYY-MM-DD`, space-separated date/time strings,
+ * ISO-style `T` separators, optional seconds, optional milliseconds, and
+ * optional timezone suffixes such as `Z`, `+06:00`, or `-0700`.
+ */
+export declare const PARSE_DATETIME: RegExp;
+/**
+ * Matches the date portion of a timestamp string.
+ */
+export declare const PARSE_DATE: RegExp;
+/**
+ * Matches `HH`, `HH:mm`, `HH:mm:ss`, or `HH:mm:ss.SSS` time strings.
+ */
+export declare const PARSE_TIME: RegExp;
+/**
+ * Month lengths for a non-leap Gregorian year.
+ *
+ * Index `0` is intentionally unused so month numbers can be used directly.
+ */
+export declare const DAYS_IN_MONTH: number[];
+/**
+ * Month lengths for a leap Gregorian year.
+ *
+ * Index `0` is intentionally unused so month numbers can be used directly.
+ */
+export declare const DAYS_IN_MONTH_LEAP: number[];
+/**
+ * Shared conversion constants for milliseconds, seconds, minutes, hours, and days.
+ */
+export declare const TIME_CONSTANTS: {
+    MILLISECONDS_IN: {
+        SECOND: number;
+        MINUTE: number;
+        HOUR: number;
+        DAY: number;
+        WEEK: number;
+    };
+    SECONDS_IN: {
+        MINUTE: number;
+        HOUR: number;
+        DAY: number;
+        WEEK: number;
+    };
+    MINUTES_IN: {
+        MINUTE: number;
+        HOUR: number;
+        DAY: number;
+        WEEK: number;
+    };
+    HOURS_IN: {
+        DAY: number;
+        WEEK: number;
+    };
+    DAYS_IN: {
+        WEEK: number;
+    };
+};
+/**
+ * Minimum number of days found in any Gregorian month.
+ */
+export declare const DAYS_IN_MONTH_MIN = 28;
+/**
+ * Maximum number of days found in any Gregorian month.
+ */
+export declare const DAYS_IN_MONTH_MAX = 31;
+/**
+ * Maximum Gregorian month number.
+ */
+export declare const MONTH_MAX = 12;
+/**
+ * Minimum Gregorian month number.
+ */
+export declare const MONTH_MIN = 1;
+/**
+ * Minimum day-of-month number.
+ */
+export declare const DAY_MIN = 1;
+/**
+ * First hour in a 24-hour day.
+ */
+export declare const FIRST_HOUR = 0;
+/**
+ * Number of days in a week.
+ */
+export declare const DAYS_IN_WEEK: number;
+/**
+ * Number of minutes in an hour.
+ */
+export declare const MINUTES_IN_HOUR: number;
+/**
+ * Number of hours in a day.
+ */
+export declare const HOURS_IN_DAY: number;
+/**
+ * Number of milliseconds in one minute.
+ */
+export declare const MILLISECONDS_IN_MINUTE: number;
+/**
+ * Number of milliseconds in one hour.
+ */
+export declare const MILLISECONDS_IN_HOUR: number;
+/**
+ * Number of milliseconds in one day.
+ */
+export declare const MILLISECONDS_IN_DAY: number;
+/**
+ * Number of milliseconds in one week.
+ */
+export declare const MILLISECONDS_IN_WEEK: number;
+/**
+ * Inline style metadata that can be attached to disabled timestamp ranges.
+ */
+export type TimestampStyle = Record<string, string | number | undefined>;
+/**
+ * CSS class metadata that can be attached to disabled timestamp ranges.
+ */
+export type TimestampClass = string | string[] | Record<string, boolean>;
+/**
+ * Object form for a disabled day or disabled date range.
+ */
+export interface DisabledDayConfig {
+    /**
+     * Single disabled date in `YYYY-MM-DD` form.
+     */
+    date?: string;
+    /**
+     * Inclusive range start date in `YYYY-MM-DD` form.
+     */
+    from?: string;
+    /**
+     * Inclusive range end date in `YYYY-MM-DD` form.
+     */
+    to?: string;
+    /**
+     * Alias for {@link DisabledDayConfig.from}.
+     */
+    start?: string;
+    /**
+     * Alias for {@link DisabledDayConfig.to}.
+     */
+    end?: string;
+    /**
+     * Optional background color metadata for matching disabled dates.
+     */
+    color?: string;
+    /**
+     * Optional text color metadata for matching disabled dates.
+     */
+    textColor?: string;
+    /**
+     * Optional CSS class metadata for matching disabled dates.
+     */
+    class?: TimestampClass;
+    /**
+     * Optional inline style metadata for matching disabled dates.
+     */
+    style?: TimestampStyle;
+    /**
+     * Optional human-readable label for matching disabled dates.
+     */
+    label?: string;
+}
+/**
+ * Supported disabled-day declaration.
+ *
+ * A string disables a single date, a string array disables multiple dates or
+ * an inclusive two-date range, and an object can carry display metadata.
+ */
+export type DisabledDay = string | string[] | DisabledDayConfig;
+/**
+ * Collection of disabled-day declarations.
+ */
+export type DisabledDays = DisabledDay[];
+/**
+ * Immutable timestamp data used by all parser, comparison, and date math helpers.
+ *
+ * Timestamps use Gregorian calendar fields and preserve optional ISO timezone
+ * suffixes without converting the wall-clock values into another zone.
+ */
+export interface Timestamp {
+    /**
+     * Date string in `YYYY-MM-DD` form when the timestamp has a day.
+     */
+    readonly date: string;
+    /**
+     * True when the timestamp includes a meaningful date/day value.
+     */
+    readonly hasDay: boolean;
+    /**
+     * Four-digit Gregorian year.
+     */
+    readonly year: number;
+    /**
+     * Gregorian month number, where January is `1` and December is `12`.
+     */
+    readonly month: number;
+    /**
+     * Day of the month.
+     */
+    readonly day: number;
+    /**
+     * Formatted time string.
+     *
+     * Minute precision is formatted as `HH:mm`; second precision as `HH:mm:ss`;
+     * millisecond precision as `HH:mm:ss.SSS`.
+     */
+    readonly time?: string;
+    /**
+     * True when the timestamp includes time fields.
+     */
+    readonly hasTime: boolean;
+    /**
+     * Hour in 24-hour format.
+     */
+    readonly hour: number;
+    /**
+     * Minute of the hour.
+     */
+    readonly minute: number;
+    /**
+     * Optional second of the minute.
+     */
+    readonly second?: number;
+    /**
+     * Optional millisecond of the second.
+     */
+    readonly millisecond?: number;
+    /**
+     * Optional parsed ISO timezone suffix such as `Z`, `+06:00`, or `-0700`.
+     *
+     * The suffix is preserved for callers, but parsing does not convert the
+     * wall-clock values into another timezone.
+     */
+    readonly timezone?: string;
+    /**
+     * Weekday number where Sunday is `0` and Saturday is `6`.
+     */
+    readonly weekday?: number;
+    /**
+     * Day of the year.
+     */
+    readonly doy?: number;
+    /**
+     * ISO-style workweek number.
+     */
+    readonly workweek?: number;
+    /**
+     * True when the timestamp is before a comparison timestamp.
+     */
+    readonly past?: boolean;
+    /**
+     * True when the timestamp matches a comparison timestamp.
+     */
+    readonly current?: boolean;
+    /**
+     * True when the timestamp is after a comparison timestamp.
+     */
+    readonly future?: boolean;
+    /**
+     * True when this timestamp represents a disabled date.
+     */
+    readonly disabled?: boolean;
+    /**
+     * Optional background color metadata for a disabled date.
+     */
+    readonly disabledColor?: string;
+    /**
+     * Optional text color metadata for a disabled date.
+     */
+    readonly disabledTextColor?: string;
+    /**
+     * Optional class metadata for a disabled date.
+     */
+    readonly disabledClass?: TimestampClass;
+    /**
+     * Optional inline style metadata for a disabled date.
+     */
+    readonly disabledStyle?: TimestampStyle;
+    /**
+     * Optional human-readable label for a disabled date.
+     */
+    readonly disabledLabel?: string;
+    /**
+     * True when this timestamp's weekday matches a comparison timestamp's weekday.
+     */
+    readonly currentWeekday?: boolean;
+}
+/**
+ * Time-only value used when callers need hour/minute input without a date.
+ */
+export interface TimeObject {
+    /**
+     * Hour in 24-hour format.
+     */
+    readonly hour: number;
+    /**
+     * Minute of the hour.
+     */
+    readonly minute: number;
+    /**
+     * Optional second of the minute.
+     */
+    readonly second?: number;
+    /**
+     * Optional millisecond of the second.
+     */
+    readonly millisecond?: number;
+}
+/**
+ * Frozen empty timestamp template.
+ *
+ * Use {@link copyTimestamp} or parser helpers to create new timestamp objects
+ * instead of mutating this shared default.
+ */
+export declare const Timestamp: Timestamp;
+/**
+ * Frozen empty time-object template.
+ */
+export declare const TimeObject: TimeObject;
+/**
+ * Validates whether an input string matches the supported timestamp grammar.
+ *
+ * @param {string} input A string in the form `YYYY-MM-DD`, `YYYY-MM-DD HH:mm`, or a full ISO-like date time.
+ * @returns {boolean} True if parseable
+ */
+export declare function validateTimestamp(input: string): boolean;
+/**
+ * Fast low-level parser for date and date-time strings.
+ *
+ * This parser fills numeric fields, but does not update formatted date,
+ * weekday, day-of-year, workweek, or relative flags. Use
+ * {@link parseTimestamp} when those derived fields are needed.
+ *
+ * @param {string} input In the form `YYYY-MM-DD`, `YYYY-MM-DD HH:mm:ss`, or an ISO-like date time with optional milliseconds and timezone suffix.
+ * @returns {Timestamp} This {@link Timestamp} is minimally filled in. The {@link Timestamp.date} and {@link Timestamp.time} as well as relative data will not be filled in.
+ */
+export declare function parsed(input: string): Timestamp | null;
+/**
+ * Takes a JavaScript Date and returns a {@link Timestamp}. The {@link Timestamp} is not updated with relative information.
+ * @param {Date} date JavaScript Date
+ * @param {boolean} utc If set the {@link Timestamp} will parse the Date as UTC
+ * @returns {Timestamp} A minimal {@link Timestamp} without updated or relative updates.
+ */
+export declare function parseDate(date: Date, utc?: boolean): Timestamp | null;
+/**
+ * Pads a number to a requested string length.
+ *
+ * Useful for formatting values such as `5` as `05`.
+ * @param {number} x The number to pad
+ * @param {number} length The length of the required number as a string
+ * @returns {string} The padded number (as a string). (ie: 5 = '05')
+ */
+export declare function padNumber(x: number, length: number): string;
+/**
+ * Returns if the passed year is a leap year
+ * @param {number} year The year to check (ie: 1999, 2020)
+ * @returns {boolean} True if the year is a leap year
+ */
+export declare function isLeapYear(year: number): boolean;
+/**
+ * Returns the days of the specified month in a year
+ * @param {number} year The year (ie: 1999, 2020)
+ * @param {number} month The Gregorian month number, where January is `1`
+ * @returns {number} The number of days in the month (corrected for leap years)
+ */
+export declare function daysInMonth(year: number, month: number): number;
+/**
+ * Returns a {@link Timestamp} of next day from passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {Timestamp} A new {@link Timestamp} representing the next day
+ */
+export declare function nextDay(timestamp: Timestamp): Timestamp;
+/**
+ * Returns a {@link Timestamp} of previous day from passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {Timestamp} A new {@link Timestamp} representing the previous day
+ */
+export declare function prevDay(timestamp: Timestamp): Timestamp;
+/**
+ * Returns today's date
+ * @returns {string} Date string in the form `YYYY-MM-DD`
+ */
+export declare function today(): string;
+/**
+ * Takes a date string ('YYYY-MM-DD') and validates if it is today's date
+ * @param {string} date Date string in the form 'YYYY-MM-DD'
+ * @returns {boolean} True if the date is today's date
+ */
+export declare function isToday(date: string): boolean;
+/**
+ * Returns the start of the week give a {@link Timestamp} and weekdays (in which it finds the day representing the start of the week).
+ * If today {@link Timestamp} is passed in then this is used to update relative information in the returned {@link Timestamp}.
+ * @param {Timestamp} timestamp The {@link Timestamp} to use to find the start of the week
+ * @param {number[]} weekdays The array is [0,1,2,3,4,5,6] where 0=Sunday and 6=Saturday
+ * @param {Timestamp=} today If passed in then the {@link Timestamp} is updated with relative information
+ * @returns {Timestamp} A new {@link Timestamp} representing the start of the week
+ */
+export declare function getStartOfWeek(timestamp: Timestamp, weekdays: number[], today: Timestamp): Timestamp;
+/**
+ * Returns the end of the week give a {@link Timestamp} and weekdays (in which it finds the day representing the last of the week).
+ * If today {@link Timestamp} is passed in then this is used to update relative information in the returned {@link Timestamp}.
+ * @param {Timestamp} timestamp The {@link Timestamp} to use to find the end of the week
+ * @param {number[]} weekdays The array is [0,1,2,3,4,5,6] where 0=Sunday and 6=Saturday
+ * @param {Timestamp=} today If passed in then the {@link Timestamp} is updated with relative information
+ * @returns {Timestamp} A new {@link Timestamp} representing the end of the week
+ */
+export declare function getEndOfWeek(timestamp: Timestamp, weekdays: number[], today: Timestamp): Timestamp;
+/**
+ * Finds the start of the month based on the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use to find the start of the month
+ * @returns {Timestamp} A {@link Timestamp} of the start of the month
+ */
+export declare function getStartOfMonth(timestamp: Timestamp): Timestamp;
+/**
+ * Finds the end of the month based on the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use to find the end of the month
+ * @returns {Timestamp} A {@link Timestamp} of the end of the month
+ */
+export declare function getEndOfMonth(timestamp: Timestamp): Timestamp;
+/**
+ * Converts time input into minutes since midnight.
+ *
+ * Strings may include seconds or milliseconds, but sub-minute precision is
+ * ignored for this minute-oriented helper.
+ *
+ * @param input - Minutes since midnight, a time string, or an object with hour and minute fields.
+ * @returns Minutes since midnight, or `false` when the input cannot be parsed.
+ */
+export declare function parseTime(input: number | string | {
+    hour: number;
+    minute: number;
+}): number | false;
+/**
+ * Compares two {@link Timestamp}s for exactness
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @returns {boolean} True if the two {@link Timestamp}s are an exact match
+ */
+export declare function compareTimestamps(ts1: Timestamp, ts2: Timestamp): boolean;
+/**
+ * Compares the date of two {@link Timestamp}s that have been updated with relative data
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @returns {boolean} True if the two dates are the same
+ */
+export declare function compareDate(ts1: Timestamp, ts2: Timestamp): boolean;
+/**
+ * Compares the time of two {@link Timestamp}s that have been updated with relative data
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @returns {boolean} True if the two times are an exact match
+ */
+export declare function compareTime(ts1: Timestamp, ts2: Timestamp): boolean;
+/**
+ * Compares the date and time of two {@link Timestamp}s that have been updated with relative data
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @returns {boolean} True if the date and time are an exact match
+ */
+export declare function compareDateTime(ts1: Timestamp, ts2: Timestamp): boolean;
+/**
+ * High-level parser that converts a string to a fully formatted {@link Timestamp}.
+ *
+ * If `now` is supplied, the returned timestamp also includes relative flags
+ * such as `past`, `current`, `future`, and `currentWeekday`.
+ *
+ * @param {string} input In the form `YYYY-MM-DD`, `YYYY-MM-DD HH:mm:ss`, or an ISO-like date time with optional milliseconds and timezone suffix.
+ * @param {Timestamp} now A {@link Timestamp} to use for relative data updates
+ * @returns {Timestamp} The {@link Timestamp.date} will be filled in as well as the {@link Timestamp.time} if a time is supplied and formatted fields (doy, weekday, workweek, etc). If 'now' is supplied, then relative data will also be updated.
+ */
+export declare function parseTimestamp(input: string, now?: Timestamp | null): Timestamp | null;
+/**
+ * Converts a {@link Timestamp} into a numeric date identifier based on the passed {@link Timestamp}'s date
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The numeric date identifier
+ */
+export declare function getDayIdentifier(timestamp: Timestamp): number;
+/**
+ * Converts a {@link Timestamp} into a numeric time identifier based on the passed {@link Timestamp}'s time
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The numeric time identifier
+ */
+export declare function getTimeIdentifier(timestamp: Timestamp): number;
+/**
+ * Converts a {@link Timestamp} into a numeric date and time identifier based on the passed {@link Timestamp}'s date and time
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The numeric date+time identifier
+ */
+export declare function getDayTimeIdentifier(timestamp: Timestamp): number;
+/**
+ * Returns the difference between two {@link Timestamp}s
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @param {boolean=} strict Optional flag to not to return negative numbers
+ * @returns {number} The difference
+ */
+export declare function diffTimestamp(ts1: Timestamp, ts2: Timestamp, strict?: boolean): number;
+/**
+ * Updates a {@link Timestamp} with relative data (past, current and future)
+ * @param {Timestamp} timestamp The {@link Timestamp} that needs relative data updated
+ * @param {Timestamp} now {@link Timestamp} that represents the current date (optional time)
+ * @param {boolean=} time Optional flag to include time ('timestamp' and 'now' params should have time values)
+ * @returns {Timestamp} A new {@link Timestamp}
+ */
+export declare function updateRelative(timestamp: Timestamp, now: Timestamp, time?: boolean): Timestamp;
+/**
+ * Returns a timestamp set to a number of minutes past midnight.
+ *
+ * The returned timestamp has updated hour/minute fields and clears second and
+ * millisecond precision because this helper is minute-oriented.
+ *
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @param {number} minutes The number of minutes to set from midnight
+ * @param {Timestamp=} now Optional {@link Timestamp} representing current date and time
+ * @returns {Timestamp} A new {@link Timestamp}
+ */
+export declare function updateMinutes(timestamp: Timestamp, minutes: number, now?: Timestamp | null): Timestamp;
+/**
+ * Updates the {@link Timestamp} with the weekday
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @returns A new Timestamp
+ */
+export declare function updateWeekday(timestamp: Timestamp): Timestamp;
+/**
+ * Updates the {@link Timestamp} with the day of the year (doy)
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @returns A new Timestamp
+ */
+export declare function updateDayOfYear(timestamp: Timestamp): Timestamp;
+/**
+ * Updates the {@link Timestamp} with the workweek
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @returns A new {@link Timestamp}
+ */
+export declare function updateWorkWeek(timestamp: Timestamp): Timestamp;
+/**
+ * Updates the passed {@link Timestamp} with disabled, if needed
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @param {string} [disabledBefore] In `YYYY-MM-DD` format
+ * @param {string} [disabledAfter] In `YYYY-MM-DD` format
+ * @param {number[]} [disabledWeekdays] An array of numbers representing weekdays [0 = Sun, ..., 6 = Sat]
+ * @param {DisabledDays} [disabledDays] An array of days in 'YYYY-MM-DD' format. If an array with a pair of dates is in first array, then this is treated as a range. Object entries can include date/from/to plus color metadata.
+ * @returns A new {@link Timestamp}
+ */
+export declare function updateDisabled(timestamp: Timestamp, disabledBefore?: string, disabledAfter?: string, disabledWeekdays?: number[], disabledDays?: DisabledDays): Timestamp;
+/**
+ * Updates the passed {@link Timestamp} with formatted data (time string, date string, weekday, day of year and workweek)
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @returns A new {@link Timestamp}
+ */
+export declare function updateFormatted(timestamp: Timestamp): Timestamp;
+/**
+ * Returns day of the year (doy) for the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The day of the year
+ */
+export declare function getDayOfYear(timestamp: Timestamp): number | void;
+/**
+ * Returns workweek for the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The work week
+ */
+export declare function getWorkWeek(timestamp: Timestamp): number;
+/**
+ * Returns weekday for the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @returns {number} The weekday
+ */
+export declare function getWeekday(timestamp: Timestamp): number;
+/**
+ * Makes a copy of the passed in {@link Timestamp}
+ * @param {Timestamp} timestamp The original {@link Timestamp}
+ * @returns {Timestamp} A copy of the original {@link Timestamp}
+ */
+export declare function copyTimestamp(timestamp: Timestamp): Timestamp;
+/**
+ * Used internally to convert {@link Timestamp} used with 'parsed' or 'parseDate' so the 'date' portion of the {@link Timestamp} is correct.
+ * @param {Timestamp} timestamp The (raw) {@link Timestamp}
+ * @returns {string} A formatted date ('YYYY-MM-DD')
+ */
+export declare function getDate(timestamp: Timestamp): string;
+/**
+ * Used internally to convert {@link Timestamp} with 'parsed' or 'parseDate' so the 'time' portion of the {@link Timestamp} is correct.
+ * @param {Timestamp} timestamp The (raw) {@link Timestamp}
+ * @returns {string} A formatted time ('hh:mm')
+ */
+export declare function getTime(timestamp: Timestamp): string;
+/**
+ * Returns a formatted string date and time ('YYYY-YY-MM hh:mm')
+ * @param {Timestamp} timestamp The {@link Timestamp}
+ * @returns {string} A formatted date time ('YYYY-MM-DD HH:mm')
+ */
+export declare function getDateTime(timestamp: Timestamp): string;
+/**
+ * An alias for {relativeDays}
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @param {function} [mover=nextDay] The mover function to use (ie: {nextDay} or {prevDay}).
+ * @param {number} [days=1] The number of days to move.
+ * @param {number[]} [allowedWeekdays=[ 0, 1, 2, 3, 4, 5, 6 ]] An array of numbers representing the weekdays. ie: [0 = Sun, ..., 6 = Sat].
+ * @returns A new {@link Timestamp}
+ */
+export declare function moveRelativeDays(timestamp: Timestamp, mover?: typeof nextDay, days?: number, allowedWeekdays?: number[]): Timestamp;
+/**
+ * Moves the {@link Timestamp} the number of relative days
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @param {function} [mover=nextDay] The mover function to use (ie: {nextDay} or {prevDay}).
+ * @param {number} [days=1] The number of days to move.
+ * @param {number[]} [allowedWeekdays=[ 0, 1, 2, 3, 4, 5, 6 ]] An array of numbers representing the weekdays. ie: [0 = Sun, ..., 6 = Sat].
+ * @returns A new {@link Timestamp}
+ */
+export declare function relativeDays(timestamp: Timestamp, mover?: typeof nextDay, days?: number, allowedWeekdays?: number[]): Timestamp;
+/**
+ * Finds the specified weekday (forward or back) based on the {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to transform
+ * @param {number} weekday The weekday number (Sun = 0, ..., Sat = 6)
+ * @param {function} [mover=nextDay] The function to use ({prevDay} or {nextDay}).
+ * @param {number} [maxDays=6] The number of days to look forward or back.
+ * @returns A new {@link Timestamp}
+ */
+export declare function findWeekday(timestamp: Timestamp, weekday: number, mover?: typeof nextDay, maxDays?: number): Timestamp;
+/**
+ * Creates an array of {@link Timestamp}s based on start and end params
+ * @param {Timestamp} start The starting {@link Timestamp}
+ * @param {Timestamp} end The ending {@link Timestamp}
+ * @param {Timestamp} now The relative day
+ * @param {number[]} weekdays An array of numbers (representing days of the week) that are 0 (=Sunday) to 6 (=Saturday)
+ * @param {string} [disabledBefore] Days before this date are disabled (YYYY-MM-DD)
+ * @param {string} [disabledAfter] Days after this date are disabled (YYYY-MM-DD)
+ * @param {number[]} [disabledWeekdays] An array representing weekdays that are disabled [0 = Sun, ..., 6 = Sat]
+ * @param {DisabledDays} [disabledDays] An array of days in 'YYYY-MM-DD' format. If an array with a pair of dates is in first array, then this is treated as a range.
+ * @param {number} [max=42] Max days to do
+ * @param {number} [min=0]  Min days to do
+ * @returns {Timestamp[]} The requested array of {@link Timestamp}s
+ */
+export declare function createDayList(start: Timestamp, end: Timestamp, now: Timestamp, weekdays?: number[], disabledBefore?: string | undefined, disabledAfter?: string | undefined, disabledWeekdays?: number[], disabledDays?: DisabledDays, max?: number, min?: number): Timestamp[];
+/**
+ * Creates an array of interval {@link Timestamp}s based on params
+ * @param {Timestamp} timestamp The starting {@link Timestamp}
+ * @param {number} first The starting interval time
+ * @param {number} minutes How many minutes between intervals (ie: 60, 30, 15 would be common ones)
+ * @param {number} count The number of intervals needed
+ * @param {Timestamp} now A relative {@link Timestamp} with time
+ * @returns {Timestamp[]} The requested array of interval {@link Timestamp}s
+ */
+export declare function createIntervalList(timestamp: Timestamp, first: number, minutes: number, count: number, now: Timestamp): Timestamp[];
+/**
+ * Callback that returns `Intl.DateTimeFormat` options for a timestamp.
+ *
+ * Used by {@link createNativeLocaleFormatter} to let callers switch between
+ * long and short formatting styles per timestamp.
+ */
+export type LocaleFormatter = (_timestamp: Timestamp, _short: boolean) => Intl.DateTimeFormatOptions;
+/**
+ * Function that formats a weekday key for a locale.
+ */
+export type WeekdayFormatter = (_weekday: keyof typeof weekdayDateMap, _type: string, _locale?: string) => string;
+/**
+ * Function that formats a zero-based month number for a locale.
+ */
+export type MonthFormatter = (_month: number, _type?: string, _locale?: string) => string;
+/**
+ * @callback getOptions
+ * @param {Timestamp} timestamp A {@link Timestamp} object
+ * @param {boolean} short True if using short options
+ * @returns {Object} An Intl object representing options to be used
+ */
+/**
+ * @callback formatter
+ * @param {Timestamp} timestamp The {@link Timestamp} being used
+ * @param {boolean} short If short format is being requested
+ * @returns {string} The localized string of the formatted {@link Timestamp}
+ */
+/**
+ * Returns a locale formatter backed by `Intl.DateTimeFormat`.
+ *
+ * The helper is SSR-safe: if `Intl.DateTimeFormat` is unavailable in a target
+ * runtime, it returns a formatter that produces an empty string instead of
+ * throwing during module load.
+ *
+ * @param {string} locale The locale to use (ie: en-US)
+ * @param {getOptions} cb The function to call for options. This function should return an Intl formatted object. The function is passed (timestamp, short).
+ * @returns {formatter} The function has params (timestamp, short). The short is to use the short options.
+ */
+export declare function createNativeLocaleFormatter(locale: string, cb: LocaleFormatter): (_timestamp: Timestamp, _short: boolean) => string;
+/**
+ * Makes a JavaScript Date from the passed {@link Timestamp}
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @param {boolean} utc True to get Date object using UTC
+ * @returns {Date} A JavaScript Date
+ */
+export declare function makeDate(timestamp: Timestamp, utc?: boolean): Date;
+/**
+ * Makes a JavaScript Date from the passed {@link Timestamp} (with time)
+ * @param {Timestamp} timestamp The {@link Timestamp} to use
+ * @param {boolean} utc True to get Date object using UTC
+ * @returns {Date} A JavaScript Date
+ */
+export declare function makeDateTime(timestamp: Timestamp, utc?: boolean): Date;
+/**
+ * Converts a {@link Timestamp} to a local JavaScript `Date`.
+ *
+ * This is equivalent to `makeDateTime(timestamp, false)`.
+ *
+ * @param {Timestamp} timestamp The {@link Timestamp} to convert
+ * @returns {Date} A local JavaScript Date
+ */
+export declare function getDateObject(timestamp: Timestamp): Date;
+/**
+ * Validates if the input is a finite number.
+ *
+ * @param input - The value to be validated. Can be a string or a number.
+ * @returns A boolean indicating whether the input is a finite number.
+ *          Returns true if the input is a finite number, false otherwise.
+ */
+export declare function validateNumber(input: string | number): boolean;
+/**
+ * Given an array of {@link Timestamp}s, finds the max date (and possible time)
+ * @param {Timestamp[]} timestamps This is an array of {@link Timestamp}s
+ * @param {boolean=} useTime Default false; if true, uses time in the comparison as well
+ * @returns The {@link Timestamp} with the highest date (and possibly time) value
+ */
+export declare function maxTimestamp(timestamps: Timestamp[], useTime?: boolean): Timestamp;
+/**
+ * Given an array of {@link Timestamp}s, finds the min date (and possible time)
+ * @param {Timestamp[]} timestamps This is an array of {@link Timestamp}s
+ * @param {boolean=} useTime Default false; if true, uses time in the comparison as well
+ * @returns The {@link Timestamp} with the lowest date (and possibly time) value
+ */
+export declare function minTimestamp(timestamps: Timestamp[], useTime?: boolean): Timestamp;
+/**
+ * Determines if the passed {@link Timestamp} is between (or equal) to two {@link Timestamp}s (range)
+ * @param {Timestamp} timestamp The {@link Timestamp} for testing
+ * @param {Timestamp} startTimestamp The starting {@link Timestamp}
+ * @param {Timestamp} endTimestamp The ending {@link Timestamp}
+ * @param {boolean=} useTime If true, use time from the {@link Timestamp}s
+ * @returns {boolean} True if {@link Timestamp} is between (or equal) to two {@link Timestamp}s (range)
+ */
+export declare function isBetweenDates(timestamp: Timestamp, startTimestamp: Timestamp, endTimestamp: Timestamp, useTime?: boolean): boolean;
+/**
+ * Determine if two ranges of {@link Timestamp}s overlap each other
+ * @param {Timestamp} startTimestamp The starting {@link Timestamp} of first range
+ * @param {Timestamp} endTimestamp The endinging {@link Timestamp} of first range
+ * @param {Timestamp} firstTimestamp The starting {@link Timestamp} of second range
+ * @param {Timestamp} lastTimestamp The ending {@link Timestamp} of second range
+ * @returns {boolean} True if the two ranges overlap each other
+ */
+export declare function isOverlappingDates(startTimestamp: Timestamp, endTimestamp: Timestamp, firstTimestamp: Timestamp, lastTimestamp: Timestamp): boolean;
+/**
+ * Date and time offsets accepted by {@link addToDate}.
+ *
+ * Positive values add time; negative values subtract time. The result is
+ * normalized through JavaScript Date rules, so overflowing months, days,
+ * seconds, or milliseconds roll into adjacent fields.
+ */
+export interface AddToDateOptions {
+    /**
+     * Number of years to add or subtract.
+     */
+    year?: number;
+    /**
+     * Number of months to add or subtract.
+     */
+    month?: number;
+    /**
+     * Number of days to add or subtract.
+     */
+    day?: number;
+    /**
+     * Number of hours to add or subtract.
+     */
+    hour?: number;
+    /**
+     * Number of minutes to add or subtract.
+     */
+    minute?: number;
+    /**
+     * Number of seconds to add or subtract.
+     */
+    second?: number;
+    /**
+     * Number of milliseconds to add or subtract.
+     */
+    millisecond?: number;
+}
+/**
+ * Adds or subtracts date/time units from a timestamp.
+ *
+ * This function returns a new frozen {@link Timestamp}; it does not mutate the
+ * timestamp passed in.
+ *
+ * @param {Timestamp} timestamp The {@link Timestamp} object
+ * @param {Object} options configuration data
+ * @param {number=} options.year If positive, adds years. If negative, removes years.
+ * @param {number=} options.month If positive, adds months. If negative, removes month.
+ * @param {number=} options.day If positive, adds days. If negative, removes days.
+ * @param {number=} options.hour If positive, adds hours. If negative, removes hours.
+ * @param {number=} options.minute If positive, adds minutes. If negative, removes minutes.
+ * @param {number=} options.second If positive, adds seconds. If negative, removes seconds.
+ * @param {number=} options.millisecond If positive, adds milliseconds. If negative, removes milliseconds.
+ * @returns {Timestamp} A new normalized {@link Timestamp}
+ */
+export declare function addToDate(timestamp: Timestamp, options: AddToDateOptions): Timestamp;
+/**
+ * Returns number of days between two {@link Timestamp}s
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ * @returns Number of days
+ */
+export declare function daysBetween(ts1: Timestamp, ts2: Timestamp): number;
+/**
+ * Returns number of weeks between two {@link Timestamp}s
+ * @param {Timestamp} ts1 The first {@link Timestamp}
+ * @param {Timestamp} ts2 The second {@link Timestamp}
+ */
+export declare function weeksBetween(ts1: Timestamp, ts2: Timestamp): number;
+declare const weekdayDateMap: {
+    Sun: Date;
+    Mon: Date;
+    Tue: Date;
+    Wed: Date;
+    Thu: Date;
+    Fri: Date;
+    Sat: Date;
+};
+/**
+ * Returns a function that uses Intl.DateTimeFormat to format weekdays.
+ *
+ * @function getWeekdayFormatter
+ * @returns {function} A function that formats weekdays.
+ *
+ * @example
+ * const formatWeekday = getWeekdayFormatter();
+ * console.log(formatWeekday('Mon', 'long', 'en-US')); // "Monday"
+ * console.log(formatWeekday('Mon', 'short', 'fr-FR')); // "lun."
+ *
+ * @param {string} weekday - The abbreviation of the weekday (e.g., 'Mon', 'Tue', 'Wed', etc.).
+ * @param {string} [type='long'] - The type of formatting to use ('narrow', 'short', or 'long').
+ * @param {string} [locale=''] - The locale to use for formatting.
+ *
+ * @returns {string} The formatted weekday.
+ */
+export declare function getWeekdayFormatter(): WeekdayFormatter;
+/**
+ * Retrieves an array of localized weekday names.
+ *
+ * @param {string} type - The format type for the weekday names. Can be 'narrow', 'short', or 'long'.
+ * @param {string} [locale] - The locale to use for formatting. If not provided, the default locale is used.
+ * @returns {string[]} An array of localized weekday names in the specified format.
+ */
+export declare function getWeekdayNames(type: string, locale: string): string[];
+/**
+ * Creates and returns a function for formatting month names based on locale and format type.
+ *
+ * @returns {Function} A function that formats month names.
+ *   The returned function accepts the following parameters:
+ *   @param {number} month - The month to format (0-11, where 0 is January).
+ *   @param {string} [type='long'] - The format type: 'narrow', 'short', or 'long'.
+ *   @param {string} [locale] - The locale to use for formatting. If not provided, the default locale is used.
+ *   @returns {string} The formatted month name.
+ *
+ * @throws {Error} If Intl or Intl.DateTimeFormat is not supported in the environment.
+ */
+export declare function getMonthFormatter(): MonthFormatter;
+/**
+ * Retrieves an array of localized month names.
+ *
+ * @param {string} type - The format type for the month names. Can be 'narrow', 'short', or 'long'.
+ * @param {string} [locale] - The locale to use for formatting. If not provided, the default locale is used.
+ * @returns {string[]} An array of localized month names in the specified format.
+ */
+export declare function getMonthNames(type: string, locale: string): string[];
+declare const _default: {
+    PARSE_DATETIME: RegExp;
+    PARSE_DATE: RegExp;
+    PARSE_TIME: RegExp;
+    DAYS_IN_MONTH: number[];
+    DAYS_IN_MONTH_LEAP: number[];
+    DAYS_IN_MONTH_MIN: number;
+    DAYS_IN_MONTH_MAX: number;
+    MONTH_MAX: number;
+    MONTH_MIN: number;
+    DAY_MIN: number;
+    TIME_CONSTANTS: {
+        MILLISECONDS_IN: {
+            SECOND: number;
+            MINUTE: number;
+            HOUR: number;
+            DAY: number;
+            WEEK: number;
+        };
+        SECONDS_IN: {
+            MINUTE: number;
+            HOUR: number;
+            DAY: number;
+            WEEK: number;
+        };
+        MINUTES_IN: {
+            MINUTE: number;
+            HOUR: number;
+            DAY: number;
+            WEEK: number;
+        };
+        HOURS_IN: {
+            DAY: number;
+            WEEK: number;
+        };
+        DAYS_IN: {
+            WEEK: number;
+        };
+    };
+    DAYS_IN_WEEK: number;
+    MINUTES_IN_HOUR: number;
+    HOURS_IN_DAY: number;
+    FIRST_HOUR: number;
+    MILLISECONDS_IN_MINUTE: number;
+    MILLISECONDS_IN_HOUR: number;
+    MILLISECONDS_IN_DAY: number;
+    MILLISECONDS_IN_WEEK: number;
+    Timestamp: Timestamp;
+    TimeObject: TimeObject;
+    today: typeof today;
+    getStartOfWeek: typeof getStartOfWeek;
+    getEndOfWeek: typeof getEndOfWeek;
+    getStartOfMonth: typeof getStartOfMonth;
+    getEndOfMonth: typeof getEndOfMonth;
+    parseTime: typeof parseTime;
+    validateTimestamp: typeof validateTimestamp;
+    parsed: typeof parsed;
+    parseTimestamp: typeof parseTimestamp;
+    parseDate: typeof parseDate;
+    getDayIdentifier: typeof getDayIdentifier;
+    getTimeIdentifier: typeof getTimeIdentifier;
+    getDayTimeIdentifier: typeof getDayTimeIdentifier;
+    diffTimestamp: typeof diffTimestamp;
+    updateRelative: typeof updateRelative;
+    updateMinutes: typeof updateMinutes;
+    updateWeekday: typeof updateWeekday;
+    updateDayOfYear: typeof updateDayOfYear;
+    updateWorkWeek: typeof updateWorkWeek;
+    updateDisabled: typeof updateDisabled;
+    updateFormatted: typeof updateFormatted;
+    getDayOfYear: typeof getDayOfYear;
+    getWorkWeek: typeof getWorkWeek;
+    getWeekday: typeof getWeekday;
+    isLeapYear: typeof isLeapYear;
+    daysInMonth: typeof daysInMonth;
+    copyTimestamp: typeof copyTimestamp;
+    padNumber: typeof padNumber;
+    getDate: typeof getDate;
+    getTime: typeof getTime;
+    getDateTime: typeof getDateTime;
+    nextDay: typeof nextDay;
+    prevDay: typeof prevDay;
+    relativeDays: typeof relativeDays;
+    findWeekday: typeof findWeekday;
+    createDayList: typeof createDayList;
+    createIntervalList: typeof createIntervalList;
+    createNativeLocaleFormatter: typeof createNativeLocaleFormatter;
+    makeDate: typeof makeDate;
+    makeDateTime: typeof makeDateTime;
+    getDateObject: typeof getDateObject;
+    validateNumber: typeof validateNumber;
+    isBetweenDates: typeof isBetweenDates;
+    isOverlappingDates: typeof isOverlappingDates;
+    daysBetween: typeof daysBetween;
+    weeksBetween: typeof weeksBetween;
+    addToDate: typeof addToDate;
+    compareTimestamps: typeof compareTimestamps;
+    compareDate: typeof compareDate;
+    compareTime: typeof compareTime;
+    compareDateTime: typeof compareDateTime;
+    getWeekdayFormatter: typeof getWeekdayFormatter;
+    getWeekdayNames: typeof getWeekdayNames;
+    getMonthFormatter: typeof getMonthFormatter;
+    getMonthNames: typeof getMonthNames;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map