@delmaredigital/payload-better-auth 0.1.4 → 0.2.2

package/LICENSE

@@ -1,73 +1,21 @@
-# PolyForm Noncommercial License 1.0.0
-
-<https://polyformproject.org/licenses/noncommercial/1.0.0>
-
-## Acceptance
-
-In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
-
-## Copyright License
-
-The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose. However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
-
-## Distribution License
-
-The licensor grants you an additional copyright license to distribute copies of the software. Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
-
-## Notices
-
-You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software. For example:
-
-> Required Notice: Copyright Delmare Digital LLC (https://delmaredigital.com)
-
-## Changes and New Works License
-
-The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
-
-## Patent License
-
-The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
-
-## Noncommercial Purposes
-
-Any noncommercial purpose is a permitted purpose.
-
-## Personal Uses
-
-Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
-
-## Noncommercial Organizations
-
-Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
-
-## Fair Use
-
-You may have "fair use" rights for the software under the law. These terms do not limit them.
-
-## No Other Rights
-
-These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
-
-## Patent Defense
-
-If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
-
-## Violations
-
-The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
-
-## No Liability
-
-***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
-
-## Definitions
-
-The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
-
-**You** refers to the individual or entity agreeing to these terms.
-
-**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
-
-**Your licenses** are all the licenses granted to you for the software under these terms.
-
-**Use** means anything you do with the software requiring one of your licenses.
+MIT License
+
+Copyright (c) 2026 Delmare Digital
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -9,7 +9,7 @@ Better Auth adapter and plugins for Payload CMS. Enables seamless integration be
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [API Reference](#api-reference)
-- [Admin Panel Integration](#admin-panel-integration)
+- [Customization](#customization)
 - [Plugin Compatibility](#plugin-compatibility)
 - [License](#license)
 
@@ -19,12 +19,12 @@ Better Auth adapter and plugins for Payload CMS. Enables seamless integration be
 
 ### Requirements
 
-| Dependency | Version |
-|------------|---------|
-| `better-auth` | >= 1.0.0 |
-| `payload` | >= 3.0.0 |
-| `next` | >= 15.4.0 |
-| `react` | >= 18.0.0 |
+| Dependency | Version | Latest |
+|------------|---------|--------|
+| `better-auth` | >= 1.4.0 | 1.4.11 |
+| `payload` | >= 3.0.0 | 3.70.0 |
+| `next` | >= 15.5.9 | 16.1.1 |
+| `react` | >= 18.0.0 | 19.2.3 |
 
 ### Install
 
@@ -32,25 +32,6 @@ Better Auth adapter and plugins for Payload CMS. Enables seamless integration be
 pnpm add @delmaredigital/payload-better-auth better-auth
 ```
 
-Or install from GitHub:
-
-```bash
-pnpm add github:delmaredigital/payload-better-auth
-```
-
-### Local Development
-
-For local development with hot reloading:
-
-```bash
-# In the package directory
-cd path/to/payload-better-auth
-pnpm link --global
-
-# In your project
-pnpm link --global @delmaredigital/payload-better-auth
-```
-
 ---
 
 ## Quick Start
@@ -85,72 +66,7 @@ export const collectionSlugs = {
 } as const
 ```
 
-### Step 2: Create the Auth Instance Factory
-
-```ts
-// src/lib/auth/index.ts
-import { betterAuth } from 'better-auth'
-import type { BasePayload } from 'payload'
-import { payloadAdapter } from '@delmaredigital/payload-better-auth'
-import { betterAuthOptions, collectionSlugs } from './config'
-
-export function createAuth(payload: BasePayload) {
-  return betterAuth({
-    ...betterAuthOptions,
-    database: payloadAdapter({
-      payloadClient: payload,
-      adapterConfig: {
-        collections: collectionSlugs,
-        enableDebugLogs: process.env.NODE_ENV === 'development',
-        idType: 'number', // Use Payload's default SERIAL IDs
-      },
-    }),
-    // Use serial/integer IDs (Payload default) instead of UUID
-    advanced: {
-      database: {
-        generateId: 'serial',
-      },
-    },
-    secret: process.env.BETTER_AUTH_SECRET,
-    trustedOrigins: [process.env.NEXT_PUBLIC_APP_URL || ''],
-  })
-}
-```
-
-### Step 3: Configure Payload
-
-```ts
-// src/payload.config.ts
-import { buildConfig } from 'payload'
-import {
-  betterAuthCollections,
-  createBetterAuthPlugin,
-} from '@delmaredigital/payload-better-auth'
-import { betterAuthOptions } from './lib/auth/config'
-import { createAuth } from './lib/auth'
-import { Users } from './collections/Users'
-
-export default buildConfig({
-  collections: [Users /* ... other collections */],
-  plugins: [
-    // Auto-generate sessions, accounts, verifications collections
-    betterAuthCollections({
-      betterAuthOptions,
-      skipCollections: ['user'], // We define Users ourselves
-    }),
-    // Initialize Better Auth in Payload's lifecycle
-    createBetterAuthPlugin({
-      createAuth,
-    }),
-  ],
-  db: postgresAdapter({
-    pool: { connectionString: process.env.DATABASE_URL },
-    // Use Payload defaults - Better Auth adapter handles ID conversion
-  }),
-})
-```
-
-### Step 4: Create Your Users Collection
+### Step 2: Create Your Users Collection
 
 ```ts
 // src/collections/Users.ts
@@ -189,27 +105,62 @@ export const Users: CollectionConfig = {
 }
 ```
 
-### Step 5: Create the Auth API Route
+### Step 3: Configure Payload
 
 ```ts
-// src/app/api/auth/[...all]/route.ts
-import { getPayload } from 'payload'
-import config from '@payload-config'
-import type { NextRequest } from 'next/server'
-import type { PayloadWithAuth } from '@delmaredigital/payload-better-auth'
-
-export async function GET(request: NextRequest) {
-  const payload = (await getPayload({ config })) as PayloadWithAuth
-  return payload.betterAuth.handler(request)
-}
+// src/payload.config.ts
+import { buildConfig } from 'payload'
+import { postgresAdapter } from '@payloadcms/db-postgres'
+import { betterAuth } from 'better-auth'
+import {
+  betterAuthCollections,
+  createBetterAuthPlugin,
+  payloadAdapter,
+} from '@delmaredigital/payload-better-auth'
+import { betterAuthOptions, collectionSlugs } from './lib/auth/config'
+import { Users } from './collections/Users'
 
-export async function POST(request: NextRequest) {
-  const payload = (await getPayload({ config })) as PayloadWithAuth
-  return payload.betterAuth.handler(request)
-}
+export default buildConfig({
+  collections: [Users /* ...other collections */],
+  plugins: [
+    // Auto-generate sessions, accounts, verifications collections
+    betterAuthCollections({
+      betterAuthOptions,
+      skipCollections: ['user'], // We define Users ourselves
+    }),
+    // Initialize Better Auth with auto-injected endpoints and admin components
+    createBetterAuthPlugin({
+      createAuth: (payload) =>
+        betterAuth({
+          ...betterAuthOptions,
+          database: payloadAdapter({
+            payloadClient: payload,
+            adapterConfig: {
+              collections: collectionSlugs,
+              enableDebugLogs: process.env.NODE_ENV === 'development',
+              idType: 'number', // Use Payload's default SERIAL IDs
+            },
+          }),
+          advanced: {
+            database: {
+              generateId: 'serial',
+            },
+          },
+          secret: process.env.BETTER_AUTH_SECRET,
+          trustedOrigins: [process.env.NEXT_PUBLIC_APP_URL || ''],
+        }),
+    }),
+  ],
+  admin: {
+    user: 'users',
+  },
+  db: postgresAdapter({
+    pool: { connectionString: process.env.DATABASE_URL },
+  }),
+})
 ```
 
-### Step 6: Client-Side Auth
+### Step 4: Client-Side Auth
 
 ```ts
 // src/lib/auth/client.ts
@@ -227,7 +178,7 @@ export const authClient = createAuthClient({
 export const { useSession, signIn, signUp, signOut } = authClient
 ```
 
-### Step 7: Server-Side Session Access
+### Step 5: Server-Side Session Access
 
 ```ts
 // In a server component or API route
@@ -248,6 +199,11 @@ export default async function Dashboard() {
 }
 ```
 
+**That's it!** The plugin automatically:
+- Registers auth API endpoints at `/api/auth/*`
+- Injects logout button, login redirect, and login page components
+- Handles session management via Better Auth
+
 ---
 
 ## API Reference
@@ -306,12 +262,30 @@ Payload plugin that initializes Better Auth during Payload's `onInit`.
 ```ts
 createBetterAuthPlugin({
   createAuth: (payload) => betterAuth({ ... }),
+  authBasePath: '/auth',
+  autoRegisterEndpoints: true,
+  autoInjectAdminComponents: true,
+  admin: {
+    login: { title: 'Admin Login' },
+  },
 })
 ```
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `createAuth` | `(payload: BasePayload) => Auth` | Factory function that creates the Better Auth instance |
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `createAuth` | `(payload: BasePayload) => Auth` | *required* | Factory function that creates the Better Auth instance |
+| `authBasePath` | `string` | `'/auth'` | Base path for auth API endpoints |
+| `autoRegisterEndpoints` | `boolean` | `true` | Auto-register auth API endpoints |
+| `autoInjectAdminComponents` | `boolean` | `true` | Auto-inject admin components when `disableLocalStrategy` detected |
+| `admin.disableLogoutButton` | `boolean` | `false` | Disable logout button injection |
+| `admin.disableBeforeLogin` | `boolean` | `false` | Disable BeforeLogin redirect injection |
+| `admin.disableLoginView` | `boolean` | `false` | Disable login view injection |
+| `admin.login.title` | `string` | `'Login'` | Custom login page title |
+| `admin.login.afterLoginPath` | `string` | `'/admin'` | Redirect path after successful login |
+| `admin.login.requiredRole` | `string \| null` | `'admin'` | Required role for admin access. Set to `null` to disable role checking. |
+| `admin.logoutButtonComponent` | `string` | - | Override logout button (import map format) |
+| `admin.beforeLoginComponent` | `string` | - | Override BeforeLogin component |
+| `admin.loginViewComponent` | `string` | - | Override login view component |
 
 ### `betterAuthStrategy(options?)`
 
@@ -347,189 +321,111 @@ const user = await getServerUser(payload, headersList)
 
 ---
 
-## Admin Panel Integration
-
-When using `disableLocalStrategy: true` in your Users collection, you need custom admin authentication components since Payload's default login form won't work.
-
-### Why Custom Components Are Needed
+## Customization
 
-With `disableLocalStrategy: true`:
-- Payload's default login form is disabled
-- Users must authenticate via Better Auth
-- A custom login page is needed at `/admin/login`
-- A custom logout button is needed to clear Better Auth sessions
+### Role-Based Access Control
 
-<details>
-<summary><strong>Step 1: Create BeforeLogin Component</strong></summary>
-
-This component redirects unauthenticated users from Payload's login to your custom login page:
+By default, the login page checks that users have the `admin` role before allowing access to the admin panel. Users without the required role see an "Access Denied" message.
 
-```tsx
-// src/components/admin/BeforeLogin.tsx
-'use client'
+```ts
+createBetterAuthPlugin({
+  createAuth,
+  admin: {
+    login: {
+      // Default: 'admin' - only users with role='admin' can access
+      requiredRole: 'admin',
 
-import { useEffect } from 'react'
-import { useRouter } from 'next/navigation'
+      // Use a different role name
+      requiredRole: 'editor',
 
-export default function BeforeLogin() {
-  const router = useRouter()
+      // Disable role checking entirely
+      requiredRole: null,
+    },
+  },
+})
+```
 
-  useEffect(() => {
-    router.replace('/admin/login')
-  }, [router])
+**For complex RBAC** (multiple roles, permissions, etc.), disable the login view and create your own:
 
-  return (
-    <div style={{ display: 'flex', minHeight: '100vh', alignItems: 'center', justifyContent: 'center' }}>
-      <div>Redirecting to login...</div>
-    </div>
-  )
-}
+```ts
+createBetterAuthPlugin({
+  createAuth,
+  admin: {
+    disableLoginView: true,
+    loginViewComponent: '@/components/admin/CustomLoginWithRBAC',
+  },
+})
 ```
-</details>
-
-<details>
-<summary><strong>Step 2: Create Custom Logout Button</strong></summary>
 
-**IMPORTANT**: The logout button must only trigger logout **on click**, not on mount. Triggering logout on mount would cause an infinite redirect loop since this component is rendered in the admin panel header.
+You can use the built-in `LoginView` as a starting point:
 
 ```tsx
-// src/components/admin/Logout.tsx
+// src/components/admin/CustomLoginWithRBAC.tsx
 'use client'
 
-import { useState } from 'react'
-import { useRouter } from 'next/navigation'
-import { signOut } from '@/lib/auth/client'
-
-export default function Logout() {
-  const router = useRouter()
-  const [isLoading, setIsLoading] = useState(false)
-
-  async function handleLogout() {
-    if (isLoading) return
-    setIsLoading(true)
-
-    try {
-      await signOut()
-      router.push('/admin/login')
-    } catch (error) {
-      console.error('Logout error:', error)
-      setIsLoading(false)
-    }
-  }
+import { LoginView } from '@delmaredigital/payload-better-auth/components'
 
-  return (
-    <button
-      onClick={handleLogout}
-      disabled={isLoading}
-      type="button"
-      className="btn btn--style-secondary btn--icon-style-without-border btn--size-small btn--withoutPopup"
-    >
-      {isLoading ? 'Logging out...' : 'Log out'}
-    </button>
-  )
+// Option 1: Wrap and extend the built-in component
+export default function CustomLoginWithRBAC() {
+  // Add your custom RBAC logic here
+  return <LoginView requiredRole={null} /> // Disable built-in role check
 }
-```
-</details>
-
-<details>
-<summary><strong>Step 3: Create Admin Login Page</strong></summary>
 
-```tsx
-// src/app/(frontend)/admin/login/page.tsx
-'use client'
+// Option 2: Copy the LoginView source code from the package and customize fully
+// See: node_modules/@delmaredigital/payload-better-auth/dist/components/LoginView.js
+```
 
-import { useEffect, useState, type FormEvent } from 'react'
-import { useRouter } from 'next/navigation'
-import { useSession, signIn } from '@/lib/auth/client'
-
-export default function AdminLoginPage() {
-  const { data: session, isPending } = useSession()
-  const router = useRouter()
-  const [email, setEmail] = useState('')
-  const [password, setPassword] = useState('')
-  const [error, setError] = useState<string | null>(null)
-  const [isLoading, setIsLoading] = useState(false)
-
-  useEffect(() => {
-    if (session?.user) {
-      const user = session.user as { role?: string }
-      if (user.role === 'admin') {
-        router.push('/admin')
-      } else {
-        setError('Access denied. Admin role required.')
-      }
-    }
-  }, [session, router])
-
-  async function handleSubmit(e: FormEvent) {
-    e.preventDefault()
-    setError(null)
-    setIsLoading(true)
-
-    try {
-      const result = await signIn.email({ email, password })
-      if (result.error) {
-        setError(result.error.message || 'Invalid credentials')
-        setIsLoading(false)
-        return
-      }
-      router.refresh()
-    } catch {
-      setError('An unexpected error occurred')
-      setIsLoading(false)
-    }
-  }
+### Disabling Auto-Injection
 
-  if (isPending) {
-    return <div>Loading...</div>
-  }
+If you prefer to handle API routes or admin components manually:
 
-  return (
-    <form onSubmit={handleSubmit}>
-      <h1>Admin Login</h1>
-      <input
-        type="email"
-        value={email}
-        onChange={(e) => setEmail(e.target.value)}
-        placeholder="Email"
-        required
-      />
-      <input
-        type="password"
-        value={password}
-        onChange={(e) => setPassword(e.target.value)}
-        placeholder="Password"
-        required
-      />
-      {error && <div style={{ color: 'red' }}>{error}</div>}
-      <button type="submit" disabled={isLoading}>
-        {isLoading ? 'Signing in...' : 'Sign in'}
-      </button>
-    </form>
-  )
-}
+```ts
+createBetterAuthPlugin({
+  createAuth,
+  autoRegisterEndpoints: false,      // Handle API route yourself
+  autoInjectAdminComponents: false,  // Handle admin components yourself
+})
 ```
-</details>
 
-<details>
-<summary><strong>Step 4: Configure Payload Admin Components</strong></summary>
+### Custom Admin Components
+
+Override specific admin components while keeping others auto-injected:
 
 ```ts
-// payload.config.ts
-export default buildConfig({
+createBetterAuthPlugin({
+  createAuth,
   admin: {
-    user: Users.slug,
-    components: {
-      beforeLogin: ['@/components/admin/BeforeLogin'],
-      logout: {
-        Button: '@/components/admin/Logout',
-      },
-    },
+    // Use custom components (import map format)
+    loginViewComponent: '@/components/admin/CustomLogin',
+    logoutButtonComponent: '@/components/admin/CustomLogout',
+
+    // Or disable specific components
+    disableBeforeLogin: true,
   },
-  // ... rest of config
 })
 ```
-</details>
+
+### Manual API Route (Advanced)
+
+If you disable `autoRegisterEndpoints`, create your own route:
+
+```ts
+// src/app/api/auth/[...all]/route.ts
+import { getPayload } from 'payload'
+import config from '@payload-config'
+import type { NextRequest } from 'next/server'
+import type { PayloadWithAuth } from '@delmaredigital/payload-better-auth'
+
+export async function GET(request: NextRequest) {
+  const payload = (await getPayload({ config })) as PayloadWithAuth
+  return payload.betterAuth.handler(request)
+}
+
+export async function POST(request: NextRequest) {
+  const payload = (await getPayload({ config })) as PayloadWithAuth
+  return payload.betterAuth.handler(request)
+}
+```
 
 ---
 
@@ -731,25 +627,4 @@ The auto-generated collections create relationship fields like `user` (from `use
 
 ## License
 
-This project is licensed under the [PolyForm Noncommercial License 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/).
-
-### What This Means
-
-**✅ Free for:**
-- Personal projects and hobby use
-- Open source projects
-- Educational and research purposes
-- Evaluation and testing
-- Nonprofit organizations
-- Government institutions
-
-**💼 Commercial use:**
-Requires a separate commercial license. If you're using this in a commercial product or service, please contact us for licensing options.
-
-**📧 Commercial Licensing:** [hello@delmaredigital.com](mailto:hello@delmaredigital.com)
-
----
-
-## About
-
-Built by [Delmare Digital](https://delmaredigital.com) — custom software solutions for growing businesses.
+MIT