@checkdigit/time 3.0.0-PR.17-5aaf → 4.0.0-PR.18-81a3

package/dist-types/date-fns/types.d.ts

@@ -1,70 +1,233 @@
 import type { Locale } from './locale/types';
-export interface GenericDateConstructor<DateType> {
+export type * from './locale/types';
+export type * from './fp/types';
+/**
+ * The generic date constructor. Replicates the Date constructor. Used to build
+ * generic functions.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ */
+export interface GenericDateConstructor<DateType extends Date = Date> {
+    /**
+     * The date constructor. Creates date with the current date and time.
+     *
+     * @returns The date instance
+     */
     new (): DateType;
+    /**
+     * The date constructor. Creates date with the passed date, number of
+     * milliseconds or string to parse.
+     *
+     * @param value - The date, number of milliseconds or string to parse
+     *
+     * @returns The date instance
+     */
     new (value: Date | number | string): DateType;
+    /**
+     * The date constructor. Creates date with the passed date values (year,
+     * month, etc.) Note that the month is 0-indexed.
+     *
+     * @param year - The year
+     * @param month - The month. Note that the month is 0-indexed.
+     * @param date - The day of the month
+     * @param hours - The hours
+     * @param minutes - The minutes
+     * @param seconds - The seconds
+     * @param ms - The milliseconds
+     *
+     * @returns The date instance
+     */
     new (year: number, month: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): DateType;
 }
+/**
+ * The duration object. Contains the duration in the units specified by the
+ * object.
+ */
 export interface Duration {
+    /** The number of years in the duration */
     years?: number;
+    /** The number of months in the duration */
     months?: number;
+    /** The number of weeks in the duration */
     weeks?: number;
+    /** The number of days in the duration */
     days?: number;
+    /** The number of hours in the duration */
     hours?: number;
+    /** The number of minutes in the duration */
     minutes?: number;
+    /** The number of seconds in the duration */
     seconds?: number;
 }
+/**
+ * The duration unit type alias.
+ */
 export type DurationUnit = keyof Duration;
+/**
+ * An object that combines two dates to represent the time interval.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ */
 export interface Interval<DateType extends Date = Date> {
-    start: DateType | number;
-    end: DateType | number;
-}
-export interface StepOptions {
-    step?: number;
-}
-export interface WeekStartOptions {
-    weekStartsOn?: Day;
-}
-export interface FirstWeekContainsDateOptions {
-    firstWeekContainsDate?: FirstWeekContainsDate;
-}
-export interface LocaleOptions {
-    locale?: Locale;
+    /** The start of the interval. */
+    start: DateType | number | string;
+    /** The end of the interval. */
+    end: DateType | number | string;
 }
-export interface FormatOptions {
-    format?: 'extended' | 'basic';
-}
-export interface RepresentationOptions {
-    representation?: 'complete' | 'date' | 'time';
+/**
+ * A version of {@link Interval} that has both start and end resolved to Date.
+ */
+export interface NormalizedInterval<DateType extends Date = Date> {
+    /** The start of the interval. */
+    start: DateType;
+    /** The end of the interval. */
+    end: DateType;
 }
+/**
+ * The era. Can be either 0 (AD - Anno Domini) or 1 (BC - Before Christ).
+ */
 export type Era = 0 | 1;
+/**
+ * The year quarter. Goes from 1 to 4.
+ */
 export type Quarter = 1 | 2 | 3 | 4;
+/**
+ * The day of the week type alias. Unlike the date (the number of days since
+ * the beginning of the month), which begins with 1 and is dynamic (can go up to
+ * 28, 30, or 31), the day starts with 0 and static (always ends at 6). Look at
+ * it as an index in an array where Sunday is the first element and Saturday
+ * is the last.
+ */
 export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+/**
+ * The month type alias. Goes from 0 to 11, where 0 is January and 11 is
+ * December.
+ */
 export type Month = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
 /**
- * FirstWeekContainsDate is used to determine which week is the first week of the year, based on what day the January, 1 is in that week.
+ * FirstWeekContainsDate is used to determine which week is the first week of
+ * the year, based on what day the January, 1 is in that week.
  *
  * The day in that week can only be 1 (Monday) or 4 (Thursday).
  *
- * Please see https://en.wikipedia.org/wiki/Week#Week_numbering for more information.
+ * Please see https://en.wikipedia.org/wiki/Week#The_ISO_week_date_system for more information.
  */
 export type FirstWeekContainsDate = 1 | 4;
+/**
+ * The date values, used to set or get date object values.
+ */
 export interface DateValues {
+    /** The year */
     year?: number;
+    /** The month */
     month?: number;
+    /** The day of the month */
     date?: number;
+    /** The hours */
     hours?: number;
+    /** The minutes */
     minutes?: number;
+    /** The seconds */
     seconds?: number;
+    /** The milliseconds */
     milliseconds?: number;
 }
+/**
+ * The number rounding method.
+ */
 export type RoundingMethod = 'ceil' | 'floor' | 'round' | 'trunc';
+/**
+ * The ISO string format.
+ *
+ * - basic: Minimal number of separators
+ * - extended: With separators added to enhance human readability
+ */
+export type ISOStringFormat = 'extended' | 'basic';
+/**
+ * The ISO date representation. Represents which component the string includes,
+ * date, time or both.
+ */
+export type ISOStringRepresentation = 'complete' | 'date' | 'time';
+/**
+ * The step function options. Used to build function options.
+ */
+export interface StepOptions {
+    /** The step to use when iterating */
+    step?: number;
+}
+/**
+ * The week function options. Used to build function options.
+ */
+export interface WeekOptions {
+    /** Which day the week starts on. */
+    weekStartsOn?: Day;
+}
+/**
+ * The first week contains date options. Used to build function options.
+ */
+export interface FirstWeekContainsDateOptions {
+    /** See {@link FirstWeekContainsDate} for more details. */
+    firstWeekContainsDate?: FirstWeekContainsDate;
+}
+/**
+ * The localized function options. Used to build function options.
+ *
+ * @typeParam LocaleFields - The locale fields used in the relevant function. Defines the minimum set of locale fields that must be provided.
+ */
+export interface LocalizedOptions<LocaleFields extends keyof Locale> {
+    /** The locale to use in the function. */
+    locale?: Pick<Locale, LocaleFields>;
+}
+/**
+ * The ISO format function options. Used to build function options.
+ */
+export interface ISOFormatOptions {
+    /** The format to use: basic with minimal number of separators or extended
+     * with separators added to enhance human readability */
+    format?: ISOStringFormat;
+    /** The date representation - what component to format: date, time\
+     * or both (complete) */
+    representation?: ISOStringRepresentation;
+}
+/**
+ * The rounding options. Used to build function options.
+ */
 export interface RoundingOptions {
+    /** The rounding method to use */
     roundingMethod?: RoundingMethod;
 }
-export type Unit = 'second' | 'minute' | 'hour' | 'day' | 'dayOfYear' | 'date' | 'week' | 'month' | 'quarter' | 'year';
-export type FormatDistanceStrictUnit = 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year';
+/**
+ * Additional tokens options. Used to build function options.
+ */
 export interface AdditionalTokensOptions {
+    /** If true, allows usage of the week-numbering year tokens `YY` and `YYYY`.
+     * See: https://date-fns.org/docs/Unicode-Tokens */
     useAdditionalWeekYearTokens?: boolean;
+    /** If true, allows usage of the day of year tokens `D` and `DD`.
+     * See: https://date-fns.org/docs/Unicode-Tokens */
     useAdditionalDayOfYearTokens?: boolean;
 }
-export type IntlOptionsUnit = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
+/**
+ * Nearest minute type. Goes from 1 to 30, where 1 is the nearest minute and 30
+ * is nearest half an hour.
+ */
+export type NearestMinutes = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30;
+/**
+ * Nearest hour type. Goes from 1 to 12, where 1 is the nearest hour and 12
+ * is nearest half a day.
+ */
+export type NearestHours = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+/**
+ * The nearest minutes function options. Used to build function options.
+ *
+ * @deprecated Use {@link NearestToUnitOptions} instead.
+ */
+export type NearestMinutesOptions = NearestToUnitOptions<NearestMinutes>;
+/**
+ * The nearest unit function options. Used to build function options.
+ */
+export interface NearestToUnitOptions<Unit extends number> {
+    /** The nearest unit to round to. E.g. for minutes `15` to round to quarter
+     * hours. */
+    nearestTo?: Unit;
+}

package/dist-types/date-fns/weeksToDays/index.d.ts

@@ -6,13 +6,13 @@
  * @description
  * Convert a number of weeks to a full number of days.
  *
- * @param weeks - number of weeks to be converted
+ * @param weeks - The number of weeks to be converted
  *
- * @returns the number of weeks converted in days
+ * @returns The number of weeks converted in days
  *
  * @example
  * // Convert 2 weeks into days
  * const result = weeksToDays(2)
  * //=> 14
  */
-export default function weeksToDays(weeks: number): number;
+export declare function weeksToDays(weeks: number): number;

package/dist-types/date-fns/yearsToDays/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @name yearsToDays
+ * @category Conversion Helpers
+ * @summary Convert years to days.
+ *
+ * @description
+ * Convert a number of years to a full number of days.
+ *
+ * @param years - The number of years to be converted
+ *
+ * @returns The number of years converted in days
+ *
+ * @example
+ * // Convert 2 years into days
+ * const result = yearsToDays(2)
+ * //=> 730
+ */
+export declare function yearsToDays(years: number): number;

package/dist-types/date-fns/yearsToMonths/index.d.ts

@@ -6,13 +6,13 @@
  * @description
  * Convert a number of years to a full number of months.
  *
- * @param years - number of years to be converted
+ * @param years - The number of years to be converted
  *
- * @returns the number of years converted in months
+ * @returns The number of years converted in months
  *
  * @example
  * // Convert 2 years into months
  * const result = yearsToMonths(2)
  * //=> 24
  */
-export default function yearsToMonths(years: number): number;
+export declare function yearsToMonths(years: number): number;

package/dist-types/date-fns/yearsToQuarters/index.d.ts

@@ -6,13 +6,13 @@
  * @description
  * Convert a number of years to a full number of quarters.
  *
- * @param years - number of years to be converted
+ * @param years - The number of years to be converted
  *
- * @returns the number of years converted in quarters
+ * @returns The number of years converted in quarters
  *
  * @example
  * // Convert 2 years to quarters
  * const result = yearsToQuarters(2)
  * //=> 8
  */
-export default function yearsToQuarters(years: number): number;
+export declare function yearsToQuarters(years: number): number;

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/time","version":"3.0.0-PR.17-5aaf","description":"Standard time handling","author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/time/issues"},"homepage":"https://github.com/checkdigit/time#readme","repository":{"type":"git","url":"git+https://github.com/checkdigit/time.git"},"engines":{"node":">=20.11"},"type":"module","sideEffects":false,"exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"devDependencies":{"@checkdigit/eslint-config":"^9.2.0","@checkdigit/jest-config":"^6.0.0","@checkdigit/prettier-config":"^5.3.0","@checkdigit/typescript-config":"^7.0.0","@js-temporal/polyfill":"^0.4.4","rimraf":"^5.0.5"},"scripts":{"prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","lint":"eslint --max-warnings 0 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prettier":"prettier --ignore-path .gitignore --ignore-path .prettierignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --ignore-path .prettierignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style","ci:compile":"tsc --noEmit","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier"},"jest":{"preset":"@checkdigit/jest-config"},"eslintConfig":{"extends":["@checkdigit/eslint-config"],"ignorePatterns":["src/date-fns/**","src/date-fns-tz/**"]},"prettier":"@checkdigit/prettier-config"}
+{"name":"@checkdigit/time","version":"4.0.0-PR.18-81a3","description":"Standard time handling","author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/time/issues"},"homepage":"https://github.com/checkdigit/time#readme","repository":{"type":"git","url":"git+https://github.com/checkdigit/time.git"},"engines":{"node":">=20.11"},"type":"module","sideEffects":false,"exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"devDependencies":{"@checkdigit/eslint-config":"^9.2.0","@checkdigit/jest-config":"^6.0.0","@checkdigit/prettier-config":"^5.3.0","@checkdigit/typescript-config":"^7.0.0","@date-fns/utc":"^1.2.0","@js-temporal/polyfill":"^0.4.4","fp-ts":"^2.16.2","js-fns":"^2.5.1","rimraf":"^5.0.5","sinon":"^7.4.1","vitest":"^1.3.1"},"scripts":{"prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","lint":"eslint --max-warnings 0 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style","ci:compile":"tsc --noEmit","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false && vitest --config ./vitest.config.test.ts run","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true && vitest --config ./vitest.config.test.ts run","ci:lint":"npm run lint","ci:style":"npm run prettier"},"jest":{"preset":"@checkdigit/jest-config"},"eslintConfig":{"extends":["@checkdigit/eslint-config"],"ignorePatterns":["src/date-fns/**","src/date-fns-tz/**"]},"prettier":"@checkdigit/prettier-config"}

package/src/date-fns/CHANGELOG.md

@@ -8,7 +8,245 @@ This change log follows the format documented in [Keep a CHANGELOG].
 [semantic versioning]: http://semver.org/
 [keep a changelog]: http://keepachangelog.com/
 
-## v2.29.1 - 2022-07-22
+## v3.6.0 - 2024-03-18
+
+On this release worked @kossnocorp and @world1dan. Also, thanks to [@seated](https://github.com/seated) [for sponsoring me](https://github.com/sponsors/kossnocorp).
+
+### Fixed
+
+- [Fixed weeks in the Belarisuan locale's `formatDistance`.](https://github.com/date-fns/date-fns/pull/3720)
+
+### Added
+
+- [Added CDN versions of modules compatible with older browsers.](https://github.com/date-fns/date-fns/pull/3737) [See the CDN guide.](https://date-fns.org/docs/CDN)
+
+## v3.5.0 - 2024-03-15
+
+Kudos to @fturmel, @kossnocorp, @makstyle119, @tan75, @marcreichel, @tareknatsheh and @audunru for working on the release. Also, thanks to [@seated](https://github.com/seated) [for sponsoring me](https://github.com/sponsors/kossnocorp).
+
+### Fixed
+
+- [Fixed functions that use current date internally and made them work with date extensions like `UTCDate`.](https://github.com/date-fns/date-fns/issues/3730)
+
+- [Fixed `daysToWeeks` returning negative 0.](https://github.com/date-fns/date-fns/commit/882ced61c692c7c4a79eaaec6eb07cb9c8c9195b)
+
+- [Fixed German grammar for the "half a minute" string.](https://github.com/date-fns/date-fns/pull/3715)
+
+### Added
+
+- [Added the Northern Sámi (`se`) locale.](https://github.com/date-fns/date-fns/pull/3724)
+
+- Added the `constructNow` function that creates the current date using the passed reference date's constructor.
+
+## v3.4.0 - 2024-03-11
+
+Kudos to @kossnocorp, @sakamossan and @Revan99 for working on the release. Also, thanks to [@seated](https://github.com/seated) [for sponsoring me](https://github.com/sponsors/kossnocorp).
+
+### Added
+
+- [Added `roundToNearestHours` function.](https://github.com/date-fns/date-fns/pull/2752)
+
+- [Added Central Kurdish (`ckb`) locale.](https://github.com/date-fns/date-fns/pull/3421)
+
+## v3.3.1 - 2024-01-22
+
+Kudos to @kossnocorp and @fturmel for working on the release.
+
+### Fixed
+
+- Fixed DST issue in `getOverlappingDaysInIntervals`, resulting in an inconsistent number of days returned for intervals starting and ending in different DST periods.
+
+- Fixed functions incorrectly using `trunc` instead of `round`. The bug was introduced in v3.3.0. The affected functions: `differenceInCalendarDays`, `differenceInCalendarISOWeeks`, `differenceInCalendarWeeks`, `getISOWeek`, `getWeek`, and `getISOWeeksInYear`.
+
+## v3.3.0 - 2024-01-20
+
+On this release worked @kossnocorp, @TheKvikk, @fturmel and @ckcherry23.
+
+### Fixed
+
+- Fixed the bug in `getOverlappingDaysInIntervals` caused by incorrect sorting of interval components that led to 0 for timestamps of different lengths.
+
+- Fixed bugs when working with negative numbers caused by using `Math.floor` (`-1.1` → `-2`) instead of `Math.trunc` (`-1.1` → `-1`). Most of the conversion functions (i.e., `hoursToMinutes`) were affected when passing some negative fractional input. Also, some other functions that could be possibly affected by unfortunate timezone/date combinations were fixed.
+
+  The functions that were affected: `format`, `parse`, `getUnixTime`, `daysToWeeks`, `hoursToMilliseconds`, `hoursToMinutes`, `hoursToSeconds`, `milliseconds`, `minutesToMilliseconds`, `millisecondsToMinutes`, `monthsToYears`, `millisecondsToHours`, `millisecondsToSeconds`, `minutesToHours`, `minutesToSeconds`, `yearsToQuarters`, `yearsToMonths`, `yearsToDays`, `weeksToDays`, `secondsToMinutes`, `secondsToHours`, `quartersToYears`, `quartersToMonths` and `monthsToQuarters`.
+
+- [Fixed the Czech locale's `formatDistance` to include `1` in `formatDistance`.](https://github.com/date-fns/date-fns/pull/3269)
+
+- Fixed `differenceInSeconds` and other functions relying on rounding options that can produce a negative 0.
+
+- [Added a preprocessor to the locales API, enabling fixing a long-standing bug in the French locale.](https://github.com/date-fns/date-fns/pull/3662) ([#1391](https://github.com/date-fns/date-fns/issues/1391))
+
+- Added missing `yearsToDays` to the FP submodule.
+
+- Made functions using rounding methods always return `0` instead of `-0`.
+
+### Added
+
+- [Added `format` alias `formatDate` with corresponding `FormatDateOptions` interface](https://github.com/date-fns/date-fns/pull/3653).
+
+## v3.2.0 - 2024-01-09
+
+This release is brought to you by @kossnocorp, @fturmel, @grossbart, @MelvinVermeer, and @jcarstairs-scottlogic.
+
+### Fixed
+
+- Fixed types compatability with Lodash's `flow` and fp-ts's `pipe`. ([#3641](https://github.com/date-fns/date-fns/issues/3641))
+
+- [Fixed inconsistent behavior of `roundToNearestMinutes`.](https://github.com/date-fns/date-fns/pull/3132)
+
+### Added
+
+- Added exports of `format`, `lightFormat`, and `parse` internals that enable 3rd-parties to consume those.
+
+## v3.1.0 - 2024-01-05
+
+This release is brought to you by @kossnocorp, @makstyle119 and @dmgawel.
+
+### Fixed
+
+- [Fixed the plural form of weeks in Swedish](https://github.com/date-fns/date-fns/pull/3448).
+
+### Added
+
+- [Added `yearsToDays` function](https://github.com/date-fns/date-fns/pull/3540).
+
+- Added warning about using protected tokens like `Y` or `D` without passing a corresponding option. [See #2950](https://github.com/date-fns/date-fns/issues/2950).
+
+## v3.0.6 - 2023-12-22
+
+On this release worked @imwh0im, @jamcry and @tyrw.
+
+### Fixed
+
+- [Fixed bug in `areIntervalsOverlapping` caused by incorrect sorting](https://github.com/date-fns/date-fns/pull/3628) ([#3614](https://github.com/date-fns/date-fns/issues/3614))
+
+## v3.0.5 - 2023-12-21
+
+This release is brought to you by @goku4199.
+
+### Fixed
+
+- [Fixed internal `toDate` not processing string arguments properly](https://github.com/date-fns/date-fns/pull/3626)
+
+## v3.0.4 - 2023-12-21
+
+This release is brought to you by @kossnocorp.
+
+### Fixed
+
+- Fixed isWithinInterval bug caused by incorrectly sorting dates ([#3623](https://github.com/date-fns/date-fns/issues/3623)).
+
+## v3.0.3 - 2023-12-21
+
+### Fixed
+
+- Rolled back pointing ESM types to the same `d.ts` files. Instead now it copies the content to avoid [the Masquerading as CJS problem](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md) reported by "Are the types wrong?".
+
+## v3.0.2 - 2023-12-21
+
+### Fixed
+
+- Fixed [yet another issue caused by ESM types](https://github.com/date-fns/date-fns/issues/3620) by pointing to the same `d.ts` files.
+
+- [Added `package.json` to exports](https://github.com/date-fns/date-fns/pull/3601) to provide access to tooling.
+
+- [Fixed TypeScript 5.4 build break](https://github.com/date-fns/date-fns/pull/3598) by using the latest type names.
+
+## v3.0.1 - 2023-12-20
+
+### Fixed
+
+- [Fixed an error](https://github.com/date-fns/date-fns/pull/3618) in certain environments caused by `d.mts` files exporting only types.
+
+## v3.0.0 - 2023-12-18
+
+### Changed
+
+- **BREAKING**: date-fns is now a dual-package with the support of both ESM and CommonJS. The files exports are now explicitly in the `package.json`. The ESM files now have `.mjs` extension.
+
+- **BREAKING**: The package now has a flat structure, meaning functions are now named `node_modules/date-fns/add.mjs`, locales are `node_modules/date-fns/locale/enUS.mjs`, etc.
+
+- **BREAKING**: Now all file content’s exported via named exports instead of `export default`, which will require change direct imports i.e. `const addDays = require(‘date-fns/addDays’)` to `const { addDays } = require(‘date-fns/addDays’)`.
+
+- **BREAKING**: TypeScript types are now completely rewritten, check out the `d.ts` files for more information.
+
+- **BREAKING**: `constants` now is not exported via the index, so to import one use `import { daysInYear } from "date-fns/constants";`. It improves compatibility with setups that modularize imports [like Next.js](https://twitter.com/kossnocorp/status/1731181274579325260).
+
+- **BREAKING**: Functions now don’t check the number of passed arguments, delegating this task to type checkers. The functions are now slimmer because of this.
+
+- **BREAKING** The arguments are not explicitly converted to the target types. Instead, they are passed as is, delegating this task to type checkers.
+
+- **BREAKING**: Functions that accept `Interval` arguments now do not throw an error if the start is before the end and handle it as a negative interval. If one of the properties in an `Invalid Date`, these functions also do not throw and handle them as invalid intervals.
+
+  - `areIntervalsOverlapping` normalize intervals before comparison, so `{ start: a, end: b }` is practically equivalent to `{ start: b, end: a }`. When comparing intervals with one of the properties being `Invalid Date`, the function will return false unless the others are valid and equal, given the `inclusive` option is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always return `false`.
+
+  - `getOverlappingDaysInIntervals` now normalizes intervals before comparison, so `{ start: a, end: b }` is practically equivalent to `{ start: b, end: a }`. If any of the intervals’ properties is an `Invalid Date`, the function will always return 0.
+
+  - `isWithinInterval` now normalizes intervals before comparison, so `{ start: a, end: b }` is practically equivalent to `{ start: b, end: a }`. If any of the intervals’ properties is an `Invalid Date`, the function will always return false.
+
+  - `intervalToDuration` now returns negative durations for negative intervals. If one or both of the interval properties are invalid, the function will return an empty object.
+
+  - The eachXOfInterval functions (`eachDayOfInterval`, `eachHourOfInterval`, `eachMinuteOfInterval`, `eachMonthOfInterval`, `eachWeekendOfInterval`, `eachWeekendOfMonth`, `eachWeekendOfYear`, `eachWeekOfInterval`, `eachYearOfInterval`) now return a reversed array if the passed interval’s start is after the end. Invalid properties will result in an empty array. Functions that accept the `step` option now also allow negative, 0, and NaN values and return reversed results if the step is negative and an empty array otherwise.
+
+- **BREAKING**: `intervalToDuration` now skips 0 values in the resulting duration, resulting in more compact objects with only relevant properties.
+
+- **BREAKING**: `roundToNearestMinutes` now returns `Invalid Date` instead of throwing an error when `nearestTo` option is less than 1 or more than 30.
+
+- **BREAKING**: IE is no longer supported.
+
+- **BREAKING**: Now all functions use `Math.trunc` rounding method where rounding is required. The behavior is configurable on a per-function basis.
+
+- **BREAKING**: Undocumented `onlyNumeric` option was removed from `nn` and `sv` locales. If you relied on it, [please contact me](mailto:koss@nocorp.me).
+
+- **BREAKING**: Flow is not supported anymore. If you relied on it, [please contact me](mailto:koss@nocorp.me).
+
+- **BREAKING**: The locales now use regular functions instead of the UTC version, which should not break any code unless you used locales directly.
+
+### Added
+
+- All functions that accept date arguments now also accept strings.
+
+- All functions now export options interfaces.
+
+- Now functions allow passing custom Date extensions like [UTCDate](https://github.com/date-fns/utc). They will detect and use the arguments constructor to generate the result of the same class.
+
+- `eachMonthOfInterval`, `eachQuarterOfInterval`, `eachWeekOfInterval`, and `eachYearOfInterval` now accept the `step` option like most of the eachXOfInterval functions.
+
+- A new `interval` function that validates interval, emulating the v2 interval functions behavior.
+
+- `differenceInX` functions now accept options and allow setting up `roundingMethod` that configures how the result is rounded. `Math.trunc` is the default method.
+
+## v2.30.0
+
+Kudos to @kossnocorp and @Andarist for working on the release.
+
+### Changes
+
+- Fixed increased build size after enabling compatibility with older browsers in the previous release. This was done by adding @babel/runtime as a dependency. [See more details](https://github.com/date-fns/date-fns/issues/3208#issuecomment-1528592465).
+
+## v2.29.3 - 2022-09-13
+
+This release is prepared by our own @leshakoss.
+
+### Fixed
+
+- [Fixed Ukrainian (`uk`) locale grammar for `formatDistance`.](https://github.com/date-fns/date-fns/pull/3175)
+
+- [Improved browser compatibility by transforming the code with `@babel/preset-env`.](https://github.com/date-fns/date-fns/pull/3167)
+
+## v2.29.2 - 2022-08-18
+
+This release is brought to you by @nopears, @vadimpopa and @leshakoss.
+
+### Fixed
+
+- [Fixed `sv` locale abbreviated months matcher.](https://github.com/date-fns/date-fns/pull/3160)
+
+- [Fixed `uk` locale abbreviated months matcher.](https://github.com/date-fns/date-fns/pull/3139)
+
+- [Fixed a breaking change in `intervalToDuration` by removing a recently introduced RangeError.](https://github.com/date-fns/date-fns/pull/3153)
+
+## v2.29.1 - 2022-08-18
 
 Thanks to @fturmel for working on the release.
 

package/src/date-fns/_lib/addLeadingZeros/index.ts

@@ -1,8 +1,5 @@
-export default function addLeadingZeros(number: number, targetLength: number): string {
+export function addLeadingZeros(number: number, targetLength: number): string {
   const sign = number < 0 ? '-' : '';
-  let output = Math.abs(number).toString();
-  while (output.length < targetLength) {
-    output = '0' + output;
-  }
+  const output = Math.abs(number).toString().padStart(targetLength, '0');
   return sign + output;
 }

package/src/date-fns/_lib/addLeadingZeros/test.mts

@@ -0,0 +1,12 @@
+import { describe, expect, it } from 'vitest';
+import { addLeadingZeros } from './index';
+
+describe('addLeadingZeros', () => {
+  it('adds leading zeros when number has fewer digits than target length', () => {
+    expect(addLeadingZeros(7, 3)).toBe('007');
+    expect(addLeadingZeros(7, 2)).toBe('07');
+    expect(addLeadingZeros(7, 1)).toBe('7');
+    expect(addLeadingZeros(7, 0)).toBe('7');
+    expect(addLeadingZeros(7, -1)).toBe('7');
+  });
+});

package/src/date-fns/_lib/defaultLocale/index.ts

@@ -1,2 +1 @@
-import defaultLocale from '../../locale/en-US/index';
-export default defaultLocale;
+export { enUS as defaultLocale } from '../../locale/en-US/index';

package/src/date-fns/_lib/defaultOptions/index.ts

@@ -1,6 +1,6 @@
-import type { FirstWeekContainsDateOptions, LocaleOptions, WeekStartOptions } from '../../types';
+import type { FirstWeekContainsDateOptions, Locale, LocalizedOptions, WeekOptions } from '../../types';
 
-export type DefaultOptions = LocaleOptions & WeekStartOptions & FirstWeekContainsDateOptions;
+export type DefaultOptions = LocalizedOptions<keyof Locale> & WeekOptions & FirstWeekContainsDateOptions;
 
 let defaultOptions: DefaultOptions = {};