Overview

This is the Sequelize Adapter for next-auth. This package can only be used in conjunction with the primary next-auth package. It is not a standalone package.

You can find the Sequelize schema in the docs at next-auth.js.org/adapters/sequelize.

Getting Started

1. Install next-auth and @next-auth/sequelize-adapter as well as sequelize and your database driver of choice.

npm install next-auth @next-auth/sequelize-adapter sequelize sqlite3
npm install --save-dev sequelize

2. Add this adapter to your pages/api/[...nextauth].js next-auth configuration object.

import NextAuth from "next-auth"
import SequelizeAdapter from "@next-auth/sequelize-adapter"
import Sequelize from 'sequelize'

const sequelize = new Sequelize("sqlite::memory:")

// For more information on each option (and a full list of options) go to
// https://next-auth.js.org/configuration/options
export default NextAuth({
  ...
  adapter: SequelizeAdapter(sequelize)
  ...
})

Updating the database schema

In development, the sequelize adapter will create the necessary tables, foreign keys and indexes in your database. In production, synchronization is disabled. Best practice is to create the required tables in your database via migrations.

In development, if you do not want the adapter to automatically create tables, you are able to pass { synchronize: false } as the second option to SequelizeAdapter to disable this behavior:

import NextAuth from "next-auth"
import SequelizeAdapter from "@next-auth/sequelize-adapter"
import Sequelize from 'sequelize'

const sequelize = new Sequelize("sqlite::memory:")

export default NextAuth({
  ...
  adapter: SequelizeAdapter(sequelize, { synchronize: false })
  ...
})

Using custom models

Sequelize models are option to customization like so:

import NextAuth from "next-auth"
import SequelizeAdapter, { models } from "@next-auth/sequelize-adapter"
import Sequelize, { DataTypes } from 'sequelize'

const sequelize = new Sequelize("sqlite::memory:")

export default NextAuth({
  ...
  adapter: SequelizeAdapter(sequelize, {
    models: {
      User: sequelize.define('user', { ...models.User, phoneNumber: DataTypes.STRING })
    }
  })
  ...
})

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our Contributing Guide.

License

ISC