From 69238d1507b4029ed6269c6eb913c6339478c997 Mon Sep 17 00:00:00 2001 From: Thomas Norling Date: Wed, 15 Jan 2025 11:18:26 -0800 Subject: [PATCH] Update changelogs with links to migration guides (#7510) Update changelogs to highlight the breaking changes and link to migration guides --- lib/msal-angular/CHANGELOG.md | 6 +++--- lib/msal-browser/CHANGELOG.md | 9 ++++----- lib/msal-browser/docs/v3-migration.md | 3 ++- lib/msal-node/CHANGELOG.md | 9 ++++----- lib/msal-react/CHANGELOG.md | 5 +++-- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/lib/msal-angular/CHANGELOG.md b/lib/msal-angular/CHANGELOG.md index 19030faabd..7b16aa9742 100644 --- a/lib/msal-angular/CHANGELOG.md +++ b/lib/msal-angular/CHANGELOG.md @@ -8,11 +8,11 @@ Wed, 15 Jan 2025 05:05:16 GMT -### Patches +### Breaking Changes - Update msal-browser peer dependency to include v4 (thomas.norling@microsoft.com) -- Bump @azure/msal-browser to v4.0.1 -- Bump eslint-config-msal to v0.0.0 + +Please see the msal-browser [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details on what's changed in v4. ## 3.1.0 diff --git a/lib/msal-browser/CHANGELOG.md b/lib/msal-browser/CHANGELOG.md index 8971c09d9b..1cb69e99eb 100644 --- a/lib/msal-browser/CHANGELOG.md +++ b/lib/msal-browser/CHANGELOG.md @@ -8,14 +8,13 @@ Wed, 15 Jan 2025 05:05:17 GMT -### Patches +### Breaking Changes - Rename `native` to `platformBroker` in public API and docs (sameera.gajjarapu@microsoft.com) - Encrypt localStorage to reduce persistence to browser session lifetime (thomas.norling@microsoft.com) -- Bump @azure/msal-common to v15.0.1 -- Bump eslint-config-msal to v0.0.0 -- Bump msal-test-utils to v0.0.1 -- Bump rollup-msal to v0.0.0 +- Bump @azure/msal-common to v15.0.1 (beachball) + +Please see the [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details. ## 3.28.1 diff --git a/lib/msal-browser/docs/v3-migration.md b/lib/msal-browser/docs/v3-migration.md index 674f204105..aace64228e 100644 --- a/lib/msal-browser/docs/v3-migration.md +++ b/lib/msal-browser/docs/v3-migration.md @@ -66,4 +66,5 @@ Starting in v4, if you are using the `localStorage` cache location, auth artifac This cookie will be automatically removed when the browser instance (not tab) is closed, thus making it impossible to decrypt any auth artifacts after the session has ended. These expired auth artifacts will be removed the next time MSAL is initialized and the user may need to reauthenticate. The `localStorage` location still provides cross-tab cache persistence but will no longer persist across browser sessions. -> [!Important] The purpose of this encryption is to reduce the persistence of auth artifacts, **not** to provide additional security. If a bad actor gains access to browser storage they would also have access to the key or have the ability to request tokens on your behalf without the need for cache at all. It is your responsibility to ensure your application is not vulnerable to XSS attacks [see below](#security) \ No newline at end of file +> [!Important] +> The purpose of this encryption is to reduce the persistence of auth artifacts, **not** to provide additional security. If a bad actor gains access to browser storage they would also have access to the key or have the ability to request tokens on your behalf without the need for cache at all. It is your responsibility to ensure your application is not vulnerable to XSS attacks [see below](#security) diff --git a/lib/msal-node/CHANGELOG.md b/lib/msal-node/CHANGELOG.md index 18629b53e1..3876f9c9eb 100644 --- a/lib/msal-node/CHANGELOG.md +++ b/lib/msal-node/CHANGELOG.md @@ -8,12 +8,11 @@ Wed, 15 Jan 2025 05:05:17 GMT -### Patches +### Breaking Changes -- Asynchronous cache writes (thomas.norling@microsoft.com) -- Bump @azure/msal-common to v15.0.1 -- Bump eslint-config-msal to v0.0.0 -- Bump rollup-msal to v0.0.0 +- NodeStorage is no longer exported + +Please see the [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/v2-migration.md) for more details. ## 2.16.2 diff --git a/lib/msal-react/CHANGELOG.md b/lib/msal-react/CHANGELOG.md index d68a198f84..8b351f884c 100644 --- a/lib/msal-react/CHANGELOG.md +++ b/lib/msal-react/CHANGELOG.md @@ -8,12 +8,13 @@ Wed, 15 Jan 2025 05:05:17 GMT -### Patches +### Breaking Changes - Update msal-browser peer dependency to include v4 (thomas.norling@microsoft.com) - Rename `native` to `platformBroker` in public API and docs (sameera.gajjarapu@microsoft.com) - Bump @azure/msal-browser to v4.0.1 -- Bump eslint-config-msal to v0.0.0 + +- Please see the msal-browser [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details on what's changed in v4. ## 2.2.0