Add oauthTokens to AuthenticationResponse (#1164)

## Description

This update introduces the `oauthTokens` in the authentication response
interface, serializers, and associated tests.
The `oauthTokens` object contains the tokens from OAuth provider.

Contact WorkOS support to enable this feature on your environment.

## Documentation

Does this require changes to the WorkOS Docs? E.g. the [API
Reference](https://workos.com/docs/reference) or code snippets need
updates.

```
[ ] Yes
```

If yes, link a related docs PR and add a docs maintainer as a reviewer.
Their approval is required.

Author: jonatascastro12

src/user-management/interfaces/authentication-response.interface.ts

@@ -1,4 +1,5 @@
 import { Impersonator, ImpersonatorResponse } from './impersonator.interface';
+import { OauthTokens, OauthTokensResponse } from './oauth-tokens.interface';
 import { User, UserResponse } from './user.interface';
 
 type AuthenticationMethod =
@@ -18,6 +19,7 @@ export interface AuthenticationResponse {
   impersonator?: Impersonator;
   authenticationMethod?: AuthenticationMethod;
   sealedSession?: string;
+  oauthTokens?: OauthTokens;
 }
 
 export interface AuthenticationResponseResponse {
@@ -27,4 +29,5 @@ export interface AuthenticationResponseResponse {
   refresh_token: string;
   impersonator?: ImpersonatorResponse;
   authentication_method?: AuthenticationMethod;
+  oauth_tokens?: OauthTokensResponse;
 }

src/user-management/interfaces/index.ts

@@ -1,6 +1,3 @@
-export * from './authentication-event.interface';
-export * from './authenticate-with-magic-auth-options.interface';
-export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-code-options.interface';
 export * from './authenticate-with-email-verification-options.interface';
 export * from './authenticate-with-magic-auth-options.interface';
@@ -10,6 +7,7 @@ export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-refresh-token-options.interface';
 export * from './authenticate-with-session-cookie.interface';
 export * from './authenticate-with-totp-options.interface';
+export * from './authentication-event.interface';
 export * from './authentication-response.interface';
 export * from './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
@@ -25,6 +23,7 @@ export * from './list-invitations-options.interface';
 export * from './list-organization-memberships-options.interface';
 export * from './list-users-options.interface';
 export * from './magic-auth.interface';
+export * from './oauth-tokens.interface';
 export * from './organization-membership.interface';
 export * from './password-reset.interface';
 export * from './refresh-and-seal-session-data.interface';

src/user-management/interfaces/oauth-tokens.interface.ts

@@ -0,0 +1,13 @@
+export interface OauthTokens {
+  accessToken: string;
+  refreshToken: string;
+  expiresAt: number;
+  scopes: string[];
+}
+
+export interface OauthTokensResponse {
+  access_token: string;
+  refresh_token: string;
+  expires_at: number;
+  scopes: string[];
+}

src/user-management/serializers/authentication-response.serializer.ts

@@ -2,6 +2,7 @@ import {
   AuthenticationResponse,
   AuthenticationResponseResponse,
 } from '../interfaces';
+import { deserializeOauthTokens } from './oauth-tokens.serializer';
 import { deserializeUser } from './user.serializer';
 
 export const deserializeAuthenticationResponse = (
@@ -14,6 +15,7 @@ export const deserializeAuthenticationResponse = (
     refresh_token,
     authentication_method,
     impersonator,
+    oauth_tokens,
     ...rest
   } = authenticationResponse;
 
@@ -24,6 +26,7 @@ export const deserializeAuthenticationResponse = (
     refreshToken: refresh_token,
     impersonator,
     authenticationMethod: authentication_method,
+    oauthTokens: deserializeOauthTokens(oauth_tokens),
     ...rest,
   };
 };

src/user-management/serializers/oauth-tokens.serializer.ts

@@ -0,0 +1,13 @@
+import { OauthTokensResponse, OauthTokens } from '../interfaces';
+
+export const deserializeOauthTokens = (
+  oauthTokens?: OauthTokensResponse,
+): OauthTokens | undefined =>
+  oauthTokens
+    ? {
+        accessToken: oauthTokens.access_token,
+        refreshToken: oauthTokens.refresh_token,
+        expiresAt: oauthTokens.expires_at,
+        scopes: oauthTokens.scopes,
+      }
+    : undefined;

src/user-management/user-management.spec.ts

@@ -395,6 +395,37 @@ describe('UserManagement', () => {
         });
       });
     });
+
+    describe('when oauth_tokens is present', () => {
+      it('deserializes oauth_tokens', async () => {
+        fetchOnce({
+          user: userFixture,
+          oauth_tokens: {
+            access_token: 'access_token',
+            refresh_token: 'refresh',
+            expires_at: 123,
+            scopes: ['read:users'],
+          },
+        });
+
+        const resp = await workos.userManagement.authenticateWithCode({
+          clientId: 'proj_whatever',
+          code: 'or this',
+        });
+
+        expect(resp).toMatchObject({
+          user: {
+            email: '[email protected]',
+          },
+          oauthTokens: {
+            accessToken: 'access_token',
+            refreshToken: 'refresh',
+            expiresAt: 123,
+            scopes: ['read:users'],
+          },
+        });
+      });
+    });
   });
 
   describe('authenticateWithRefreshToken', () => {