Class AuthModule

Constructors

constructor

new AuthModule(
config: AuthModuleConfig,
_apiClient?: ApiClient | null,
): AuthModule
Parameters
- config: AuthModuleConfig
- _apiClient: ApiClient | null = null
Returns AuthModule
- Defined in src/modules/auth/AuthModule.ts:160

Accessors

hasPasswordRecoveryToken

get hasPasswordRecoveryToken(): boolean
True while a recovery token captured from an email link is available. The SDK removes sensitive auth params from the URL after storing them.

Returns boolean
- Defined in src/modules/auth/AuthModule.ts:387

isPasswordRecoveryCallback

get isPasswordRecoveryCallback(): boolean
Checks if the last callback was a password recovery/invite flow. Does NOT consume the value — use consumeCallbackType() to consume.

Returns boolean
- Defined in src/modules/auth/AuthModule.ts:418

lastError

get lastError(): { code: string; message: string } | null
Returns the last auth error from a callback (expired link, invalid token, etc.) Null if no error. Cleared on next successful auth action.

Returns { code: string; message: string } | null
- Defined in src/modules/auth/AuthModule.ts:379

token

get token(): string | null
Current access token (JWT), or null if not authenticated.

Returns string | null
- Defined in src/modules/auth/AuthModule.ts:371

user

get user(): User | null
Current authenticated user, or null if no session exists.

Returns User | null
- Defined in src/modules/auth/AuthModule.ts:366

Methods

consumeCallbackType

consumeCallbackType(): string | null
Returns and consumes the pending callback type from the last auth redirect. Use this on callback pages to determine the redirect destination. Returns 'recovery' | 'invite' | 'signup' | 'magiclink' | null.

Example:
```
const type = dypai.auth.consumeCallbackType();
if (type === 'recovery' || type === 'invite') navigate('/set-password');
else navigate('/dashboard');
```
Returns string | null
- Defined in src/modules/auth/AuthModule.ts:403

createOrganization

createOrganization(name: string, slug?: string): Promise<DypaiResponse<any>>
Crea una organización.
Parameters
- name: string
- Optionalslug: string
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/auth/AuthModule.ts:1191

disableTwoFactor

disableTwoFactor(): Promise<DypaiResponse<{ message: string }>>
Desactiva 2FA para el usuario actual.

Returns Promise<DypaiResponse<{ message: string }>>
- Defined in src/modules/auth/AuthModule.ts:1169

enableTwoFactor

enableTwoFactor(): Promise<
DypaiResponse<{ backupCodes: string[]; totpURI: string }>,
>
Habilita 2FA para el usuario actual. Devuelve el TOTP URI para escanear con una app.

Returns Promise<DypaiResponse<{ backupCodes: string[]; totpURI: string }>>
- Defined in src/modules/auth/AuthModule.ts:1120

getSession

getSession(): Promise<DypaiResponse<Session | null>>
Obtiene la sesión actual. Espera a que la inicialización termine antes de responder (evita race conditions).

Returns Promise<DypaiResponse<Session | null>>
- Defined in src/modules/auth/AuthModule.ts:585

getUser

getUser(): Promise<DypaiResponse<User>>
Obtiene los datos del usuario actual desde el servidor

Returns Promise<DypaiResponse<User>>
- Defined in src/modules/auth/AuthModule.ts:620

handleSessionExpired

handleSessionExpired(): void
Clears the local session after an unrecoverable 401. Called internally by the API layer.

Returns void
- Defined in src/modules/auth/AuthModule.ts:1701

inviteMember

inviteMember(
    organizationId: string,
    email: string,
    role?: string,
): Promise<DypaiResponse<any>>
Invita a un miembro a una organización por email.
Parameters
- organizationId: string
- email: string
- Optionalrole: string
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/auth/AuthModule.ts:1213

isLoggedIn

isLoggedIn(): boolean
Comprueba si hay una sesión activa de forma síncrona. Nota: al inicio de la app, puede retornar false hasta que _recoverSession() termine. Para una comprobación fiable al arranque, usa getSession() (que espera la inicialización).

Returns boolean
- Defined in src/modules/auth/AuthModule.ts:432

listOrganizations

listOrganizations(): Promise<DypaiResponse<any[]>>
Lista las organizaciones del usuario actual.

Returns Promise<DypaiResponse<any[]>>
- Defined in src/modules/auth/AuthModule.ts:1235

login(credentials: LoginCredentials): Promise<DypaiResponse<AuthResponse>>
Alias para signInWithPassword
Parameters
- credentials: LoginCredentials
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:521

logout

logout(): Promise<DypaiResponse<void>>
Alias para signOut

Returns Promise<DypaiResponse<void>>
- Defined in src/modules/auth/AuthModule.ts:702

me

me(): Promise<DypaiResponse<User>>
Alias para getUser

Returns Promise<DypaiResponse<User>>
- Defined in src/modules/auth/AuthModule.ts:654

onAuthStateChange

onAuthStateChange(
listener: AuthListener,
): { data: { subscription: { unsubscribe: () => void } } }
Subscribes to authentication state changes. The listener receives an INITIAL_SESSION event immediately after registration, followed by SIGNED_IN, SIGNED_OUT, TOKEN_REFRESHED, PASSWORD_RECOVERY, etc.
Parameters
- listener: AuthListener
  Callback invoked with (event, session) on every auth state change.
Returns { data: { subscription: { unsubscribe: () => void } } }
An object with data.subscription.unsubscribe() to remove the listener.
Example
```
const { data: { subscription } } = dypai.auth.onAuthStateChange((event, session) => {
  if (event === 'SIGNED_IN') console.log('Welcome!', session.user.email);
  if (event === 'SIGNED_OUT') router.push('/login');
});

// Later: stop listening
subscription.unsubscribe();
```
- Defined in src/modules/auth/AuthModule.ts:455

recoverPassword

recoverPassword(
data: PasswordRecoveryRequest,
): Promise<DypaiResponse<PasswordRecoveryResponse>>
Alias para resetPasswordForEmail
Parameters
- data: PasswordRecoveryRequest
Returns Promise<DypaiResponse<PasswordRecoveryResponse>>
- Defined in src/modules/auth/AuthModule.ts:734

refreshSession

refreshSession(): Promise<DypaiResponse<AuthResponse>>
Refresca la sesión actual utilizando el refresh token. Usa Web Locks API para coordinar entre pestañas y Deferred para deduplicar dentro de la misma pestaña.

Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:770

register

register(data: RegisterData): Promise<DypaiResponse<AuthResponse>>
Alias para signUp
Parameters
- data: RegisterData
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:579

resendConfirmationEmail

resendConfirmationEmail(
email: string,
options?: { redirectTo?: string },
): Promise<DypaiResponse<{ message: string }>>
Reenvía el email de confirmación de registro. Útil cuando el usuario no recibió el email original o este expiró. Reenvía el email de verificación.
Parameters
- email: string
- Optionaloptions: { redirectTo?: string }
Returns Promise<DypaiResponse<{ message: string }>>
- Defined in src/modules/auth/AuthModule.ts:741

resetPasswordForEmail

resetPasswordForEmail(
email: string,
options?: { redirectTo?: string },
): Promise<DypaiResponse<PasswordRecoveryResponse>>
Solicita recuperación de contraseña
Parameters
- email: string
- Optionaloptions: { redirectTo?: string }
Returns Promise<DypaiResponse<PasswordRecoveryResponse>>
- Defined in src/modules/auth/AuthModule.ts:707

setPassword

setPassword(password: string): Promise<DypaiResponse<{ status: boolean }>>
Establece o actualiza la contraseña del usuario autenticado actual. Útil para flujos de invitación o recuperación donde el usuario llega con token válido.
Parameters
- password: string
Returns Promise<DypaiResponse<{ status: boolean }>>
- Defined in src/modules/auth/AuthModule.ts:1035

signInWithMagicLink

signInWithMagicLink(
email: string,
options?: { redirectTo?: string },
): Promise<DypaiResponse<{ message: string }>>
Envía un magic link al email del usuario para login sin contraseña.
Parameters
- email: string
- Optionaloptions: { redirectTo?: string }
Returns Promise<DypaiResponse<{ message: string }>>
- Defined in src/modules/auth/AuthModule.ts:1098

signInWithOAuth

signInWithOAuth(
provider: "google" | "github",
options?: OAuthOptions,
): Promise<DypaiResponse<void>>
Inicia sesión con OAuth
Parameters
- provider: "google" | "github"
- options: OAuthOptions = {}
Returns Promise<DypaiResponse<void>>
- Defined in src/modules/auth/AuthModule.ts:659

signInWithOtp

signInWithOtp(
credentials: OTPRequest,
): Promise<DypaiResponse<{ status: boolean }>>
Envía un código OTP (One Time Password) al email o teléfono indicado. Utilizado para login sin contraseña (Magic Link o SMS OTP).
Parameters
- credentials: OTPRequest
Returns Promise<DypaiResponse<{ status: boolean }>>
- Defined in src/modules/auth/AuthModule.ts:951

signInWithPassword

signInWithPassword(
credentials: LoginCredentials,
): Promise<DypaiResponse<AuthResponse>>
Login con email y contraseña
Parameters
- credentials: LoginCredentials
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:491

signOut

signOut(): Promise<DypaiResponse<void>>
Cierra la sesión

Returns Promise<DypaiResponse<void>>
- Defined in src/modules/auth/AuthModule.ts:681

signUp(
data: RegisterData,
options?: { redirectTo?: string },
): Promise<DypaiResponse<AuthResponse>>
Registro de nuevo usuario
Parameters
- data: RegisterData
- Optionaloptions: { redirectTo?: string }
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:526

startAutoRefresh

startAutoRefresh(): void
Inicia el auto-refresh basado en ticks. Cada 30s verifica si el token está próximo a expirar y lo refresca. Más robusto que setTimeout porque Chrome throttlea setTimeout en background tabs.

Returns void
- Defined in src/modules/auth/AuthModule.ts:1258

stopAutoRefresh

stopAutoRefresh(): void
Detiene el auto-refresh.

Returns void
- Defined in src/modules/auth/AuthModule.ts:1269

updateUser

updateUser(attributes: UpdateUserAttributes): Promise<DypaiResponse<User>>
Actualiza los datos del usuario actual (email, contraseña o metadatos). Requiere que el usuario esté autenticado.
Parameters
- attributes: UpdateUserAttributes
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/auth/AuthModule.ts:1000

verifyOtp

verifyOtp(_params: VerifyOTPRequest): Promise<DypaiResponse<AuthResponse>>
Verifica un código OTP enviado por email o teléfono. Si es válido, inicia la sesión del usuario.
Parameters
- _params: VerifyOTPRequest
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:970

verifyTwoFactor

verifyTwoFactor(code: string): Promise<DypaiResponse<AuthResponse>>
Verifica un código TOTP de 2FA durante el login.
Parameters
- code: string
Returns Promise<DypaiResponse<AuthResponse>>
- Defined in src/modules/auth/AuthModule.ts:1141

Class AuthModule

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AuthModule

Accessors

hasPasswordRecoveryToken

Returns boolean

isPasswordRecoveryCallback

Returns boolean

lastError

Returns { code: string; message: string } | null

token

Returns string | null

user

Returns User | null

Methods

consumeCallbackType

Returns string | null

createOrganization

Parameters

Returns Promise<DypaiResponse<any>>

disableTwoFactor

Returns Promise<DypaiResponse<{ message: string }>>

enableTwoFactor

Returns Promise<DypaiResponse<{ backupCodes: string[]; totpURI: string }>>

getSession

Returns Promise<DypaiResponse<Session | null>>

getUser

Returns Promise<DypaiResponse<User>>

handleSessionExpired

Returns void

inviteMember

Parameters

Returns Promise<DypaiResponse<any>>

isLoggedIn

Returns boolean

listOrganizations

Returns Promise<DypaiResponse<any[]>>

login

Parameters

Returns Promise<DypaiResponse<AuthResponse>>

logout

Returns Promise<DypaiResponse<void>>

me

Returns Promise<DypaiResponse<User>>

onAuthStateChange

Parameters

Returns { data: { subscription: { unsubscribe: () => void } } }

Example

recoverPassword

Parameters

Returns Promise<DypaiResponse<PasswordRecoveryResponse>>

refreshSession

Returns Promise<DypaiResponse<AuthResponse>>

register

Parameters

Returns Promise<DypaiResponse<AuthResponse>>

resendConfirmationEmail

Parameters

Returns Promise<DypaiResponse<{ message: string }>>

resetPasswordForEmail

Parameters

Returns Promise<DypaiResponse<PasswordRecoveryResponse>>

setPassword

Parameters

Returns Promise<DypaiResponse<{ status: boolean }>>

signInWithMagicLink

Parameters

Returns Promise<DypaiResponse<{ message: string }>>

signInWithOAuth

Parameters

Returns Promise<DypaiResponse<void>>

signInWithOtp

Parameters

Returns Promise<DypaiResponse<{ status: boolean }>>