Skip to content

Commit eb99b27

Browse files
Prepare v2.0.0 release.
1 parent 360a308 commit eb99b27

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## [Unreleased]
44

5+
## [2.0.0] - 2020-04-20
6+
57
### Breaking
68
* Core: Capacitor 2.x is new minimum peer dependency. closes #80.
79
* `responseType` is required. Default values were removed. In favor of configuring anything. closes #86.
@@ -67,8 +69,7 @@ This is controlled by Android specific parameters `handleResultOnNewIntent` for
6769
- Android: Fix Java compiler error #36 (thx @Anthbs)
6870
- Fix github security error by updating Jest lib
6971

70-
71-
[Unreleased]: https://github.com/moberwasserlechner/capacitor-oauth2/compare/1.1.0...master
72+
[Unreleased]: https://github.com/moberwasserlechner/capacitor-oauth2/compare/2.0.0...master
7273
[2.0.0]: https://github.com/moberwasserlechner/capacitor-oauth2/compare/1.1.0...2.0.0
7374
[1.1.0]: https://github.com/moberwasserlechner/capacitor-oauth2/compare/1.0.1...1.1.0
7475
[1.0.1]: https://github.com/moberwasserlechner/capacitor-oauth2/compare/1.0.0...1.0.1

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![npm](https://img.shields.io/npm/dt/@byteowls/capacitor-oauth2.svg?label=npm%20downloads)](https://www.npmjs.com/package/@byteowls/capacitor-oauth2)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/michaelowl_web.svg?style=social&label=Follow&style=flat-square)](https://twitter.com/michaelowl_web)
77

8-
This is a simple OAuth 2 client plugin. **No OpenID** support!
8+
This is a simple OAuth 2 client plugin.
99

1010
It let you configure the oauth parameters yourself instead of using SDKs. Therefore it is usable with various providers.
1111
See [providers](#list-of-providers) the community has already used this plugin with.
@@ -14,7 +14,7 @@ See [providers](#list-of-providers) the community has already used this plugin w
1414

1515
| Plugin | Minimum Capacitor | Docs | Notes |
1616
|--------|-------------------|----------------------------------------------------------------------------------------|--------------------------------|
17-
| 2.x | 2.0.0 | [README](https://github.com/moberwasserlechner/capacitor-oauth2/blob/master/README.md) | XCode 11.4 needs this version |
17+
| 2.x | 2.0.0 | [README](https://github.com/moberwasserlechner/capacitor-oauth2/blob/master/README.md) | Breaking changes see Changelog. XCode 11.4 needs this version |
1818
| 1.x | 1.0.0 | [README](https://github.com/moberwasserlechner/capacitor-oauth2/blob/1.1.0/README.md) | |
1919

2020
For further details on what has changed see the [CHANGELOG](https://github.com/moberwasserlechner/capacitor-oauth2/blob/master/CHANGELOG.md).
@@ -25,6 +25,10 @@ Starting with version **2.0.0** the plugin will no longer restrict the `response
2525

2626
Developers can configure anything. It is their responsibility to use the options the chosen OAuth Provider supports.
2727

28+
See the excellent article about OAuth2 response type combinations.
29+
30+
https://medium.com/@darutk/diagrams-of-all-the-openid-connect-flows-6968e3990660
31+
2832
The plugin on the other will behave differently depending on the existence of certain config parameters:
2933

3034
These parameters are:
@@ -35,11 +39,7 @@ These parameters are:
3539
e.g.
3640

3741
If `responseType=code`, `pkceDisable=true` and `accessTokenEndpoint` is missing the `authorizationCode` will be resolve along with the whole authorization response.
38-
This only works for web and Android. On iOS the used lib does not allows to cancel after the authorization request see #13
39-
40-
See the excellent article about OAuth2 response type combinations.
41-
42-
https://medium.com/@darutk/diagrams-of-all-the-openid-connect-flows-6968e3990660
42+
This only works for the Web and Android. On iOS the used lib does not allows to cancel after the authorization request see #13.
4343

4444
### Tested / working flows
4545

@@ -78,7 +78,7 @@ Minimum Capacitor version is **2.0.0**
7878

7979
This example shows the common process of configuring this plugin.
8080

81-
Although it was taken from a Angular 6 application, it should work in other frameworks as well.
81+
Although it was taken from a Angular application, it should work in other frameworks as well.
8282

8383
### Register plugin
8484

@@ -176,7 +176,6 @@ But be aware that only the parameters from the accessToken request are included
176176
* ERR_PARAM_NO_AUTHORIZATION_BASE_URL ... The authorization base url is missing. (web, android, ios)
177177
* ERR_PARAM_NO_RESPONSE_TYPE ... The response type is missing. (web, android, ios)
178178
* ERR_PARAM_NO_REDIRECT_URL ... The redirect url is missing. (web, android, ios)
179-
180179
* ERR_STATES_NOT_MATCH ... The state included in the authorization code request does not match the one in the redirect. Security risk! (web, android, ios)
181180
* ERR_AUTHORIZATION_FAILED ... The authorization failed.
182181
* ERR_NO_ACCESS_TOKEN ... No access_token found. (web, android)

0 commit comments

Comments
 (0)