Skip to content

Commit

Permalink
Merge pull request #776 from manfredsteyer/771-note-encodeURIComponen…
Browse files Browse the repository at this point in the history
…t-breaking-change-in-9.1.0

Update README with 9.1.0 breaking change
  • Loading branch information
manfredsteyer authored Mar 28, 2020
2 parents 3c70008 + 68ad1d6 commit 5dd15e1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ import { JwksValidationHandler } from 'angular-oauth2-oidc';

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.

### Breaking change in 9.1.0

The use of `encodeURIComponent` on the argument passed to `initImplicitFlow` and its Code Flow counterparts was mandatory before this version.
Since that was considered a _bug_, the need to do so was removed.
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.

## Tested Environment

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).
Expand Down

0 comments on commit 5dd15e1

Please sign in to comment.