Skip to content

Commit

Permalink
feat: update sdk version (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
simeng-li authored Sep 9, 2024
1 parent 10b7506 commit 31dee5f
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 1 deletion.
45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,48 @@ Fix the `OpenIdClaims` class key parsing issue:

Previous key mapping values are always empty as they are not available in the IdToken claims.
This fix update the key mapping to the correct values.

## 2.1.0

### New Features

Add extra parameters to the signIn method for better sign-in experience customization.

See the [Authentication parameters](https://docs.logto.io/docs/references/openid-connect/authentication-parameters) for more details.

1. `directSignIn`: This parameter allows you to skip the first screen of the sign-in page and directly go to the social or enterprise sso connectors's sign-in page.

- `social:<idp-name>`: Use the specified social connector, e.g. `social:google`
- `sso:<connector-id>`: Use the specified enterprise sso connector, e.g. `sso:123456`

2. `firstScreen`: This parameter allows you to customize the first screen that users see when they start the authentication process. The value for this parameter can be:

- `sign_in`: Allow users to directly access the sign-in page.
- `register`: Allow users to directly access the registration page.
- `single_sign_on`: Allow users to directly access the single sign-on (SSO) page.
- `identifier:sign_in`: Allow users to direct access a page that only display specific identifier-based sign-in methods to users.
- `identifier:register`: Allow users to direct access a page that only display specific identifier-based registration methods to users.
- `reset_password`: Allow users to directly access the password reset page.

3. `identifiers`: Additional parameter to specify the identifier type for the first screen. This parameter is only used when the `firstScreen` parameter is set to `identifier:sign_in`, `identifier:register` or `reset_password`. The value can be a list of the following supported identifier types:

- `email`
- `phone`
- `username`

4. `extraParams`: This parameter allow you to pass additional custom parameters to the Logto sign-in page. The value for this parameter should be a Map<String, String> object.

### Bug Fixes

Fix the `logtoClient.getAccessToken` method always fetching new access token bug.

Background:
On each token exchange request, Logto dart SDK will cache the token response in the local storage. To reduce the number of token exchange requests, the SDK should always return the cached access token if it's not expired. Only when the access token is expired, the SDK should fetch a new access token using the refresh token.
However, the current implementation always fetches a new access token even if the cached access token is not expired.

Root cause:
Previously, all the access token storage keys are generated using the combination of the token's `resource`, `organization` and `scopes` values. This is to ensure that multiple access tokens can be stored in the storage without conflict.
Logto does not support narrowing down the scopes during a token exchange request, so the scopes value is always the same as the initial token request, therefore `scopes` is not necessary to be included in the `logtoClient.getAccessToken` method. Without the `scopes` value specified, the SDK can not locate the correct access token in the storage, which leads to always fetching a new access token.

Fix:
Remove the `scope` parameter from the `_tokenStorage.buildAccessTokenKey` and `_tokenStorage.getAccessToken` methods. Always get and set the access token using the `resource` and `organization` values as the key.
3 changes: 3 additions & 0 deletions lib/src/utilities/constants.dart
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ extension InteractionModeExtension on InteractionMode {
enum FirstScreen {
signIn,
register,
resetPassword,
identifierSignIn,
identifierRegister,
singleSignOn,
Expand All @@ -69,6 +70,8 @@ extension FirstScreenExtension on FirstScreen {
return 'sign_in';
case FirstScreen.register:
return 'register';
case FirstScreen.resetPassword:
return 'reset_password';
case FirstScreen.identifierSignIn:
return 'identifier:sign_in';
case FirstScreen.identifierRegister:
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: logto_dart_sdk
description: Logto's Flutter SDK packages.
version: 2.0.2
version: 2.1.0
homepage: https://github.com/logto-io/dart
documentation: https://docs.logto.io/sdk/flutter/

Expand Down

0 comments on commit 31dee5f

Please sign in to comment.