Skip to content

Commit

Permalink
fix(deps): update dependency date-fns to v4 (#1051)
Browse files Browse the repository at this point in the history
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [date-fns](https://redirect.github.com/date-fns/date-fns) | [`^3.6.0`
-> `^4.0.0`](https://renovatebot.com/diffs/npm/date-fns/3.6.0/4.1.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/date-fns/4.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/date-fns/4.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/date-fns/3.6.0/4.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/date-fns/3.6.0/4.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>date-fns/date-fns (date-fns)</summary>

###
[`v4.1.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v410---2024-09-17)

[Compare
Source](https://redirect.github.com/date-fns/date-fns/compare/v4.0.0...v4.1.0)

This release adds time zone support to format functions (that I somehow
missed when working on the feature) and fixes a few bugs.

Make sure also upgrade `TZDate` to v1.0.2 as it [includes a bunch of
critical bug
fixes](https://redirect.github.com/date-fns/tz/blob/main/CHANGELOG.md#v102---2024-09-14).

##### Fixed

- Fixed internal `constructFrom` throwing an exception on `null`
arguments. While `null` isn't allowed, the functions should rather
return `Invalid Date` or `NaN` in such cases. See
[#&#8203;3885](https://redirect.github.com/date-fns/date-fns/issues/3885).

##### Added

- Added missing time zone support to `format`, `formatISO`,
`formatISO9075`, `formatRelative` and `formatRFC3339`. See
[#&#8203;3886](https://redirect.github.com/date-fns/date-fns/issues/3886).

###
[`v4.0.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v400---2024-09-16)

[Compare
Source](https://redirect.github.com/date-fns/date-fns/compare/v3.6.0...v4.0.0)

I have great news! First, ten years after its release, date-fns finally
gets first-class time zone support.

Another great news is that there aren't many breaking changes in this
release. All of them are type-related and will affect only those
explicitly using internal date-fns types. Finally, it has been less than
a year since the last major release, which is an improvement over the
previous four years between v2 and v3. I plan on keeping the pace and
minimizing breaking changes moving forward.

[Read more about the release in the announcement blog
post](https://blog.date-fns.org/v40-with-time-zone-support/).

\- [Sasha @&#8203;kossnocorp](https://twitter.com/kossnocorp)

##### Added

- Added time zones support via
[`@date-fns/tz`](https://redirect.github.com/date-fns/tz)'s `TZDate`
class and `tz` helper function. See its
[README](https://redirect.github.com/date-fns/tz) for the details about
the API.

- All relevant functions now accept the context `in` option, which
allows to specify the time zone to make the calculations in. If the
function also returns a date, it will be in the specified time zone:

    ```ts
    import { addDays, startOfDay } from "date-fns";
    import { tz } from "@&#8203;date-fns/tz";

    startOfDay(addDays(Date.now(), 5, { in: tz("Asia/Singapore") }));
    //=> "2024-09-16T00:00:00.000+08:00"
    ```

In the example, `addDays` will get the current date and time in
Singapore and add 5 days to it. `startOfDay` will inherit the date type
and return the start of the day in Singapore.

##### Changed

- The function arguments, as well as `Interval`'s `start` and `end`, now
can be of different types, allowing you to mix `UTCDate`, `TZDate`,
`Date`, and other extensions, as well as primitives (strings and
numbers).

The functions will normalize these values, make calculations, and return
the result in the same type, preventing any bugs caused by the
discrepancy. If passed, the type will be inferred from the context `in`
option or the first encountered argument object type. The `Interval`'s
`start` and `end` will be considered separately, starting from `start`.

In the given example, the result will be in the `TZDate` as the first
argument is a number, and the `start` takes precedence over the `end`.

    ```ts
    clamp(Date.now(), {
      start: new TZDate(start, "Asia/Singapore"),
      end: new UTCDate(),
    });
    //=> TZDate
    ```

- **BREAKING**: This release contains a bunch of types changes that
should not affect the library's expected usage. The changes are
primarily internal and nuanced, so rather than listing them here, I
recommend you running the type checker after the upgrade. If there are
unfixable problems, please [open an
issue](https://redirect.github.com/date-fns/date-fns/issues/new).

- **BREAKING**: The package now is ESM-first. The CommonJS is still
support and It should not affect most users, but it might break in
certains environments. If you encounter any issues, please [report
them](https://redirect.github.com/date-fns/date-fns/issues/new).

##### Fixed

- Fixed CDN build compatibility with jQuery and other tools that expose
`$` by properly wrapping the code in an IIFE.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/UK-Export-Finance/mdm-api).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xNDIuNCIsInVwZGF0ZWRJblZlciI6IjM4LjE0Mi40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Abhi Markan <[email protected]>
  • Loading branch information
renovate[bot] and abhi-markan authored Nov 4, 2024
1 parent a9ff5b8 commit 9ab56af
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
32 changes: 16 additions & 16 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"class-transformer": "^0.5.1",
"class-validator": "^0.14.1",
"compression": "^1.7.5",
"date-fns": "^3.6.0",
"date-fns": "^4.1.0",
"dotenv": "^16.4.1",
"express-basic-auth": "^1.2.1",
"lodash": "^4.17.21",
Expand Down

0 comments on commit 9ab56af

Please sign in to comment.