feat(connector): add email support for x connector (#7827)

fixed #7809

Author: wangsijie

.changeset/wicked-mails-peel.md

@@ -0,0 +1,7 @@
+---
+"@logto/connector-x": minor
+---
+
+add email syncing to x connector
+
+You can now add the `users.email` scope to sync users' email addresses from X accounts.

packages/connectors/connector-x/README.md

@@ -51,7 +51,7 @@ In your Logto connector configuration, fill out the following fields with the va
 - **clientId:** Your App's Client ID.
 - **clientSecret:** Your App's Client Secret.
 
-`scope` is a space-delimited list of [scopes](https://docs.x.com/x-api/users/user-lookup-me). If not provided, the default scope is `tweet.read users.read`.
+`scope` accepts a space-delimited list of [scopes](https://docs.x.com/fundamentals/authentication/oauth-2-0/authorization-code#scopes). If you omit it, the default `tweet.read users.read` is used, and those two scopes are always required. Add any others your app needs, for example, include `users.email` to sync the user’s email: `tweet.read users.read users.email`.
 
 ### Config types
 

packages/connectors/connector-x/src/index.test.ts

@@ -119,6 +119,7 @@ describe('getUserInfo', () => {
     expect(socialUserInfo).toStrictEqual({
       id: '1',
       name: 'monalisa',
+      email: undefined,
       rawData: {
         data: {
           id: '1',

packages/connectors/connector-x/src/index.ts

@@ -113,8 +113,10 @@ const getUserInfo =
         redirectUri
       );
 
+      const hasEmailScope = (config.scope ?? defaultScope).split(' ').includes('users.email');
+
       const userInfo = await ky
-        .get(userInfoEndpoint, {
+        .get(`${userInfoEndpoint}${hasEmailScope ? '?user.fields=confirmed_email' : ''}`, {
           headers: {
             Authorization: `${token_type} ${access_token}`,
           },
@@ -128,12 +130,13 @@ const getUserInfo =
       }
 
       const {
-        data: { id, name },
+        data: { id, name, confirmed_email: email },
       } = userInfoResult.data;
 
       return {
         id,
         name: conditional(name),
+        email: conditional(email),
         rawData: jsonGuard.parse(userInfo),
       };
     } catch (error: unknown) {

packages/connectors/connector-x/src/types.ts

@@ -12,6 +12,7 @@ export const userInfoResponseGuard = z.object({
   data: z.object({
     id: z.string(),
     name: z.string().optional().nullable(),
+    confirmed_email: z.string().optional().nullable(),
   }),
 });