修改Next Auth默认User接口时出现TypeScript适配器错误

错误原因 #

你直接给NextAuth的User接口添加了必填的firstName字段，但NextAuth的Adapter（比如你使用的Prisma Adapter）返回的用户对象默认不包含这个字段，导致类型检查不通过，触发adapter选项报错。

设为可选字段的方案是否合适？ #

不合适。把firstName设为可选虽然能解决adapter的类型错误，但会让所有使用User接口的业务代码都必须处理firstName可能为undefined的情况，增加了代码复杂度；如果firstName在你的业务逻辑中是必填项，这种做法还会隐藏潜在的逻辑漏洞（比如忘记从数据库读取该字段）。

正确解决方案 #

方案一：让Adapter返回的用户包含firstName（推荐） #

如果firstName是业务必填字段，修改数据库Schema，让用户表包含该字段，确保Adapter能正确返回这个值。以Prisma为例：

// schema.prisma
model User {
  id            String    @id @default(cuid())
  name          String?
  email         String    @unique
  emailVerified DateTime?
  image         String?
  firstName     String    // 新增必填字段
  accounts      Account[]
  sessions      Session[]
}

修改后，PrismaAdapter返回的User对象会自动包含firstName，你原来的类型扩展代码就不会再报错。

方案二：自定义业务专用用户类型 #

如果暂时无法修改数据库或Adapter，可创建一个继承自NextAuth User的自定义类型，在业务代码中使用该类型，避免修改NextAuth原生的User接口：

// next-auth.d.ts
import { User as NextAuthUser } from "next-auth"
import { JWT } from "next-auth/jwt"

type UserId = string

declare module "next-auth/jwt" {
  interface JWT {
    id: UserId
    firstName: string
    email: string
  }
}

// 定义业务专用用户类型
export type AppUser = NextAuthUser & {
  firstName: string
}

在业务代码中使用AppUser，结合类型断言确保字段存在：

import { useSession } from "next-auth/react"
import { AppUser } from "./next-auth"

const { data: session } = useSession()
if (session?.user) {
  // 确定用户存在firstName时使用类型断言
  const user = session.user as AppUser
  console.log(user.firstName)
}

方案三：使用类型守卫处理可选字段 #

如果firstName确实是可选字段，但业务中某些场景需要确保它存在，可写一个类型守卫函数：

// utils/user.ts
import { User } from "next-auth"

export function hasFirstName(user: User): user is User & { firstName: string } {
  return typeof (user as any).firstName === "string"
}

在业务代码中使用：

import { useSession } from "next-auth/react"
import { hasFirstName } from "../utils/user"

const { data: session } = useSession()
if (session?.user && hasFirstName(session.user)) {
  // 这里user的firstName是必填的
  console.log(session.user.firstName)
}

内容的提问来源于stack exchange，提问作者Dantcho