@internationalized/date 3.12.0 → 3.12.2

package/dist/types/src/queries.d.ts

@@ -0,0 +1,93 @@
+import { AnyCalendarDate, AnyTime, Calendar } from './types';
+import { CalendarDate, CalendarDateTime, DateValue, ZonedDateTime } from './CalendarDate';
+/** Returns whether the given dates occur on the same day, regardless of the time or calendar system. */
+export declare function isSameDay(a: DateValue, b: DateValue): boolean;
+/**
+ * Returns whether the given dates occur in the same month, using the calendar system of the first
+ * date.
+ */
+export declare function isSameMonth(a: DateValue, b: DateValue): boolean;
+/**
+ * Returns whether the given dates occur in the same year, using the calendar system of the first
+ * date.
+ */
+export declare function isSameYear(a: DateValue, b: DateValue): boolean;
+/** Returns whether the given dates occur on the same day, and are of the same calendar system. */
+export declare function isEqualDay(a: DateValue, b: DateValue): boolean;
+/** Returns whether the given dates occur in the same month, and are of the same calendar system. */
+export declare function isEqualMonth(a: DateValue, b: DateValue): boolean;
+/** Returns whether the given dates occur in the same year, and are of the same calendar system. */
+export declare function isEqualYear(a: DateValue, b: DateValue): boolean;
+/** Returns whether two calendars are the same. */
+export declare function isEqualCalendar(a: Calendar, b: Calendar): boolean;
+/** Returns whether the date is today in the given time zone. */
+export declare function isToday(date: DateValue, timeZone: string): boolean;
+type DayOfWeek = 'sun' | 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat';
+/**
+ * Returns the day of week for the given date and locale. Days are numbered from zero to six,
+ * where zero is the first day of the week in the given locale. For example, in the United States,
+ * the first day of the week is Sunday, but in France it is Monday.
+ */
+export declare function getDayOfWeek(date: DateValue, locale: string, firstDayOfWeek?: DayOfWeek): number;
+/** Returns the current time in the given time zone. */
+export declare function now(timeZone: string): ZonedDateTime;
+/** Returns today's date in the given time zone. */
+export declare function today(timeZone: string): CalendarDate;
+export declare function compareDate(a: AnyCalendarDate, b: AnyCalendarDate): number;
+export declare function compareTime(a: AnyTime, b: AnyTime): number;
+/**
+ * Returns the number of hours in the given date and time zone.
+ * Usually this is 24, but it could be 23 or 25 if the date is on a daylight saving transition.
+ */
+export declare function getHoursInDay(a: CalendarDate, timeZone: string): number;
+/** Returns the time zone identifier for the current user. */
+export declare function getLocalTimeZone(): string;
+/** Sets the time zone identifier for the current user. */
+export declare function setLocalTimeZone(timeZone: string): void;
+/** Resets the time zone identifier for the current user. */
+export declare function resetLocalTimeZone(): void;
+/** Returns whether the local time zone has been explicitly overridden via `setLocalTimeZone`. */
+export declare function isLocalTimeZoneOverridden(): boolean;
+/** Returns the first date of the month for the given date. */
+export declare function startOfMonth(date: ZonedDateTime): ZonedDateTime;
+export declare function startOfMonth(date: CalendarDateTime): CalendarDateTime;
+export declare function startOfMonth(date: CalendarDate): CalendarDate;
+export declare function startOfMonth(date: DateValue): DateValue;
+/** Returns the last date of the month for the given date. */
+export declare function endOfMonth(date: ZonedDateTime): ZonedDateTime;
+export declare function endOfMonth(date: CalendarDateTime): CalendarDateTime;
+export declare function endOfMonth(date: CalendarDate): CalendarDate;
+export declare function endOfMonth(date: DateValue): DateValue;
+/** Returns the first day of the year for the given date. */
+export declare function startOfYear(date: ZonedDateTime): ZonedDateTime;
+export declare function startOfYear(date: CalendarDateTime): CalendarDateTime;
+export declare function startOfYear(date: CalendarDate): CalendarDate;
+export declare function startOfYear(date: DateValue): DateValue;
+/** Returns the last day of the year for the given date. */
+export declare function endOfYear(date: ZonedDateTime): ZonedDateTime;
+export declare function endOfYear(date: CalendarDateTime): CalendarDateTime;
+export declare function endOfYear(date: CalendarDate): CalendarDate;
+export declare function endOfYear(date: DateValue): DateValue;
+export declare function getMinimumMonthInYear(date: AnyCalendarDate): number;
+export declare function getMinimumDayInMonth(date: AnyCalendarDate): number;
+/** Returns the first date of the week for the given date and locale. */
+export declare function startOfWeek(date: ZonedDateTime, locale: string, firstDayOfWeek?: DayOfWeek): ZonedDateTime;
+export declare function startOfWeek(date: CalendarDateTime, locale: string, firstDayOfWeek?: DayOfWeek): CalendarDateTime;
+export declare function startOfWeek(date: CalendarDate, locale: string, firstDayOfWeek?: DayOfWeek): CalendarDate;
+export declare function startOfWeek(date: DateValue, locale: string, firstDayOfWeek?: DayOfWeek): DateValue;
+/** Returns the last date of the week for the given date and locale. */
+export declare function endOfWeek(date: ZonedDateTime, locale: string, firstDayOfWeek?: DayOfWeek): ZonedDateTime;
+export declare function endOfWeek(date: CalendarDateTime, locale: string, firstDayOfWeek?: DayOfWeek): CalendarDateTime;
+export declare function endOfWeek(date: CalendarDate, locale: string, firstDayOfWeek?: DayOfWeek): CalendarDate;
+export declare function endOfWeek(date: DateValue, locale: string, firstDayOfWeek?: DayOfWeek): DateValue;
+/** Returns the number of weeks in the given month and locale. */
+export declare function getWeeksInMonth(date: DateValue, locale: string, firstDayOfWeek?: DayOfWeek): number;
+/** Returns the lesser of the two provider dates. */
+export declare function minDate<A extends DateValue, B extends DateValue>(a?: A | null, b?: B | null): A | B | null | undefined;
+/** Returns the greater of the two provider dates. */
+export declare function maxDate<A extends DateValue, B extends DateValue>(a?: A | null, b?: B | null): A | B | null | undefined;
+/** Returns whether the given date is on a weekend in the given locale. */
+export declare function isWeekend(date: DateValue, locale: string): boolean;
+/** Returns whether the given date is on a weekday in the given locale. */
+export declare function isWeekday(date: DateValue, locale: string): boolean;
+export {};

package/dist/types/src/string.d.ts

@@ -0,0 +1,36 @@
+import { AnyDateTime, DateTimeDuration, Disambiguation } from './types';
+import { CalendarDate, CalendarDateTime, Time, ZonedDateTime } from './CalendarDate';
+/** Parses an ISO 8601 time string. */
+export declare function parseTime(value: string): Time;
+/** Parses an ISO 8601 date string, with no time components. */
+export declare function parseDate(value: string): CalendarDate;
+/** Parses an ISO 8601 date and time string, with no time zone. */
+export declare function parseDateTime(value: string): CalendarDateTime;
+/**
+ * Parses an ISO 8601 date and time string with a time zone extension and optional UTC offset (e.g.
+ * "2021-11-07T00:45[America/Los_Angeles]" or "2021-11-07T00:45-07:00[America/Los_Angeles]").
+ * Ambiguous times due to daylight saving time transitions are resolved according to the
+ * `disambiguation` parameter.
+ */
+export declare function parseZonedDateTime(value: string, disambiguation?: Disambiguation): ZonedDateTime;
+/**
+ * Parses an ISO 8601 date and time string with a UTC offset (e.g. "2021-11-07T07:45:00Z"
+ * or "2021-11-07T07:45:00-07:00"). The result is converted to the provided time zone.
+ */
+export declare function parseAbsolute(value: string, timeZone: string): ZonedDateTime;
+/**
+ * Parses an ISO 8601 date and time string with a UTC offset (e.g. "2021-11-07T07:45:00Z"
+ * or "2021-11-07T07:45:00-07:00"). The result is converted to the user's local time zone.
+ */
+export declare function parseAbsoluteToLocal(value: string): ZonedDateTime;
+export declare function timeToString(time: Time): string;
+export declare function dateToString(date: CalendarDate): string;
+export declare function dateTimeToString(date: AnyDateTime): string;
+export declare function zonedDateTimeToString(date: ZonedDateTime): string;
+/**
+ * Parses an ISO 8601 duration string (e.g. "P3Y6M6W4DT12H30M5S").
+ *
+ * @param value An ISO 8601 duration string.
+ * @returns A DateTimeDuration object.
+ */
+export declare function parseDuration(value: string): Required<DateTimeDuration>;

package/dist/types/src/types.d.ts

@@ -0,0 +1,136 @@
+import { CalendarDate } from './CalendarDate';
+/** An interface that is compatible with any object with date fields. */
+export interface AnyCalendarDate {
+    readonly calendar: Calendar;
+    readonly era: string;
+    readonly year: number;
+    readonly month: number;
+    readonly day: number;
+    copy(): this;
+}
+/** An interface that is compatible with any object with time fields. */
+export interface AnyTime {
+    readonly hour: number;
+    readonly minute: number;
+    readonly second: number;
+    readonly millisecond: number;
+    copy(): this;
+}
+/** An interface that is compatible with any object with both date and time fields. */
+export interface AnyDateTime extends AnyCalendarDate, AnyTime {
+}
+export type CalendarIdentifier = 'gregory' | 'buddhist' | 'chinese' | 'coptic' | 'dangi' | 'ethioaa' | 'ethiopic' | 'hebrew' | 'indian' | 'islamic' | 'islamic-umalqura' | 'islamic-tbla' | 'islamic-civil' | 'islamic-rgsa' | 'iso8601' | 'japanese' | 'persian' | 'roc';
+/**
+ * The Calendar interface represents a calendar system, including information
+ * about how days, months, years, and eras are organized, and methods to perform
+ * arithmetic on dates.
+ */
+export interface Calendar {
+    /**
+     * A string identifier for the calendar, as defined by Unicode CLDR. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/supportedValuesOf#supported_calendar_types).
+     */
+    identifier: CalendarIdentifier;
+    /** Creates a CalendarDate in this calendar from the given Julian day number. */
+    fromJulianDay(jd: number): CalendarDate;
+    /** Converts a date in this calendar to a Julian day number. */
+    toJulianDay(date: AnyCalendarDate): number;
+    /** Returns the number of days in the month of the given date. */
+    getDaysInMonth(date: AnyCalendarDate): number;
+    /** Returns the number of months in the year of the given date. */
+    getMonthsInYear(date: AnyCalendarDate): number;
+    /** Returns the number of years in the era of the given date. */
+    getYearsInEra(date: AnyCalendarDate): number;
+    /** Returns a list of era identifiers for the calendar. */
+    getEras(): string[];
+    /**
+     * Returns the minimum month number of the given date's year.
+     * Normally, this is 1, but in some calendars such as the Japanese,
+     * eras may begin in the middle of a year.
+     */
+    getMinimumMonthInYear?(date: AnyCalendarDate): number;
+    /**
+     * Returns the minimum day number of the given date's month.
+     * Normally, this is 1, but in some calendars such as the Japanese,
+     * eras may begin in the middle of a month.
+     */
+    getMinimumDayInMonth?(date: AnyCalendarDate): number;
+    /** Returns the maximum months across all years. */
+    getMaximumMonthsInYear(): number;
+    /** Returns the maximum days across all months. */
+    getMaximumDaysInMonth(): number;
+    /**
+     * Returns a date that is the first day of the month for the given date.
+     * This is used to determine the month that the given date falls in, if
+     * the calendar has months that do not align with the standard calendar months
+     * (e.g. fiscal calendars).
+     */
+    getFormattableMonth?(date: AnyCalendarDate): CalendarDate;
+    /** Returns whether the given calendar is the same as this calendar. */
+    isEqual?(calendar: Calendar): boolean;
+    /** @private */
+    balanceDate?(date: AnyCalendarDate): void;
+    /** @private */
+    balanceYearMonth?(date: AnyCalendarDate, previousDate: AnyCalendarDate): void;
+    /** @private */
+    constrainDate?(date: AnyCalendarDate): void;
+    /** @private */
+    isInverseEra?(date: AnyCalendarDate): boolean;
+}
+/** Represents an amount of time in calendar-specific units, for use when performing arithmetic. */
+export interface DateDuration {
+    /** The number of years to add or subtract. */
+    years?: number;
+    /** The number of months to add or subtract. */
+    months?: number;
+    /** The number of weeks to add or subtract. */
+    weeks?: number;
+    /** The number of days to add or subtract. */
+    days?: number;
+}
+/** Represents an amount of time, for use whe performing arithmetic. */
+export interface TimeDuration {
+    /** The number of hours to add or subtract. */
+    hours?: number;
+    /** The number of minutes to add or subtract. */
+    minutes?: number;
+    /** The number of seconds to add or subtract. */
+    seconds?: number;
+    /** The number of milliseconds to add or subtract. */
+    milliseconds?: number;
+}
+/**
+ * Represents an amount of time with both date and time components, for use when performing
+ * arithmetic.
+ */
+export interface DateTimeDuration extends DateDuration, TimeDuration {
+}
+export interface DateFields {
+    era?: string;
+    year?: number;
+    month?: number;
+    day?: number;
+}
+export interface TimeFields {
+    hour?: number;
+    minute?: number;
+    second?: number;
+    millisecond?: number;
+}
+export type DateField = keyof DateFields;
+export type TimeField = keyof TimeFields;
+export type Disambiguation = 'compatible' | 'earlier' | 'later' | 'reject';
+export interface CycleOptions {
+    /** Whether to round the field value to the nearest interval of the amount. */
+    round?: boolean;
+}
+export interface CycleTimeOptions extends CycleOptions {
+    /**
+     * Whether to use 12 or 24 hour time. If 12 hour time is chosen, the resulting value
+     * will remain in the same day period as the original value (e.g. if the value is AM,
+     * the resulting value also be AM).
+     *
+     * @default 24
+     */
+    hourCycle?: 12 | 24;
+}

package/dist/types/src/utils.d.ts

@@ -0,0 +1,4 @@
+export type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export declare function mod(amount: number, numerator: number): number;

package/dist/types/src/weekStartData.d.ts

@@ -0,0 +1,97 @@
+export declare const weekStartData: {
+    '001': number;
+    AD: number;
+    AE: number;
+    AF: number;
+    AI: number;
+    AL: number;
+    AM: number;
+    AN: number;
+    AR: number;
+    AT: number;
+    AU: number;
+    AX: number;
+    AZ: number;
+    BA: number;
+    BE: number;
+    BG: number;
+    BH: number;
+    BM: number;
+    BN: number;
+    BY: number;
+    CH: number;
+    CL: number;
+    CM: number;
+    CN: number;
+    CR: number;
+    CY: number;
+    CZ: number;
+    DE: number;
+    DJ: number;
+    DK: number;
+    DZ: number;
+    EC: number;
+    EE: number;
+    EG: number;
+    ES: number;
+    FI: number;
+    FJ: number;
+    FO: number;
+    FR: number;
+    GB: number;
+    GE: number;
+    GF: number;
+    GP: number;
+    GR: number;
+    HR: number;
+    HU: number;
+    IE: number;
+    IQ: number;
+    IR: number;
+    IS: number;
+    IT: number;
+    JO: number;
+    KG: number;
+    KW: number;
+    KZ: number;
+    LB: number;
+    LI: number;
+    LK: number;
+    LT: number;
+    LU: number;
+    LV: number;
+    LY: number;
+    MC: number;
+    MD: number;
+    ME: number;
+    MK: number;
+    MN: number;
+    MQ: number;
+    MV: number;
+    MY: number;
+    NL: number;
+    NO: number;
+    NZ: number;
+    OM: number;
+    PL: number;
+    QA: number;
+    RE: number;
+    RO: number;
+    RS: number;
+    RU: number;
+    SD: number;
+    SE: number;
+    SI: number;
+    SK: number;
+    SM: number;
+    SY: number;
+    TJ: number;
+    TM: number;
+    TR: number;
+    UA: number;
+    UY: number;
+    UZ: number;
+    VA: number;
+    VN: number;
+    XK: number;
+};

package/package.json

@@ -1,35 +1,50 @@
 {
   "name": "@internationalized/date",
-  "version": "3.12.0",
+  "version": "3.12.2",
   "description": "Internationalized calendar, date, and time manipulation utilities",
   "license": "Apache-2.0",
-  "main": "dist/main.js",
-  "module": "dist/module.js",
-  "exports": {
-    "source": "./src/index.ts",
-    "types": [
-      "./dist/types.d.ts",
-      "./src/index.ts"
-    ],
-    "import": "./dist/import.mjs",
-    "require": "./dist/main.js"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adobe/react-spectrum/tree/main/packages/@internationalized/date"
   },
-  "types": "dist/types.d.ts",
   "source": "src/index.ts",
   "files": [
     "dist",
     "src"
   ],
   "sideEffects": false,
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/adobe/react-spectrum/tree/main/packages/@internationalized/date"
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/types/src/index.d.ts",
+  "exports": {
+    "source": "./src/index.ts",
+    "types": "./dist/types/src/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
     "@swc/helpers": "^0.5.0"
   },
-  "publishConfig": {
-    "access": "public"
+  "import": "dist/index.mjs",
+  "targets": {
+    "types": false,
+    "module": {
+      "engines": {
+        "browsers": [
+          "chrome >= 79",
+          "firefox >= 85",
+          "safari >= 13"
+        ]
+      }
+    },
+    "import": {
+      "isLibrary": true,
+      "outputFormat": "esmodule",
+      "includeNodeModules": false
+    }
   },
-  "gitHead": "8df187370053aa35f553cb388ad670f65e1ab371"
+  "gitHead": "3577a20859b9585a000010c720f6ee39c1c588cc"
 }