override User or DefaultUser type

[aboyo]

Summary

Hi all,

I am currently using next-auth to implement login functionality. I am using the CredentialsProvider along with my own API server to verify usernames and passwords. In the authorize function, I want to return my custom-defined user object.

I have added a types/next-auth.d.ts file in the project and declared the User type: (it just only has one property 'id')

but, In the authorize function of the CredentialsProvider, user data can still have additional properties:

I have also tried declaring DefaultUser in the types/next-auth.d.ts file, but it didn't work.

How do I customize the User type~?

// I'm using next-auth:^4.24.3

Additional information

No response

Example

No response

[nktnet1]

For next-auth v4.24.10 and v5.0.0-beta.25, I'm using the following:

/* eslint-disable @typescript-eslint/no-unused-vars */
import { JWT } from "next-auth/jwt"
import NextAuth, { DefaultSession, User } from 'next-auth';

export interface CustomAuthUser extends User {
  id: string;
}

declare module 'next-auth' {
  interface Session {
    user?: CustomAuthUser & DefaultSession['user'];
  }
}

declare module 'next-auth/jwt' {
  interface JWT {
    user?: CustomAuthUser;
  }
}

Bear in mind that your versions of @auth/drizzle-adapter and @auth/core, if you're using them in your project could affect the above - e.g.

• BUG: Auth.js TypeScript error for custom JWT/Session types jschuur/decent-nextjs-starter-template#33
• JWT module augmentation in next-auth v5 #9571 (comment)

and if these can't be updated, you may need to change

declare module 'next-auth/jwt' {

to

declare module '@auth/core/jwt' {