SurrealDB Adapter for Better Auth


A seamless integration between SurrealDB and
Better Auth, providing a robust authentication
solution with the power of SurrealDB's flexible database capabilities.

✨ Features

- 🔐 Secure authentication with SurrealDB
- 🔄 Real-time data synchronization
- 🚀 High performance and scalability
- 🔧 Easy configuration and setup
- 📦 TypeScript support
- 🧩 Flexible integration options

🚀 Getting Started

$3

- Node.js 18+ or Bun
- SurrealDB instance (local or cloud)
- Better Auth setup

$3

``bash


Using pnpm (recommended)

pnpm add surrealdb-better-auth

Using npm

npm install surrealdb-better-auth

Using yarn

yarn add surrealdb-better-auth
`

🛠️ Configuration

$3

`typescript
import { surrealAdapter } from "surrealdb-better-auth";

export const auth = betterAuth({
// ... other Better Auth options
database: surrealAdapter({
address: "http://localhost:8000", // Your SurrealDB server address
username: "root", // Your SurrealDB username
password: "root", // Your SurrealDB password
ns: "namespace", // Your namespace
db: "database", // Your database name
}),
});
`

$3

`typescript
import { surrealAdapter } from "surrealdb-better-auth";

export const auth = betterAuth({
// ... other Better Auth options
database: surrealAdapter({
address: process.env.SURREALDB_ADDRESS,
username: process.env.SURREALDB_USERNAME,
password: process.env.SURREALDB_PASSWORD,
ns: process.env.SURREALDB_NAMESPACE,
db: process.env.SURREALDB_DATABASE,
}),
});
`

📋 Schema Definitions

$3

#### Account Table

`sql
DEFINE TABLE account TYPE ANY SCHEMALESS COMMENT 'better-auth: accounts' PERMISSIONS NONE;
DEFINE FIELD accountId ON account TYPE record REFERENCE ON DELETE CASCADE PERMISSIONS FULL;
DEFINE FIELD createdAt ON account TYPE datetime DEFAULT time::now() PERMISSIONS FULL;
DEFINE FIELD id ON account TYPE string PERMISSIONS FULL;
DEFINE FIELD password ON account TYPE string PERMISSIONS FULL;
DEFINE FIELD providerId ON account TYPE string PERMISSIONS FULL;
DEFINE FIELD updatedAt ON account TYPE datetime DEFAULT time::now() PERMISSIONS FULL;
DEFINE FIELD userId ON account TYPE record REFERENCE ON DELETE CASCADE PERMISSIONS FULL;
`

#### Session Table

`sql
DEFINE TABLE session TYPE ANY SCHEMALESS COMMENT 'better-auth: sessions' PERMISSIONS NONE;
DEFINE FIELD activeOrganizationId ON session TYPE option> REFERENCE ON DELETE UNSET COMMENT 'The id of the active organization' PERMISSIONS FULL;
DEFINE FIELD createdAt ON session TYPE datetime DEFAULT time::now() PERMISSIONS FULL;
DEFINE FIELD expiresAt ON session PERMISSIONS FULL;
DEFINE FIELD id ON session TYPE string PERMISSIONS FULL;
DEFINE FIELD ipAddress ON session TYPE string PERMISSIONS FULL;
DEFINE FIELD token ON session TYPE string PERMISSIONS FULL;
DEFINE FIELD updatedAt ON session TYPE datetime DEFAULT time::now() PERMISSIONS FULL;
DEFINE FIELD userId ON session TYPE record REFERENCE ON DELETE CASCADE PERMISSIONS FULL;
`

#### User Table

`sql
DEFINE TABLE user TYPE ANY SCHEMALESS COMMENT 'better-auth: users' PERMISSIONS NONE;
DEFINE FIELD chats ON user TYPE references PERMISSIONS FULL;
DEFINE FIELD defaultOrganizationId ON user TYPE option> PERMISSIONS FULL;
DEFINE FIELD organizations ON user TYPE references PERMISSIONS FULL;
`

$3

#### Organization Table

`sql
DEFINE TABLE organization TYPE NORMAL SCHEMALESS COMMENT 'better-auth orgs: organizations' PERMISSIONS NONE;
DEFINE FIELD createdAt ON organization TYPE datetime DEFAULT time::now() PERMISSIONS FULL;
DEFINE FIELD logo ON organization TYPE option COMMENT 'The logo of the organization' PERMISSIONS FULL;
DEFINE FIELD metadata ON organization FLEXIBLE TYPE option