Upgrade to supabase-js v2
supabase-js v2 focuses on "quality-of-life" improvements for developers and addresses some of the largest pain points in v1. v2 includes type support, a rebuilt Auth library with async methods, improved errors, and more.
No new features will be added to supabase-js v1 , but we'll continuing merging security fixes to v1, with maintenance patches for the next 3 months.
Upgrade the client library#
1npm install @supabase/supabase-js@2
Optionally if you are using custom configuration with createClient
then follow below:
src/supabaseClient.ts1const supabase = createClient(SUPABASE_URL, SUPABASE_ANON_KEY, {
2 schema: 'custom',
3 persistSession: false,
4})
Read more about the constructor options.
Auth methods#
The signIn() method has been deprecated in favor of more explicit method signatures to help with type hinting. Previously it was difficult for developers to know what they were missing (e.g., a lot of developers didn't realize they could use passwordless magic links).
Sign in with email and password
1const { user, error } = await supabase.auth.signIn({ email, password })
Sign in with magic link
1const { error } = await supabase.auth.signIn({ email })
Sign in with a third-party provider
1const { error } = await supabase.auth.signIn({ provider })
Sign in with phone
1const { error } = await supabase.auth.signIn({ phone, password })
Sign in with phone using OTP
1const { error } = await supabase.auth.api.sendMobileOTP(phone)
Reset password for email
1const { data, error } = await supabase.auth.api.resetPasswordForEmail(email)
Get the user's current session
1const session = supabase.auth.session()
Get the logged-in user
1const user = supabase.auth.user()
Update user data for a logged-in user
1const { user, error } = await supabase.auth.update({ attributes })
Use a custom access_token
JWT with Supabase
1const { user, error } = supabase.auth.setAuth(access_token)
Cookie methods
The cookie-related methods like setAuthCookie
and getUserByCookie
have been removed.
For Next.js you can use the Auth Helpers to help you manage cookies. If you can't use the Auth Helpers, you can use server-side rendering.
Some the PR for additional background information.
Data methods#
.insert()
/ .upsert()
/ .update()
/ .delete()
don't return rows by default: PR.
Previously, these methods return inserted/updated/deleted rows by default (which caused some confusion), and you can opt to not return it by specifying returning: 'minimal'
. Now the default behavior is to not return rows. To return inserted/updated/deleted rows, add a .select()
call at the end.
Insert and return data
1const { data, error } = await supabase.auth.insert({ new_data })
Update and return data
1const { data, error } = await supabase.auth.update({ new_data }).eq('id', id)
Realtime methods#
Subscribe
1const userListener = supabase
2 .from('users')
3 .on('*', (payload) => handleAllEventsPayload(payload.new))
4 .subscribe()
Unsubscribe
1userListener.unsubscribe()