\n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick start\n\nInstall\n\n```bash\nnpm install --save @supabase/auth-js\n```\n\nUsage\n\n```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst GOTRUE_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: GOTRUE_URL })\n```\n\n- `signUp()`: https://supabase.com/docs/reference/javascript/auth-signup\n- `signIn()`: https://supabase.com/docs/reference/javascript/auth-signin\n- `signOut()`: https://supabase.com/docs/reference/javascript/auth-signout\n\n### Custom `fetch` implementation\n\n`auth-js` uses the [`cross-fetch`](https://www.npmjs.com/package/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:\n\n```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst AUTH_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: AUTH_URL, fetch: fetch })\n```\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n```bash\n# Complete build (from monorepo root)\nnpx nx build auth-js\n\n# Build with watch mode for development\nnpx nx build auth-js --watch\n\n# Individual build targets\nnpx nx build:main auth-js # CommonJS build (dist/main/)\nnpx nx build:module auth-js # ES Modules build (dist/module/)\n\n# Other useful commands\nnpx nx lint auth-js # Run ESLint\nnpx nx typecheck auth-js # TypeScript type checking\nnpx nx docs auth-js # Generate documentation\n```\n\n#### Build Outputs\n\n- **CommonJS (`dist/main/`)** - For Node.js environments\n- **ES Modules (`dist/module/`)** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (`dist/module/index.d.ts`)** - Type definitions for TypeScript projects\n\n### Testing\n\nThe auth-js package has two test suites:\n\n1. **CLI Tests** - Main test suite using Supabase CLI (331 tests)\n2. **Docker Tests** - Edge case tests requiring specific GoTrue configurations (11 tests)\n\n#### Prerequisites\n\n- **Supabase CLI** - Required for main test suite ([installation guide](https://supabase.com/docs/guides/cli))\n- **Docker** - Required for edge case tests\n\n#### Running Tests\n\n```bash\n# Run main test suite with Supabase CLI (recommended)\nnpx nx test:auth auth-js\n\n# Run Docker-only edge case tests\nnpx nx test:docker auth-js\n\n# Run both test suites\nnpx nx test:auth auth-js && npx nx test:docker auth-js\n```\n\n#### Main Test Suite (Supabase CLI)\n\nThe `test:auth` command automatically:\n\n1. Stops any existing Supabase instance\n2. Starts a local Supabase instance via CLI\n3. Runs the test suite (excludes `docker-tests/` folder)\n4. Cleans up after tests complete\n\n```bash\n# Individual commands for manual control\nnpx nx test:infra auth-js # Start Supabase CLI\nnpx nx test:suite auth-js # Run tests only\nnpx nx test:clean-post auth-js # Stop Supabase CLI\n```\n\n#### Docker Tests (Edge Cases)\n\nThe `test:docker` target runs tests that require specific GoTrue configurations not possible with a single Supabase CLI instance:\n\n- **Signup disabled** - Tests for disabled signup functionality\n- **Asymmetric JWT (RS256)** - Tests for RS256 JWT verification\n- **Phone OTP / SMS** - Tests requiring Twilio SMS provider\n- **Anonymous sign-in disabled** - Tests for disabled anonymous auth\n\nThese tests are located in `test/docker-tests/` and use the Docker Compose setup in `infra/docker-compose.yml`.\n\n```bash\n# Individual commands for manual control\nnpx nx test:docker:infra auth-js # Start Docker containers\nnpx nx test:docker:suite auth-js # Run Docker tests only\nnpx nx test:docker:clean-post auth-js # Stop Docker containers\n```\n\n#### Development Testing\n\nFor actively developing and debugging tests:\n\n```bash\n# Start Supabase CLI once\nnpx nx test:infra auth-js\n\n# Run tests multiple times (faster since instance stays up)\nnpx nx test:suite auth-js\n\n# Clean up when done\nnpx nx test:clean-post auth-js\n```\n\n#### Test Infrastructure\n\n| Suite | Infrastructure | Configuration |\n| ------------ | -------------- | --------------------------- |\n| CLI Tests | Supabase CLI | `test/supabase/config.toml` |\n| Docker Tests | Docker Compose | `infra/docker-compose.yml` |\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](../../../CONTRIBUTING.md) for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.","users":{}}
![\"Supabase](\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg\"){kind=logo}
\n