@zag-js/date-utils 0.10.4 → 0.11.0

package/dist/index.d.mts

@@ -0,0 +1,145 @@
+import * as _internationalized_date from '@internationalized/date';
+import { DateValue, DateDuration, DateFormatter, Calendar, CalendarDateTime } from '@internationalized/date';
+
+type DateGranularity = "day" | "hour" | "minute" | "second" | "year" | "month";
+type DateAlignment = "start" | "end" | "center";
+type DateAvailableFn = (date: DateValue, locale: string) => boolean;
+type DateAdjustFn = (options: {
+    startDate: DateValue;
+    focusedDate: DateValue;
+}) => {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: DateValue;
+};
+
+declare function alignDate(date: DateValue, alignment: DateAlignment, duration: DateDuration, locale: string, min?: DateValue | undefined, max?: DateValue | undefined): DateValue;
+declare function alignStartDate(date: DateValue, startDate: DateValue, endDate: DateValue, duration: DateDuration, locale: string, min?: DateValue | undefined, max?: DateValue | undefined): DateValue;
+
+declare function isTodayDate(date: DateValue, timeZone: string): boolean;
+declare function isDateEqual(dateA: DateValue, dateB?: DateValue | null): boolean;
+declare function isDateInvalid(date: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateDisabled(date: DateValue, startDate: DateValue, endDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateUnavailable(date: DateValue | null, isUnavailable: DateAvailableFn | undefined, locale: string, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateOutsideVisibleRange(date: DateValue, startDate: DateValue, endDate: DateValue): boolean;
+declare function isPreviousVisibleRangeInvalid(startDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isNextVisibleRangeInvalid(endDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+
+declare function alignCenter(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function alignStart(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function alignEnd(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function constrainStart(date: DateValue, aligned: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function constrainValue(date: DateValue, minValue?: DateValue, maxValue?: DateValue): DateValue;
+
+declare function getUnitDuration(duration: DateDuration): {
+    years?: number | undefined;
+    months?: number | undefined;
+    weeks?: number | undefined;
+    days?: number | undefined;
+};
+declare function getEndDate(startDate: DateValue, duration: DateDuration): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+
+/**
+ * Formats a date using the given format string as defined in:
+ * https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+ */
+declare function formatDate(value: DateValue, formatString: string, locale: string, timeZone?: string): string;
+
+declare function formatRange(startDate: DateValue, endDate: DateValue, formatter: DateFormatter, toString: (start: string, end: string) => string, timeZone: string): string;
+
+declare function formatSelectedDate(startDate: DateValue, endDate: DateValue | null, locale: string, timeZone: string): string;
+
+declare function formatVisibleRange(startDate: DateValue, endDate: DateValue | null, locale: string, timeZone: string): string;
+
+declare function getDayFormatter(locale: string, timeZone: string): DateFormatter;
+
+declare function getDecadeRange(year: number): number[];
+
+declare function getDaysInWeek(weekIndex: number, from: DateValue, locale: string, firstDayOfWeek?: number): DateValue[];
+declare function getMonthDays(from: DateValue, locale: string, numOfWeeks?: number, firstDayOfWeek?: number): DateValue[][];
+
+declare function getMonthFormatter(locale: string, timeZone: string): DateFormatter;
+
+declare function getMonthNames(locale: string, format?: Intl.DateTimeFormatOptions["month"]): string[];
+
+declare function getWeekDays(date: DateValue, startOfWeekProp: number | undefined, timeZone: string, locale: string): {
+    value: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+    short: string;
+    long: string;
+    narrow: string;
+}[];
+
+declare function getWeekdayFormats(locale: string, timeZone: string): <T extends DateValue | Date>(value: T) => {
+    value: T;
+    short: string;
+    long: string;
+    narrow: string;
+};
+
+interface YearsRange {
+    from: number;
+    to: number;
+}
+declare function getYearsRange(range: YearsRange): number[];
+
+declare function getTodayDate(timeZone?: string): _internationalized_date.CalendarDate;
+declare function getNextDay(date: DateValue): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function getPreviousDay(date: DateValue): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setMonth(date: DateValue, month: number): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setYear(date: DateValue, year: number): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setCalendar(date: DateValue, calendar: Calendar): _internationalized_date.CalendarDateTime;
+declare function setDate(date: DateValue, startDate: DateValue, isDateUnavailable: DateAvailableFn, locale: string, minValue: DateValue, maxValue: DateValue): DateValue | undefined;
+declare function getPreviousAvailableDate(date: DateValue, minValue: DateValue, locale: string, isDateUnavailable?: DateAvailableFn): DateValue | undefined;
+
+declare function getAdjustedDateFn(visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): (options: {
+    startDate: DateValue;
+    focusedDate: DateValue;
+}) => {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getNextPage(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getPreviousPage(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getNextRow(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getPreviousRow(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getSectionStart(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getSectionEnd(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getNextSection(focusedDate: DateValue, startDate: DateValue, larger: boolean, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getPreviousSection(focusedDate: DateValue, startDate: DateValue, larger: boolean, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+
+declare function parseDateString(date: string, locale: string, timeZone: string): CalendarDateTime | undefined;
+
+export { DateAdjustFn, DateGranularity, YearsRange, alignCenter, alignDate, alignEnd, alignStart, alignStartDate, constrainStart, constrainValue, formatDate, formatRange, formatSelectedDate, formatVisibleRange, getAdjustedDateFn, getDayFormatter, getDaysInWeek, getDecadeRange, getEndDate, getMonthDays, getMonthFormatter, getMonthNames, getNextDay, getNextPage, getNextRow, getNextSection, getPreviousAvailableDate, getPreviousDay, getPreviousPage, getPreviousRow, getPreviousSection, getSectionEnd, getSectionStart, getTodayDate, getUnitDuration, getWeekDays, getWeekdayFormats, getYearsRange, isDateDisabled, isDateEqual, isDateInvalid, isDateOutsideVisibleRange, isDateUnavailable, isNextVisibleRangeInvalid, isPreviousVisibleRangeInvalid, isTodayDate, parseDateString, setCalendar, setDate, setMonth, setYear };

package/dist/index.d.ts

@@ -1,20 +1,145 @@
-export * from "./align";
-export * from "./assertion";
-export * from "./constrain";
-export * from "./duration";
-export * from "./format-date";
-export * from "./format-range";
-export * from "./format-selected-date";
-export * from "./format-visible-range";
-export * from "./get-day-formatter";
-export * from "./get-decade-range";
-export * from "./get-month-days";
-export * from "./get-month-formatter";
-export * from "./get-month-names";
-export * from "./get-week-days";
-export * from "./get-weekday-formats";
-export * from "./get-year-range";
-export * from "./mutation";
-export * from "./pagination";
-export * from "./parse-date";
-export type { DateAdjustFn, DateGranularity } from "./types";
+import * as _internationalized_date from '@internationalized/date';
+import { DateValue, DateDuration, DateFormatter, Calendar, CalendarDateTime } from '@internationalized/date';
+
+type DateGranularity = "day" | "hour" | "minute" | "second" | "year" | "month";
+type DateAlignment = "start" | "end" | "center";
+type DateAvailableFn = (date: DateValue, locale: string) => boolean;
+type DateAdjustFn = (options: {
+    startDate: DateValue;
+    focusedDate: DateValue;
+}) => {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: DateValue;
+};
+
+declare function alignDate(date: DateValue, alignment: DateAlignment, duration: DateDuration, locale: string, min?: DateValue | undefined, max?: DateValue | undefined): DateValue;
+declare function alignStartDate(date: DateValue, startDate: DateValue, endDate: DateValue, duration: DateDuration, locale: string, min?: DateValue | undefined, max?: DateValue | undefined): DateValue;
+
+declare function isTodayDate(date: DateValue, timeZone: string): boolean;
+declare function isDateEqual(dateA: DateValue, dateB?: DateValue | null): boolean;
+declare function isDateInvalid(date: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateDisabled(date: DateValue, startDate: DateValue, endDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateUnavailable(date: DateValue | null, isUnavailable: DateAvailableFn | undefined, locale: string, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isDateOutsideVisibleRange(date: DateValue, startDate: DateValue, endDate: DateValue): boolean;
+declare function isPreviousVisibleRangeInvalid(startDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+declare function isNextVisibleRangeInvalid(endDate: DateValue, minValue?: DateValue | null, maxValue?: DateValue | null): boolean;
+
+declare function alignCenter(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function alignStart(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function alignEnd(date: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function constrainStart(date: DateValue, aligned: DateValue, duration: DateDuration, locale: string, min?: DateValue, max?: DateValue): DateValue;
+declare function constrainValue(date: DateValue, minValue?: DateValue, maxValue?: DateValue): DateValue;
+
+declare function getUnitDuration(duration: DateDuration): {
+    years?: number | undefined;
+    months?: number | undefined;
+    weeks?: number | undefined;
+    days?: number | undefined;
+};
+declare function getEndDate(startDate: DateValue, duration: DateDuration): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+
+/**
+ * Formats a date using the given format string as defined in:
+ * https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
+ */
+declare function formatDate(value: DateValue, formatString: string, locale: string, timeZone?: string): string;
+
+declare function formatRange(startDate: DateValue, endDate: DateValue, formatter: DateFormatter, toString: (start: string, end: string) => string, timeZone: string): string;
+
+declare function formatSelectedDate(startDate: DateValue, endDate: DateValue | null, locale: string, timeZone: string): string;
+
+declare function formatVisibleRange(startDate: DateValue, endDate: DateValue | null, locale: string, timeZone: string): string;
+
+declare function getDayFormatter(locale: string, timeZone: string): DateFormatter;
+
+declare function getDecadeRange(year: number): number[];
+
+declare function getDaysInWeek(weekIndex: number, from: DateValue, locale: string, firstDayOfWeek?: number): DateValue[];
+declare function getMonthDays(from: DateValue, locale: string, numOfWeeks?: number, firstDayOfWeek?: number): DateValue[][];
+
+declare function getMonthFormatter(locale: string, timeZone: string): DateFormatter;
+
+declare function getMonthNames(locale: string, format?: Intl.DateTimeFormatOptions["month"]): string[];
+
+declare function getWeekDays(date: DateValue, startOfWeekProp: number | undefined, timeZone: string, locale: string): {
+    value: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+    short: string;
+    long: string;
+    narrow: string;
+}[];
+
+declare function getWeekdayFormats(locale: string, timeZone: string): <T extends DateValue | Date>(value: T) => {
+    value: T;
+    short: string;
+    long: string;
+    narrow: string;
+};
+
+interface YearsRange {
+    from: number;
+    to: number;
+}
+declare function getYearsRange(range: YearsRange): number[];
+
+declare function getTodayDate(timeZone?: string): _internationalized_date.CalendarDate;
+declare function getNextDay(date: DateValue): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function getPreviousDay(date: DateValue): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setMonth(date: DateValue, month: number): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setYear(date: DateValue, year: number): _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+declare function setCalendar(date: DateValue, calendar: Calendar): _internationalized_date.CalendarDateTime;
+declare function setDate(date: DateValue, startDate: DateValue, isDateUnavailable: DateAvailableFn, locale: string, minValue: DateValue, maxValue: DateValue): DateValue | undefined;
+declare function getPreviousAvailableDate(date: DateValue, minValue: DateValue, locale: string, isDateUnavailable?: DateAvailableFn): DateValue | undefined;
+
+declare function getAdjustedDateFn(visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): (options: {
+    startDate: DateValue;
+    focusedDate: DateValue;
+}) => {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getNextPage(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getPreviousPage(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+};
+declare function getNextRow(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getPreviousRow(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getSectionStart(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getSectionEnd(focusedDate: DateValue, startDate: DateValue, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getNextSection(focusedDate: DateValue, startDate: DateValue, larger: boolean, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+declare function getPreviousSection(focusedDate: DateValue, startDate: DateValue, larger: boolean, visibleDuration: DateDuration, locale: string, minValue?: DateValue, maxValue?: DateValue): {
+    startDate: DateValue;
+    focusedDate: DateValue;
+    endDate: _internationalized_date.CalendarDate | _internationalized_date.CalendarDateTime | _internationalized_date.ZonedDateTime;
+} | undefined;
+
+declare function parseDateString(date: string, locale: string, timeZone: string): CalendarDateTime | undefined;
+
+export { DateAdjustFn, DateGranularity, YearsRange, alignCenter, alignDate, alignEnd, alignStart, alignStartDate, constrainStart, constrainValue, formatDate, formatRange, formatSelectedDate, formatVisibleRange, getAdjustedDateFn, getDayFormatter, getDaysInWeek, getDecadeRange, getEndDate, getMonthDays, getMonthFormatter, getMonthNames, getNextDay, getNextPage, getNextRow, getNextSection, getPreviousAvailableDate, getPreviousDay, getPreviousPage, getPreviousRow, getPreviousSection, getSectionEnd, getSectionStart, getTodayDate, getUnitDuration, getWeekDays, getWeekdayFormats, getYearsRange, isDateDisabled, isDateEqual, isDateInvalid, isDateOutsideVisibleRange, isDateUnavailable, isNextVisibleRangeInvalid, isPreviousVisibleRangeInvalid, isTodayDate, parseDateString, setCalendar, setDate, setMonth, setYear };