Getting started

Install Lucia using your package manager of your choice.

npm i lucia-auth
pnpm add lucia-auth
yarn add lucia-auth

Set up the database

To support multiple databases, Lucia uses database adapters. These adapters provide a set of standardized methods to read from and update the database. Custom adapters can be created as well if Lucia does not provide one.

We currently support the following database/ORM options:

• Drizzle ORM
• Kysely
• Mongoose
• MySQL
• PlanetScale serverless
• PostgreSQL
• Prisma
• Redis
• SQLite

Initialize Lucia

In $lib/server/lucia.ts, import lucia from lucia-auth. Initialize it by defining adapter and env and export it. Additionally, we will import the Qwik middleware and pass it on to middleware. Make sure to export typeof auth as well.

// src/lib/lucia.ts
import lucia from "lucia-auth";
import { qwik } from "lucia-auth/middleware";
import prismaAdapter from "@lucia-auth/adapter-prisma";
import { PrismaClient } from "@prisma/client";

export const auth = lucia({
	adapter: prismaAdapter(new PrismaClient()),
	env: process.env.NODE_ENV === "development" ? "DEV" : "PROD",
	middleware: qwik()
});

export type Auth = typeof auth;

This module and the file that holds it should NOT be imported from the client.

Types

Create lucia.d.ts, and inside it configure your types. The path in import(‘./lib/lucia.js’).Auth; is where you exported auth (lucia()).

// src/lucia.d.ts
/// <reference types="lucia-auth" />
declare namespace Lucia {
	type Auth = import("./lib/lucia.js").Auth;
	type UserAttributes = {};
}