Class BaseAuthClient`Abstract`

Hierarchy (View Summary)

BaseAuthClient
- SupabaseAuthClient

Index

Constructors

Properties

Methods

exchangeCodeForSession passwordReset passwordUpdate refreshSession refreshTokensIfNeeded signInWithGoogle signInWithOTP signInWithPassword signUpWithEmailAndPassword

Constructors

constructor

new BaseAuthClient(): BaseAuthClient
Returns BaseAuthClient

Properties

`Protected`logger

logger: StructuredLogger = ...

Methods

`Abstract`exchangeCodeForSession

exchangeCodeForSession(code: string): Promise<OAuthTokens>
Parameters
- code: string
Returns Promise<OAuthTokens>
- Defined in packages/auth/src/clients/base.auth-client.ts:20

`Abstract`passwordReset

passwordReset(email: string): Promise<void>
Parameters
- email: string
Returns Promise<void>
- Defined in packages/auth/src/clients/base.auth-client.ts:21

`Abstract`passwordUpdate

passwordUpdate(password: string): Promise<void>
Parameters
- password: string
Returns Promise<void>
- Defined in packages/auth/src/clients/base.auth-client.ts:22

`Abstract`refreshSession

refreshSession(refreshToken: RefreshToken): Promise<OAuthTokens>
Parameters
- refreshToken: RefreshToken
Returns Promise<OAuthTokens>
- Defined in packages/auth/src/clients/base.auth-client.ts:23

refreshTokensIfNeeded

refreshTokensIfNeeded(
params: RefreshTokensIfNeededParams,
): Promise<SessionRefreshOutcome>
Rotates the access/refresh token pair when the access token is near expiry. Framework-agnostic — callers persist tokens via cookies or other storage.
Parameters
- params: RefreshTokensIfNeededParams
Returns Promise<SessionRefreshOutcome>
- Defined in packages/auth/src/clients/base.auth-client.ts:29

`Abstract`signInWithGoogle

signInWithGoogle(): Promise<{ url: string }>
Returns Promise<{ url: string }>
- Defined in packages/auth/src/clients/base.auth-client.ts:18

`Abstract`signInWithOTP

signInWithOTP(options: VerifyOtpParams): Promise<OAuthTokens>
Parameters
- options: VerifyOtpParams
Returns Promise<OAuthTokens>
- Defined in packages/auth/src/clients/base.auth-client.ts:19

`Abstract`signInWithPassword

signInWithPassword(email: string, password: string): Promise<OAuthTokens>
Parameters
- email: string
- password: string
Returns Promise<OAuthTokens>
- Defined in packages/auth/src/clients/base.auth-client.ts:17

`Abstract`signUpWithEmailAndPassword

signUpWithEmailAndPassword(email: string, password: string): Promise<void>
Parameters
- email: string
- password: string
Returns Promise<void>
- Defined in packages/auth/src/clients/base.auth-client.ts:16