feat: refactor returns types to always return data

Author: kangmingtay

packages/core/auth-js/src/GoTrueClient.ts

@@ -187,10 +187,10 @@ export default class GoTrueClient {
         user = data as User
       }
 
-      return { user, session, error: null }
+      return { data: { user, session }, error: null }
     } catch (error) {
       if (isAuthError(error)) {
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
 
       throw error
@@ -227,7 +227,7 @@ export default class GoTrueClient {
       )
     } catch (error) {
       if (isAuthError(error)) {
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
 
       throw error
@@ -269,20 +269,20 @@ export default class GoTrueClient {
           shouldCreateUser: options?.shouldCreateUser,
           captchaToken: options?.captchaToken,
         })
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
       if ('phone' in credentials) {
         const { phone, options } = credentials
         const { error } = await this.api.sendMobileOTP(phone, {
           shouldCreateUser: options?.shouldCreateUser,
           captchaToken: options?.captchaToken,
         })
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
       throw new AuthInvalidCredentialsError('You must provide either an email or phone number.')
     } catch (error) {
       if (isAuthError(error)) {
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
 
       throw error
@@ -330,10 +330,10 @@ export default class GoTrueClient {
         user = data as User
       }
 
-      return { user, session, error: null }
+      return { data: { user, session }, error: null }
     } catch (error) {
       if (isAuthError(error)) {
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
 
       throw error
@@ -623,17 +623,17 @@ export default class GoTrueClient {
       const { data, error } = await this.api.signInWithEmail(email, password, {
         captchaToken: options.captchaToken,
       })
-      if (error || !data) return { user: null, session: null, error }
+      if (error || !data) return { data: { user: null, session: null }, error }
 
       if (data?.user?.confirmed_at || data?.user?.email_confirmed_at) {
         this._saveSession(data)
         this._notifyAllSubscribers('SIGNED_IN', data)
       }
 
-      return { user: data.user, session: data, error: null }
+      return { data: { user: data.user, session: data }, error: null }
     } catch (error) {
       if (isAuthError(error)) {
-        return { user: null, session: null, error }
+        return { data: { user: null, session: null }, error }
       }
 
       throw error
@@ -651,17 +651,17 @@ export default class GoTrueClient {
       const { session, error } = await this.api.signInWithPhone(phone, password, {
         captchaToken: options.captchaToken,
       })
-      if (error || !session) return { session: null, user: null, error }
+      if (error || !session) return { data: { session: null, user: null }, error }
 
       if (session?.user?.phone_confirmed_at) {
         this._saveSession(session)
         this._notifyAllSubscribers('SIGNED_IN', session)
       }
 
-      return { session, user: session.user, error: null }
+      return { data: { session, user: session.user }, error: null }
     } catch (error) {
       if (isAuthError(error)) {
-        return { session: null, user: null, error }
+        return { data: { session: null, user: null }, error }
       }
 
       throw error
@@ -685,7 +685,7 @@ export default class GoTrueClient {
     if (isBrowser()) {
       window.location.href = url
     }
-    return { provider, url, error: null }
+    return { data: { provider, url }, error: null }
   }
 
   private async _handleOpenIDConnectSignIn({

packages/core/auth-js/src/lib/types.ts

@@ -1,4 +1,4 @@
-import { AuthError } from "./errors"
+import { AuthError } from './errors'
 
 export type Provider =
   | 'apple'
@@ -26,25 +26,37 @@ export type AuthChangeEvent =
   | 'USER_UPDATED'
   | 'USER_DELETED'
 
-export type AuthResponse = {
-  user: User | null
-  session: Session | null
-  error: null
-} | {
-  user: null
-  session: null
-  error: AuthError
-} 
+export type AuthResponse =
+  | {
+      data: {
+        user: User | null
+        session: Session | null
+      }
+      error: null
+    }
+  | {
+      data: {
+        user: null
+        session: null
+      }
+      error: AuthError
+    }
 
-export type OAuthResponse = {
-  provider: Provider
-  url: string
-  error: null
-} | {
-  provider: Provider
-  url: null
-  error: AuthError
-}
+export type OAuthResponse =
+  | {
+      data: {
+        provider: Provider
+        url: string
+      }
+      error: null
+    }
+  | {
+      data: {
+        provider: Provider
+        url: null
+      }
+      error: AuthError
+    }
 export interface Session {
   provider_token?: string | null
   access_token: string
@@ -203,25 +215,29 @@ export interface UserCredentials {
   provider?: Provider
   oidc?: OpenIDConnectCredentials
 }
-export type SignInWithPasswordCredentials = {
-  email: string
-  password: string
-  options?: SignInWithPasswordOptions
-} | {
-  phone: string
-  password: string
-  options?: SignInWithPasswordOptions
-}
+export type SignInWithPasswordCredentials =
+  | {
+      email: string
+      password: string
+      options?: SignInWithPasswordOptions
+    }
+  | {
+      phone: string
+      password: string
+      options?: SignInWithPasswordOptions
+    }
 export interface SignInWithPasswordOptions {
   captchaToken?: string
 }
-export type SignInWithPasswordlessCredentials = {
-  email: string
-  options?: SignInWithPasswordlessOptions
-} | {
-  phone: string
-  options?: SignInWithPasswordlessOptions
-}
+export type SignInWithPasswordlessCredentials =
+  | {
+      email: string
+      options?: SignInWithPasswordlessOptions
+    }
+  | {
+      phone: string
+      options?: SignInWithPasswordlessOptions
+    }
 export interface SignInWithPasswordlessOptions {
   // The redirect url embedded in the email link
   emailRedirectTo?: string