Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484// deno-lint-ignore-file no-explicit-anyimport { get, post, put, remove } from './lib/fetch.ts'import { Session, Provider, UserAttributes, CookieOptions, User } from './lib/types.ts'import { COOKIE_OPTIONS } from './lib/constants.ts'import { setCookie, deleteCookie } from './lib/cookies.ts'import { expiresAt } from './lib/helpers.ts'
export interface ApiError { message: string status: number}
export default class GoTrueApi { protected url: string protected headers: { [key: string]: string } protected cookieOptions: CookieOptions
constructor({ url = '', headers = {}, cookieOptions, }: { url: string headers?: { [key: string]: string } cookieOptions?: CookieOptions }) { this.url = url this.headers = headers this.cookieOptions = { ...COOKIE_OPTIONS, ...cookieOptions } }
/** * Creates a new user using their email address. * @param email The email address of the user. * @param password The password of the user. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. * @param data Optional user metadata. * * @returns A logged-in session if the server has "autoconfirm" ON * @returns A user if the server has "autoconfirm" OFF */ async signUpWithEmail( email: string, password: string, options: { redirectTo?: string data?: Record<string, unknown> } = {} ): Promise<{ data: Session | User | null; error: ApiError | null }> { try { const headers = { ...this.headers } let queryString = '' if (options.redirectTo) { queryString = '?redirect_to=' + encodeURIComponent(options.redirectTo) } const data = await post( `${this.url}/signup${queryString}`, { email, password, data: options.data }, { headers } ) const session = { ...data } if (session.expires_in) session.expires_at = expiresAt(data.expires_in) return { data: session, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Logs in an existing user using their email address. * @param email The email address of the user. * @param password The password of the user. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. */ async signInWithEmail( email: string, password: string, options: { redirectTo?: string } = {} ): Promise<{ data: Session | null; error: ApiError | null }> { try { const headers = { ...this.headers } let queryString = '?grant_type=password' if (options.redirectTo) { queryString += '&redirect_to=' + encodeURIComponent(options.redirectTo) } const data = await post(`${this.url}/token${queryString}`, { email, password }, { headers }) const session = { ...data } if (session.expires_in) session.expires_at = expiresAt(data.expires_in) return { data: session, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Signs up a new user using their phone number and a password. * @param phone The phone number of the user. * @param password The password of the user. * @param data Optional user metadata. */ async signUpWithPhone( phone: string, password: string, options: { data?: Record<string, unknown> } = {} ): Promise<{ data: Session | User | null; error: ApiError | null }> { try { const headers = { ...this.headers } const data = await post( `${this.url}/signup`, { phone, password, data: options.data }, { headers } ) const session = { ...data } if (session.expires_in) session.expires_at = expiresAt(data.expires_in) return { data: session, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Logs in an existing user using their phone number and password. * @param phone The phone number of the user. * @param password The password of the user. */ async signInWithPhone( phone: string, password: string ): Promise<{ data: Session | null; error: ApiError | null }> { try { const headers = { ...this.headers } const queryString = '?grant_type=password' const data = await post(`${this.url}/token${queryString}`, { phone, password }, { headers }) const session = { ...data } if (session.expires_in) session.expires_at = expiresAt(data.expires_in) return { data: session, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Sends a magic login link to an email address. * @param email The email address of the user. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. */ async sendMagicLinkEmail( email: string, options: { redirectTo?: string } = {} ): Promise<{ data: Record<string, unknown> | null; error: ApiError | null }> { try { const headers = { ...this.headers } let queryString = '' if (options.redirectTo) { queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo) } const data = await post(`${this.url}/magiclink${queryString}`, { email }, { headers }) return { data, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Sends a mobile OTP via SMS. Will register the account if it doesn't already exist * @param phone The user's phone number WITH international prefix */ // deno-lint-ignore ban-types async sendMobileOTP(phone: string): Promise<{ data: {} | null; error: ApiError | null }> { try { const headers = { ...this.headers } const data = await post(`${this.url}/otp`, { phone }, { headers }) return { data, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Send User supplied Mobile OTP to be verified * @param phone The user's phone number WITH international prefix * @param token token that user was sent to their mobile phone * @param redirectTo A URL or mobile address to send the user to after they are confirmed. */ async verifyMobileOTP( phone: string, token: string, options: { redirectTo?: string } = {} ): Promise<{ data: Session | User | null; error: ApiError | null }> { try { const headers = { ...this.headers } const data = await post( `${this.url}/verify`, { phone, token, type: 'sms', redirect_to: options.redirectTo }, { headers } ) return { data, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Sends an invite link to an email address. * @param email The email address of the user. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. * @param data Optional user metadata */ async inviteUserByEmail( email: string, options: { redirectTo?: string data?: Record<string, unknown> } = {} ): Promise<{ data: User | null; error: ApiError | null }> { try { const headers = { ...this.headers } let queryString = '' if (options.redirectTo) { queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo) } const data = await post( `${this.url}/invite${queryString}`, { email, data: options.data }, { headers } ) return { data, error: null } } catch (error) { return { data: null, error: error as ApiError } } }
/** * Sends a reset request to an email address. * @param email The email address of the user. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. */ async resetPasswordForEmail( email: string, options: { redirectTo?: string } = {} ): Promise<{ data: Record<string, unknown> | null; error: ApiError | null }> { try { const headers = { ...this.headers } let queryString = '' if (options.redirectTo) { queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo) } const data = await post(`${this.url}/recover${queryString}`, { email }, { headers }) return { data, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Create a temporary object with all configured headers and * adds the Authorization token to be used on request methods * @param jwt A valid, logged-in JWT. */ private _createRequestHeaders(jwt: string) { const headers = { ...this.headers } headers['Authorization'] = `Bearer ${jwt}` return headers }
/** * Removes a logged-in session. * @param jwt A valid, logged-in JWT. */ async signOut(jwt: string): Promise<{ error: ApiError | null }> { try { await post( `${this.url}/logout`, {}, { headers: this._createRequestHeaders(jwt), noResolveJson: true } ) return { error: null } } catch (e) { return { error: e as ApiError } } }
/** * Generates the relevant login URL for a third-party provider. * @param provider One of the providers supported by GoTrue. * @param redirectTo A URL or mobile address to send the user to after they are confirmed. * @param scopes A space-separated list of scopes granted to the OAuth application. */ getUrlForProvider( provider: Provider, options: { redirectTo?: string scopes?: string } ) { const urlParams: string[] = [`provider=${encodeURIComponent(provider)}`] if (options?.redirectTo) { urlParams.push(`redirect_to=${encodeURIComponent(options.redirectTo)}`) } if (options?.scopes) { urlParams.push(`scopes=${encodeURIComponent(options.scopes)}`) } return `${this.url}/authorize?${urlParams.join('&')}` }
/** * Gets the user details. * @param jwt A valid, logged-in JWT. */ async getUser( jwt: string ): Promise<{ user: User | null; data: User | null; error: ApiError | null }> { try { const data: any = await get(`${this.url}/user`, { headers: this._createRequestHeaders(jwt) }) return { user: data, data, error: null } } catch (e) { return { user: null, data: null, error: e as ApiError } } }
/** * Updates the user data. * @param jwt A valid, logged-in JWT. * @param attributes The data you want to update. */ async updateUser( jwt: string, attributes: UserAttributes ): Promise<{ user: User | null; data: User | null; error: ApiError | null }> { try { const data: any = await put(`${this.url}/user`, attributes, { headers: this._createRequestHeaders(jwt), }) return { user: data, data, error: null } } catch (e) { return { user: null, data: null, error: e as ApiError } } }
/** * Delete a user. Requires a `service_role` key. * * This function should only be called on a server. Never expose your `service_role` key in the browser. * * @param uid The user uid you want to remove. * @param jwt A valid JWT. Must be a full-access API key (e.g. service_role key). */ async deleteUser( uid: string, jwt: string ): Promise<{ user: User | null; data: User | null; error: ApiError | null }> { try { const data: any = await remove( `${this.url}/admin/users/${uid}`, {}, { headers: this._createRequestHeaders(jwt), } ) return { user: data, data, error: null } } catch (e) { return { user: null, data: null, error: e as ApiError } } }
/** * Generates a new JWT. * @param refreshToken A valid refresh token that was returned on login. */ async refreshAccessToken( refreshToken: string ): Promise<{ data: Session | null; error: ApiError | null }> { try { const data: any = await post( `${this.url}/token?grant_type=refresh_token`, { refresh_token: refreshToken }, { headers: this.headers } ) const session = { ...data } if (session.expires_in) session.expires_at = expiresAt(data.expires_in) return { data: session, error: null } } catch (e) { return { data: null, error: e as ApiError } } }
/** * Set/delete the auth cookie based on the AuthChangeEvent. * Works for Next.js & Express (requires cookie-parser middleware). */ setAuthCookie(req: any, res: any) { if (req.method !== 'POST') { res.setHeader('Allow', 'POST') res.status(405).end('Method Not Allowed') } const { event, session } = req.body if (!event) throw new Error('Auth event missing!') if (event === 'SIGNED_IN') { if (!session) throw new Error('Auth session missing!') setCookie(req, res, { name: this.cookieOptions.name!, value: session.access_token, domain: this.cookieOptions.domain, maxAge: this.cookieOptions.lifetime!, path: this.cookieOptions.path, sameSite: this.cookieOptions.sameSite, }) } if (event === 'SIGNED_OUT') deleteCookie(req, res, this.cookieOptions.name!) res.status(200).json({}) }
/** * Get user by reading the cookie from the request. * Works for Next.js & Express (requires cookie-parser middleware). */ async getUserByCookie( req: any ): Promise<{ user: User | null; data: User | null; error: Error | null }> { try { if (!req.cookies) throw new Error( 'Not able to parse cookies! When using Express make sure the cookie-parser middleware is in use!' ) if (!req.cookies[this.cookieOptions.name!]) throw new Error('No cookie found!') const token = req.cookies[this.cookieOptions.name!] const { user, error } = await this.getUser(token) if (error) throw error return { user, data: user, error: null } } catch (error) { return { user: null, data: null, error } } }
/** * Generates links to be sent via email or other. * @param type The link type ("signup" or "magiclink" or "recovery" or "invite"). * @param email The user's email. * @param password User password. For signup only. * @param data Optional user metadata. For signup only. * @param redirectTo The link type ("signup" or "magiclink" or "recovery" or "invite"). */ async generateLink( type: 'signup' | 'magiclink' | 'recovery' | 'invite', email: string, options: { password?: string data?: Record<string, unknown> redirectTo?: string } = {} ): Promise<{ data: Session | User | null; error: ApiError | null }> { try { const data: any = await post( `${this.url}/admin/generate_link`, { type, email, password: options.password, data: options.data, redirect_to: options.redirectTo, }, { headers: this.headers } ) return { data, error: null } } catch (e) { return { data: null, error: e as ApiError } } }}