feat(dart): update the userInfo api response type (#36)

Author: simeng-li

example/lib/main.dart

@@ -43,7 +43,9 @@ class _MyHomePageState extends State<MyHomePage> {
 
   final redirectUri = 'io.logto://callback';
   final config = const LogtoConfig(
-      appId: 'xgSxW0MDpVqW2GDvCnlNb', endpoint: 'https://logto.dev');
+      appId: '<your-app-id>',
+      endpoint: 'http://localhost:3001',
+      scopes: ['email', 'phone']);
 
   late LogtoClient logtoClient;
 
@@ -105,6 +107,21 @@ class _MyHomePageState extends State<MyHomePage> {
       child: const Text('Sign Out'),
     );
 
+    Widget getUserInfoButton = TextButton(
+      style: TextButton.styleFrom(
+        foregroundColor: Colors.black,
+        padding: const EdgeInsets.all(16.0),
+        textStyle: const TextStyle(fontSize: 20),
+      ),
+      onPressed: () async {
+        var userInfo = await logtoClient.getUserInfo();
+        setState(() {
+          content = userInfo.toJson().toString();
+        });
+      },
+      child: const Text('Get User Info'),
+    );
+
     return Scaffold(
       appBar: AppBar(
         title: Text(widget.title),
@@ -126,6 +143,11 @@ class _MyHomePageState extends State<MyHomePage> {
                 ? isAuthenticated == true
                     ? signOutButton
                     : signInButton
+                : const SizedBox.shrink(),
+            isAuthenticated != null
+                ? isAuthenticated == true
+                    ? getUserInfoButton
+                    : const SizedBox.shrink()
                 : const SizedBox.shrink()
           ],
         ),

lib/logto_client.dart

@@ -1,6 +1,7 @@
 import 'package:flutter_web_auth/flutter_web_auth.dart';
 import 'package:http/http.dart' as http;
 import 'package:jose/jose.dart';
+import 'package:logto_dart_sdk/src/interfaces/logto_user_info_response.dart';
 
 import '/src/exceptions/logto_auth_exceptions.dart';
 import '/src/interfaces/logto_interfaces.dart';
@@ -68,20 +69,23 @@ class LogtoClient {
     return _oidcConfig!;
   }
 
-  Future<AccessToken?> getAccessToken({String? resource}) async {
+  Future<AccessToken?> getAccessToken(
+      {String? resource, List<String>? scopes}) async {
     final accessToken = await _tokenStorage.getAccessToken(resource);
 
     if (accessToken != null) {
       return accessToken;
     }
 
-    final token = await _getAccessTokenByRefreshToken(resource);
+    final token =
+        await _getAccessTokenByRefreshToken(resource: resource, scopes: scopes);
 
     return token;
   }
 
   // RBAC are not supported currently, no resource specific scopes are needed
-  Future<AccessToken?> _getAccessTokenByRefreshToken(String? resource) async {
+  Future<AccessToken?> _getAccessTokenByRefreshToken(
+      {String? resource, List<String>? scopes}) async {
     final refreshToken = await _tokenStorage.refreshToken;
 
     if (refreshToken == null) {
@@ -99,12 +103,15 @@ class LogtoClient {
           tokenEndPoint: oidcConfig.tokenEndpoint,
           clientId: config.appId,
           refreshToken: refreshToken,
-          resource: resource);
+          resource: resource,
+          scopes: scopes);
 
-      final scopes = response.scope.split(' ');
+      final responseScopes = response.scope.split(' ');
 
       await _tokenStorage.setAccessToken(response.accessToken,
-          expiresIn: response.expiresIn, resource: resource, scopes: scopes);
+          expiresIn: response.expiresIn,
+          resource: resource,
+          scopes: responseScopes);
 
       // renew refresh token
       await _tokenStorage.setRefreshToken(response.refreshToken);
@@ -116,7 +123,7 @@ class LogtoClient {
         await _tokenStorage.setIdToken(idToken);
       }
 
-      return await _tokenStorage.getAccessToken(resource, scopes);
+      return await _tokenStorage.getAccessToken(resource, responseScopes);
     } finally {
       if (_httpClient == null) httpClient.close();
     }
@@ -248,4 +255,29 @@ class LogtoClient {
       }
     }
   }
+
+  Future<LogtoUserInfoResponse> getUserInfo() async {
+    final httpClient = _httpClient ?? http.Client();
+
+    try {
+      final oidcConfig = await _getOidcConfig(httpClient);
+
+      final accessToken = await _tokenStorage.getAccessToken();
+
+      if (accessToken == null) {
+        throw LogtoAuthException(
+            LogtoAuthExceptions.authenticationError, 'not authenticated');
+      }
+
+      final userInfoResponse = await logto_core.fetchUserInfo(
+        httpClient: httpClient,
+        userInfoEndpoint: oidcConfig.userInfoEndpoint,
+        accessToken: accessToken.token,
+      );
+
+      return userInfoResponse;
+    } finally {
+      if (_httpClient == null) httpClient.close();
+    }
+  }
 }

lib/src/interfaces/logto_user_info_response.dart

@@ -2,25 +2,41 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'logto_user_info_response.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(includeIfNull: false)
 class LogtoUserInfoResponse {
   @JsonKey(name: 'sub', required: true, disallowNullValue: true)
   final String sub;
   @JsonKey(name: 'username')
   final String? username;
   @JsonKey(name: 'name')
   final String? name;
-  @JsonKey(name: 'avatar')
-  final String? avatar;
-  @JsonKey(name: 'role_names')
-  final List<String>? roleNames;
+  @JsonKey(name: 'picture')
+  final String? picture;
+  @JsonKey(name: 'email')
+  final String? email;
+  @JsonKey(name: 'email_verified')
+  final bool? emailVerified;
+  @JsonKey(name: 'phone_number')
+  final String? phoneNumber;
+  @JsonKey(name: 'phone_number_verified')
+  final bool? phoneNumberVerified;
+  @JsonKey(name: 'custom_data')
+  final Map<String, dynamic>? customData;
+  @JsonKey(name: 'identities')
+  final Map<String, dynamic>? identities;
 
-  LogtoUserInfoResponse(
-      {required this.sub,
-      this.username,
-      this.name,
-      this.avatar,
-      this.roleNames});
+  LogtoUserInfoResponse({
+    required this.sub,
+    this.username,
+    this.name,
+    this.picture,
+    this.email,
+    this.emailVerified,
+    this.phoneNumber,
+    this.phoneNumberVerified,
+    this.customData,
+    this.identities,
+  });
 
   factory LogtoUserInfoResponse.fromJson(Map<String, dynamic> json) =>
       _$LogtoUserInfoResponseFromJson(json);

lib/src/interfaces/logto_user_info_response.g.dart

@@ -137,7 +137,7 @@ void main() {
     expect(result.refreshToken, mockRefreshTokenResponse['refresh_token']);
   });
 
-  test('Fetch UserInfo', () async {
+  test('Fetch UserInfo should return all valid fields', () async {
     const String endpoint = '/oidc/me';
     const String accessToken = 'access_token';
 
@@ -154,5 +154,15 @@ void main() {
 
     expect(interceptor.isDone, true);
     expect(result.sub, mockUserInfoResponse['sub']);
+    expect(result.name, mockUserInfoResponse['name']);
+    expect(result.username, mockUserInfoResponse['username']);
+    expect(result.picture, mockUserInfoResponse['picture']);
+    expect(result.customData, mockUserInfoResponse['custom_data']);
+    expect(result.email, mockUserInfoResponse['email']);
+    expect(result.emailVerified, mockUserInfoResponse['email_verified']);
+    expect(result.phoneNumber, mockUserInfoResponse['phone_number']);
+    expect(result.phoneNumberVerified,
+        mockUserInfoResponse['phone_number_verified']);
+    expect(result.identities, mockUserInfoResponse['identities']);
   });
 }

test/logto_core_test.dart

@@ -30,6 +30,14 @@ const Map<String, dynamic> mockUserInfoResponse = {
   "sub": "foo",
   "username": "username",
   "name": "name",
-  "avatar": "http://avatar.png",
-  "role_names": ['admin']
+  "picture": "http://avatar.png",
+  "email": "foo@logto.io",
+  "email_verified": true,
+  "phone_number": "123456789",
+  "phone_number_verified": true,
+  "custom_data": {},
+  "identities": {
+    "google": {"id": "google_id", "email": "foo@google.com"},
+  },
+  "user_roles": ["user"]
 };