SurrealDB Adapter for Lucia

This adapter seamlessly integrates SurrealDB with Lucia, providing a robust and easy-to-use authentication solution for modern applications.

Modern Technology

SurrealDB

• SurrealDB Official Website
  • SurrealDB Documentation
• SurrealDB Github Repository
  • SurrealDB Javascript SDK Repository

Lucia auth

• Lucia Documentation
• Lucia Github Repository

Requirements

Note

Package installation examples use bun as the package manager, but you can replace bun with npm, yarn, pnpm, or deno.

• SurrealDB ^2.0.0-alpha.4
• SurrealDB Javascript SDK ^1.0.0-beta.12

  bunx jsr add @surrealdb/surrealdb@^1.0.0-beta.12

• Lucia ~3.2.0

  bun add lucia

• Typescript ^5.5.2

  bun add typescript

Installation

Note

Depending on your package manager, you can replace bunx with npx, yarn dlx, pnpm dlx, or use deno add.

bunx jsr add @oskargmerek/surreal-lucia

Setup Example

Important

This example shows how to implement a SurrealDB adapter for Lucia. It is not an example of the full authentication, nor authorization setup. You should be familiar with the Lucia documentation, which contains a framework-specific guides. Read the Lucia Documentation for more information.

import { Lucia } from "lucia";
import { SurrealDBLuciaAdapter } from "@oskargmerek/surreal-lucia";

// initialize SurrealDB
const db = new Surreal(); 

// initialize adapter
const adapter = new SurrealDBLuciaAdapter(db, {
  sessionTableName: 'sessions', 
  userTableName: 'users', 
}); 

// initialize Lucia with SurrealDB adapter
export const lucia = new Lucia(adapter, {
	sessionCookie: {
		attributes: {
			// set to `true` when using HTTPS
			secure: process.env.NODE_ENV === "production"
		}
	}
});

// IMPORTANT!
declare module "lucia" {
    interface Register {
      Lucia: typeof lucia;
      DatabaseUserAttributes: {
        username: string; // example of an additional optional attribute
      },
      DatabaseSessionAttributes: {
        device: string // example of an additional optional attribute
    }
  }
}

Documentation

• Documentation | SurrealDB Adapter for Lucia

License

This adapter is distributed under the MIT License. Please refer to the LICENSE file for more information.