Skip to content

Commit 5dd15e1

Browse files
Merge pull request #776 from manfredsteyer/771-note-encodeURIComponent-breaking-change-in-9.1.0
Update README with 9.1.0 breaking change
2 parents 3c70008 + 68ad1d6 commit 5dd15e1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ import { JwksValidationHandler } from 'angular-oauth2-oidc';
3838

3939
Please note, that this dependency is not needed for the **code flow**, which is nowadays the **recommended** flow for single page applications. This also results in smaller bundle sizes.
4040

41+
### Breaking change in 9.1.0
42+
43+
The use of `encodeURIComponent` on the argument passed to `initImplicitFlow` and its Code Flow counterparts was mandatory before this version.
44+
Since that was considered a _bug_, the need to do so was removed.
45+
Now the reverse is true **if you're upgrading from before 9.0.0**: you need to remove any call to encode URI components in your own application, as the library will now do it for you.
46+
4147
## Tested Environment
4248

4349
Successfully tested with **Angular 9** and its Router, PathLocationStrategy as well as HashLocationStrategy and CommonJS-Bundling via webpack. At server side we've used IdentityServer (.NET / .NET Core) and Redhat's Keycloak (Java).

0 commit comments

Comments
 (0)