Database Adapters

gau can work with any database, though currently no databases are supported directly.

It’s adviced to use an ORM, which abstracts the database away. gau currently supports Drizzle with SQLite and PostgreSQL drivers.

Drizzle

The createAuth function not only sets up your authentication logic but also returns a set of database methods from your adapter, allowing you to interact with your user data directly.

Database Methods

Here are the methods returned by createAuth, which you can use in your application’s server-side logic:

getUser

Type: (id: string) => Promise<User | null>

Retrieves a user by their unique ID.

getUserByEmail

Type: (email: string) => Promise<User | null>

Finds a user by their email address.

getUserByAccount

Type: (provider: string, providerAccountId: string) => Promise<User | null>

Fetches a user based on their linked OAuth account.

getAccounts

Type: (userId: string) => Promise<Account[]>

Retrieves all accounts linked to a user.

getUserAndAccounts

Type: (userId: string) => Promise<{ user: User, accounts: Account[] } | null>

Retrieves a user and all their linked accounts in a single call.

createUser

Type: (data: NewUser) => Promise<User>

Creates a new user in the database.

linkAccount

Type: (data: NewAccount) => Promise<void>

Links an OAuth account to an existing user.

unlinkAccount

Type: (provider: string, providerAccountId: string) => Promise<void>

Unlinks an OAuth account from a user.

updateUser

Type: (data: Partial<User> & { id: string }) => Promise<User>

Updates a user’s information.

deleteUser

Type: (id: string) => Promise<void>

Deletes a user from the database.

Extending the Schema

You can add custom fields to gau-managed tables using a d.ts file.

1. Update Schema

Add your custom columns to the Drizzle schema.

schema.ts

import { text } from 'drizzle-orm/sqlite-core'

export const Users = sqliteTable('users', {
  // ...
  nickname: text(),
})

2. Augment Types

Create a declaration file to override the default User interface. This ensures auth.session.user.nickname is typed correctly.

src/gau.d.ts

import '@rttnd/gau'

declare module '@rttnd/gau' {
  interface User {
    nickname?: string | null
  }
}