@supabase/auth-js

What is @supabase/auth-js?

@supabase/auth-js is a JavaScript library that provides authentication functionalities for Supabase, an open-source Firebase alternative. It allows developers to manage user authentication, including sign-up, sign-in, password recovery, and social logins, among other features.

What are @supabase/auth-js's main functionalities?

Sign Up

This feature allows users to sign up for an account using their email and password. The code sample demonstrates how to use the `signUp` method to create a new user.

const { createClient } = require('@supabase/supabase-js');
const supabase = createClient('https://your-project.supabase.co', 'public-anon-key');

async function signUp(email, password) {
  const { user, error } = await supabase.auth.signUp({
    email: email,
    password: password
  });
  if (error) console.error('Error signing up:', error);
  else console.log('User signed up:', user);
}

signUp('[e-mail]', 'password123');

Sign In

This feature allows users to sign in to their account using their email and password. The code sample demonstrates how to use the `signIn` method to authenticate a user.

const { createClient } = require('@supabase/supabase-js');
const supabase = createClient('https://your-project.supabase.co', 'public-anon-key');

async function signIn(email, password) {
  const { user, error } = await supabase.auth.signIn({
    email: email,
    password: password
  });
  if (error) console.error('Error signing in:', error);
  else console.log('User signed in:', user);
}

signIn('[e-mail]', 'password123');

Password Recovery

This feature allows users to recover their password by sending a password recovery email. The code sample demonstrates how to use the `resetPasswordForEmail` method to initiate the password recovery process.

const { createClient } = require('@supabase/supabase-js');
const supabase = createClient('https://your-project.supabase.co', 'public-anon-key');

async function resetPassword(email) {
  const { data, error } = await supabase.auth.api.resetPasswordForEmail(email);
  if (error) console.error('Error sending password recovery email:', error);
  else console.log('Password recovery email sent:', data);
}

resetPassword('[e-mail]');

Social Logins

This feature allows users to sign in using social login providers like GitHub, Google, etc. The code sample demonstrates how to use the `signIn` method with a provider to authenticate a user via social login.

const { createClient } = require('@supabase/supabase-js');
const supabase = createClient('https://your-project.supabase.co', 'public-anon-key');

async function signInWithProvider(provider) {
  const { user, session, error } = await supabase.auth.signIn({
    provider: provider
  });
  if (error) console.error('Error signing in with provider:', error);
  else console.log('User signed in with provider:', user);
}

signInWithProvider('github');

Other packages similar to @supabase/auth-js

firebase

Firebase is a comprehensive app development platform that includes authentication services. It supports email/password authentication, social logins, and more. Compared to @supabase/auth-js, Firebase offers a broader range of services beyond authentication, such as real-time databases, cloud functions, and analytics.

auth0-js

Auth0 is a flexible, drop-in solution to add authentication and authorization services to your applications. It supports various authentication methods, including social logins, enterprise logins, and multi-factor authentication. Compared to @supabase/auth-js, Auth0 provides more advanced features and integrations but can be more complex to set up and manage.

next-auth

NextAuth.js is a complete open-source authentication solution for Next.js applications. It supports various authentication methods, including email/password, OAuth providers, and more. Compared to @supabase/auth-js, NextAuth.js is specifically designed for Next.js and offers seamless integration with it, while @supabase/auth-js can be used with any JavaScript framework.

README

auth-js

An isomorphic JavaScript client library for the Supabase Auth API.

Docs

• Using auth-js: https://supabase.com/docs/reference/javascript/auth-signup
• TypeDoc: https://supabase.github.io/auth-js/v2

Quick start

Install

npm install --save @supabase/auth-js

Usage

import { AuthClient } from '@supabase/auth-js'

const GOTRUE_URL = 'http://localhost:9999'

const auth = new AuthClient({ url: GOTRUE_URL })

• signUp(): https://supabase.io/docs/reference/javascript/auth-signup
• signIn(): https://supabase.io/docs/reference/javascript/auth-signin
• signOut(): https://supabase.io/docs/reference/javascript/auth-signout

Custom fetch implementation

auth-js uses the cross-fetch library to make HTTP requests, but an alternative fetch implementation can be provided as an option. This is most useful in environments where cross-fetch is not compatible, for instance Cloudflare Workers:

import { AuthClient } from '@supabase/auth-js'

const AUTH_URL = 'http://localhost:9999'

const auth = new AuthClient({ url: AUTH_URL, fetch: fetch })

Sponsors

We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves.

Changelog

2.65.1 (2024-10-14)

Bug Fixes

• Call SIGNED_OUT event where session is removed (#854) (436fd9f)
• improve mfa.enroll return types (#956) (8a1ec06)
• move MFA sub types to internal file (#964) (4b7455c)
• remove phone mfa deletion, match on error codes (#963) (ef3911c)