fix(ts): make User interface overridable using module augmentation

[comxd]

☕️ Reasoning

It's not possible to use TS module augmentation to force defined properties as required (i.e., not undefined) for the User interface using next-auth v5.

Usage:

// file types/next-auth.d.ts

declare module "next-auth" {
  interface User {
    id: string;
  }
}

🧢 Checklist

• Documentation
• Tests
• Ready to be merged

🎫 Affected issues

• Next Auth V5 Augment Typescript User Interface doesnt work #9253
• JWT module augmentation in next-auth v5 #9571
• (possibly related) Types of property 'createUser' are incompatible #9493

📌 Resources

• Next-Auth TS Module Augmentation (doc)

Related commits:

• 36286b1

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
auth-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 6, 2025 0:20am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
next-auth-docs	⬜️ Ignored (Inspect)	Visit Preview		Jan 6, 2025 0:20am

[vercel]

@comxd is attempting to deploy a commit to the authjs Team on Vercel.

A member of the Team first needs to authorize it.

[chungweileong94]

It doesn't seems to work tho.

[comxd]

It doesn't seems to work tho.

Your module augmentation is declared into a ".d.ts" or a ".ts" file?

[chungweileong94]

It doesn't seems to work tho.

Your module augmentation is declared into a ".d.ts" or a ".ts" file?

I'm using .ts

[comxd]

@chungweileong94 Try do define your augmentation into a .d.ts