Repository files navigation

Guides ·Reference Docs

For contributors: Repository Structure Changed

This repository has been restructured as a monorepo. All libraries, includingsupabase-js itself, have moved topackages/core/:

What You're Looking For	Where It Is Now
Main supabase-js code	packages/core/supabase-js/
Other libraries	packages/core/*/

Read theMigration Guide to learn more.

This monorepo contains the complete suite of Supabase JavaScript SDK:

This section outlines the scope of support for various runtime environments in Supabase JavaScript client.

We only support Node.js versions that are inActive LTS orMaintenance status as defined by theofficial Node.js release schedule. This means we support versions that are currently receiving long-term support and critical bug fixes.

When a Node.js version reaches end-of-life and is no longer in Active LTS or Maintenance status, Supabase will drop it in aminor release, andthis won't be considered a breaking change.

⚠️Node.js 18 Deprecation Notice

Node.js 18 reached end-of-life on April 30, 2025. As announced inour deprecation notice, support for Node.js 18 was dropped in version2.79.0.

If you must use Node.js 18, please use version2.78.0, which is the last version that supported Node.js 18.

We support Deno versions that are currently receiving active development and security updates. We follow theofficial Deno release schedule and only support versions from thestable andlts release channels.

When a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in aminor release, andthis won't be considered a breaking change.

All modern browsers are supported. We support browsers that provide nativefetch API. For Realtime features, browsers must also support nativeWebSocket API.

We support Bun runtime environments. Bun provides native fetch support and is compatible with Node.js APIs. Since Bun does not follow a structured release schedule like Node.js or Deno, we support current stable versions of Bun and may drop support for older versions in minor releases without considering it a breaking change.

We support React Native environments with fetch polyfills provided by the framework. Since React Native does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.

We support Cloudflare Workers runtime environments. Cloudflare Workers provides native fetch support. Since Cloudflare Workers does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.

• Experimental features: Features marked as experimental may be removed or changed without notice
• Build warnings: If you seeUNUSED_EXTERNAL_IMPORT warnings from Vite/Nuxt, see thesupabase-js README — these are false positives

npm install @supabase/supabase-js

Read more in each package's README file.

We welcome contributions! Please see ourContributing Guide for details.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes and add tests
4. Run tests (npx nx affected --target=test)
5. Commit your changes (npm run commit)
6. Push to your branch (git push origin feature/amazing-feature)
7. Open a Pull Request

• Followconventional commits for commit messages
• Add tests for new functionality
• Update documentation for API changes
• Runnpx nx format before committing
• Ensure all tests pass withnpx nx affected --target=test

Testing varies per package. See the top-levelTESTING.md for an overview and links to package-specific guides.

• Auth SDK - Authentication and user management
• Database SDK - Database queries and operations
• Realtime SDK - Real-time subscriptions
• Storage SDK - File upload and management
• Functions SDK - Edge Functions invocation
• Main SDK - Combined SDK

• Contributing - Development guidelines
• Release Workflows - Release and publishing process
• Migration Guide - Migrating to the monorepo structure
• Security Policy - Security guidelines and reporting

You can verify registry signatures and provenance attestations for installed packages using the npm CLI:

npm audit signatures

Quick example for a single package install:

npm install @supabase/auth-jsnpm audit signatures

Example output:

audited 1 package in 0s1 package has a verified registry signature

Because provenance attestations are a new capability, security features may evolve over time. Ensure you are using the latest npm CLI to verify attestation signatures reliably. This may require updating npm beyond the version bundled with Node.js.

This project is licensed under the MIT License - see theLICENSE file for details.

• Documentation:supabase.com/docs
• Community:GitHub Discussions
• Issues:GitHub Issues
• Discord:Supabase Discord