@supabase/gotrue-js

What is @supabase/gotrue-js?

@supabase/gotrue-js is a JavaScript client library for Supabase's GoTrue server, which provides user authentication and management functionalities. It allows developers to handle user sign-ups, logins, password recovery, and other authentication-related tasks.

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

User Sign-Up

This feature allows you to sign up a new user with an email and password. The code sample demonstrates how to initialize the GoTrueClient and use the signUp method to create a new user.

const { GoTrueClient } = require('@supabase/gotrue-js');
const auth = new GoTrueClient({
  url: 'https://your-supabase-url.supabase.co/auth/v1',
  headers: { 'apikey': 'your-api-key' }
});

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

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

User Login

This feature allows you to log in an existing user with an email and password. The code sample demonstrates how to use the signIn method to authenticate a user.

const { GoTrueClient } = require('@supabase/gotrue-js');
const auth = new GoTrueClient({
  url: 'https://your-supabase-url.supabase.co/auth/v1',
  headers: { 'apikey': 'your-api-key' }
});

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

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

Password Recovery

This feature allows you to send a password recovery email to a user. The code sample demonstrates how to use the resetPasswordForEmail method to initiate the password recovery process.

const { GoTrueClient } = require('@supabase/gotrue-js');
const auth = new GoTrueClient({
  url: 'https://your-supabase-url.supabase.co/auth/v1',
  headers: { 'apikey': 'your-api-key' }
});

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

recoverPassword('[e-mail]');

Other packages similar to @supabase/gotrue-js

firebase

Firebase is a comprehensive app development platform that includes authentication services similar to @supabase/gotrue-js. It provides a wide range of authentication methods, including email/password, phone, and social providers. Firebase also offers additional services like real-time databases, cloud storage, and hosting.

auth0-js

Auth0 is a flexible, drop-in solution to add authentication and authorization services to your applications. The auth0-js library provides similar functionalities to @supabase/gotrue-js, such as user sign-up, login, and password recovery. Auth0 also supports a wide range of identity providers and offers advanced features like multi-factor authentication and user management.

aws-amplify

AWS Amplify is a set of tools and services for building secure, scalable mobile and web applications. The Amplify Auth module provides authentication functionalities similar to @supabase/gotrue-js, including user sign-up, login, and password recovery. It integrates seamlessly with other AWS services and supports various authentication methods.

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.63.0 (2024-03-26)

Features

• add method for anonymous sign-in (#858) (e8a1fc9)
• add support for error codes (#855) (99821f4)
• explicit cache: no-store in fetch (#847) (034bee0)
• warn use of getSession() when isServer on storage (#846) (9ea94fe)

Bug Fixes

• refactor all pkce code into a single method (#860) (860bffc)
• remove data type (#848) (15c7c82)