@reactor/auth — authclient
@reactor/auth / AuthClient
Class: AuthClient
Section titled “Class: AuthClient”Defined in: client.ts:42
Authentication client for Reactor.
Handles user authentication, session management, token refresh, and multi-tab sync.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AuthClient(
ctx,options?):AuthClient
Defined in: client.ts:54
Parameters
Section titled “Parameters”RequestContext
options?
Section titled “options?”AuthClientOptions = {}
Returns
Section titled “Returns”AuthClient
Properties
Section titled “Properties”apiKeys
Section titled “apiKeys”
readonlyapiKeys:ApiKeysClient
Defined in: client.ts:52
API keys client
readonlyorgs:OrgsClient
Defined in: client.ts:48
Organizations client
permissions
Section titled “permissions”
readonlypermissions:PermissionsClient
Defined in: client.ts:50
Permissions client
Methods
Section titled “Methods”confirmPasswordReset()
Section titled “confirmPasswordReset()”confirmPasswordReset(
params):Promise<Result<void>>
Defined in: client.ts:349
Confirm a password reset with the token and new password.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<void>>
deleteUser()
Section titled “deleteUser()”deleteUser():
Promise<Result<void>>
Defined in: client.ts:424
Delete the current user’s account.
Returns
Section titled “Returns”Promise<Result<void>>
getAccessToken()
Section titled “getAccessToken()”getAccessToken():
string|null
Defined in: client.ts:417
Get the access token for making authenticated requests. Used internally by the request context.
Returns
Section titled “Returns”string | null
getSession()
Section titled “getSession()”getSession():
Promise<any>
Defined in: client.ts:250
Get the current session. Refreshes automatically if near expiry.
Returns
Section titled “Returns”Promise<any>
getUser()
Section titled “getUser()”getUser():
Promise<Result<any>>
Defined in: client.ts:259
Get the current user. Fetches from server if not cached.
Returns
Section titled “Returns”Promise<Result<any>>
initialize()
Section titled “initialize()”initialize(
detectUrl?):Promise<void>
Defined in: client.ts:103
Initialize the auth client. Loads session from storage and handles URL tokens.
Parameters
Section titled “Parameters”detectUrl?
Section titled “detectUrl?”boolean = true
Returns
Section titled “Returns”Promise<void>
onAuthStateChange()
Section titled “onAuthStateChange()”onAuthStateChange(
callback):AuthStateSubscription
Defined in: client.ts:409
Subscribe to auth state changes.
Parameters
Section titled “Parameters”callback
Section titled “callback”Returns
Section titled “Returns”AuthStateSubscription
refreshSession()
Section titled “refreshSession()”refreshSession():
Promise<Result<Session>>
Defined in: client.ts:359
Manually refresh the session.
Returns
Section titled “Returns”Promise<Result<Session>>
requestPasswordReset()
Section titled “requestPasswordReset()”requestPasswordReset(
params):Promise<Result<void>>
Defined in: client.ts:340
Request a password reset email.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<void>>
resendVerification()
Section titled “resendVerification()”resendVerification(
params):Promise<Result<void>>
Defined in: client.ts:333
Resend email verification.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<void>>
setSession()
Section titled “setSession()”setSession(
session):Promise<void>
Defined in: client.ts:402
Set the session manually (for SSR scenarios).
Parameters
Section titled “Parameters”session
Section titled “session”Session
Returns
Section titled “Returns”Promise<void>
signIn()
Section titled “signIn()”signIn(
params):Promise<Result<{session:Session;user:User; }>>
Defined in: client.ts:204
Sign in with email and password.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<{ session: Session; user: User; }>>
signOut()
Section titled “signOut()”signOut():
Promise<Result<void>>
Defined in: client.ts:231
Sign out the current user. Revokes the refresh token server-side.
Returns
Section titled “Returns”Promise<Result<void>>
signUp()
Section titled “signUp()”signUp(
params):Promise<Result<{session:Session;user:User; }>>
Defined in: client.ts:177
Sign up a new user.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<{ session: Session; user: User; }>>
updateUser()
Section titled “updateUser()”updateUser(
params):Promise<Result<User>>
Defined in: client.ts:285
Update the current user’s profile.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<User>>
verifyEmail()
Section titled “verifyEmail()”verifyEmail(
params):Promise<Result<{verified:boolean; }>>
Defined in: client.ts:306
Verify an email address with a token.
Parameters
Section titled “Parameters”params
Section titled “params”string
Returns
Section titled “Returns”Promise<Result<{ verified: boolean; }>>