@neondatabase/auth 0.1.0-beta.8 → 0.2.0-beta.1

package/README.md

@@ -3,7 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/@neondatabase/auth.svg)](https://www.npmjs.com/package/@neondatabase/auth)
 [![npm downloads](https://img.shields.io/npm/dm/@neondatabase/auth.svg)](https://www.npmjs.com/package/@neondatabase/auth)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue.svg)](https://www.typescriptlang.org/)
-[![License](https://img.shields.io/npm/l/@neondatabase/auth.svg)](https://github.com/neondatabase-labs/neon-js/blob/main/LICENSE)
+[![License](https://img.shields.io/npm/l/@neondatabase/auth.svg)](https://github.com/neondatabase/neon-js/blob/main/LICENSE)
 
 Authentication adapters for Neon Auth, supporting multiple auth providers.
 
@@ -19,9 +19,35 @@ This package is designed to work seamlessly with Neon's authentication infrastru
 
 - **Simple default API** - Works out of the box with Better Auth patterns
 - **Optional adapters** - Switch API styles for migrations or preferences
+- **Anonymous access** - Optional RLS-based data access for unauthenticated users
 - **Performance optimizations** - Session caching and request deduplication
 - **TypeScript support** - Fully typed with strict type checking
 
+## Why @neondatabase/auth?
+
+### vs. better-auth/client
+
+`@neondatabase/auth` is a wrapper around Better Auth that provides:
+
+**API Flexibility:**
+- Multiple adapters (Supabase-compatible, React hooks, vanilla)
+- Restricted options to match Neon Auth capabilities
+
+**Neon Auth Integration:**
+- Automatic `token_verifier` on OAuth callback
+- Pre-configured plugins for Neon Auth
+- Automatic JWT extraction from sessions
+- Popup-based OAuth flow for iframes
+
+**Built-in Enhancements:**
+- Session caching (60s TTL)
+- Request deduplication
+- Event system
+- Cross-tab sync
+- Token refresh detection
+
+If you're not using Neon Auth, you should probably use `better-auth/client` directly for more flexibility.
+
 ## Installation
 
 ```bash
@@ -144,6 +170,23 @@ function MyComponent() {
 }
 ```
 
+## Anonymous Access
+
+Enable `allowAnonymous` to let unauthenticated users access data via RLS policies:
+
+```typescript
+import { createAuthClient } from '@neondatabase/auth';
+
+const auth = createAuthClient('https://your-auth-server.com', {
+  allowAnonymous: true, // Enable anonymous data access
+});
+
+// Get token - returns anonymous token if no user session exists
+const token = await auth.getJWTToken?.();
+```
+
+This is useful when you want to allow read-only public access to certain data while still enforcing RLS policies.
+
 ## API Reference
 
 ### createAuthClient(url, config?)
@@ -153,6 +196,7 @@ Factory function to create an auth client.
 **Parameters:**
 - `url` - The auth service URL (required)
 - `config.adapter` - Optional adapter factory function (e.g., `SupabaseAuthAdapter()`)
+- `config.allowAnonymous` - When `true`, returns an anonymous token if no user session exists (default: `false`)
 
 **Returns:** The adapter's public API (varies by adapter type)
 
@@ -213,43 +257,89 @@ Multiple concurrent `getSession()` calls are automatically deduplicated:
 
 ## Next.js Integration
 
-For Next.js projects, this package provides built-in integration via `@neondatabase/auth/next`. See the [Next.js Setup Guide](./NEXT-JS.md) for:
+For Next.js projects, this package provides built-in integration via `@neondatabase/auth/next`. 
+See the [Next.js Setup Guide](./NEXT-JS.md) for comprehensive documentation including:
 
-- Setting up the auth handler with `authApiHandler()`
-- Protecting routes with `neonAuthMiddleware()`
-- Creating the auth client with `createAuthClient()` for client components
+- Setting up auth server instance with `createNeonAuth()` for handler, middleware and api methods  
+- Client-side auth with `createAuthClient()` for client components
 - Configuring the `NeonAuthUIProvider` with Email OTP, Social Login, and Organizations
 - Creating auth pages (`AuthView`, `AccountView`, `OrganizationView`)
 - Importing styles (with or without Tailwind CSS)
-- Accessing session data with `neonAuth()` in server components
 - Using `authClient.useSession()` hook in client components
 
-## CSS for UI Components
+## UI Components
 
-Styles for Neon Auth UI components are available from this package:
+Pre-built login forms and auth pages are included. No extra installation needed.
 
-| Export | Use Case |
-|--------|----------|
-| `@neondatabase/auth/ui/css` | Pre-built styles (~47KB) |
-| `@neondatabase/auth/ui/tailwind` | Tailwind-ready CSS |
+### 1. Import CSS
 
-```css
-/* Without Tailwind */
-@import '@neondatabase/auth/ui/css';
+**Without Tailwind CSS:**
+```typescript
+import '@neondatabase/auth/ui/css';
+```
 
-/* With Tailwind CSS v4 */
+**With Tailwind CSS v4:**
+```css
 @import 'tailwindcss';
 @import '@neondatabase/auth/ui/tailwind';
 ```
 
+### 2. Setup Provider
+
+```typescript
+"use client"
+
+import { NeonAuthUIProvider } from "@neondatabase/auth/react/ui"
+import { createAuthClient } from "@neondatabase/auth"
+import "@neondatabase/auth/ui/css"
+
+const authClient = createAuthClient('https://your-auth-url.com')
+
+export function AuthProvider({ children }) {
+  return (
+    <NeonAuthUIProvider authClient={authClient} redirectTo="/dashboard">
+      {children}
+    </NeonAuthUIProvider>
+  )
+}
+```
+
+### 3. Use Components
+
+**Option A: Full Auth Pages (Recommended)**
+
+Use `AuthView` to render complete auth flows based on the URL path:
+
+```typescript
+import { AuthView } from "@neondatabase/auth/react/ui"
+
+// Renders sign-in, sign-up, forgot-password, etc. based on path
+<AuthView path="sign-in" />
+```
+
+**Option B: Individual Components**
+
+```typescript
+import { SignInForm, UserButton } from "@neondatabase/auth/react/ui"
+
+<SignInForm />
+<UserButton />
+```
+
+Available components: `SignInForm`, `SignUpForm`, `UserButton`, `AuthView`, `AccountView`, `OrganizationView`
+
+For Next.js with dynamic routes, see the [Next.js Setup Guide](./NEXT-JS.md).
+
+For full documentation and theming, see [`@neondatabase/auth-ui`](../auth-ui).
+
 ## Related Packages
 
 - [`@neondatabase/neon-js`](../neon-js) - Full SDK with database and auth integration
-- [`@neondatabase/postgrest-js`](../postgrest-js) - PostgreSQL client without auth
+- [`@neondatabase/postgrest-js`](../postgrest-js) - PostgREST client without auth
 
 ## Resources
 
-- [Neon Auth Documentation](https://neon.tech/docs/neon-auth)
+- [Neon Auth Documentation](https://neon.com/docs/neon-auth)
 - [Better Auth Documentation](https://www.better-auth.com/docs)
 
 ## Support