feat(adapters): allow Account mapping before DB

[balazsorban44]

This is an alternative proposal to #4893

Right now, we pass through all the values of a provider account to the DB, and it causes confusion/unforeseen breaks when a provider decides to return a new property.

To solve this, we can add an account property to the provider configuration, similar to the profile callback, to control what part of the account should be saved to the database.

Example:

// pages/api/auth/[...nextauth].ts
import NextAuth from "next-auth"
import AzureAD from "next-auth/providers/azure-ad"

// this can be in `next-auth/providers/azure-ad`
interface AzureADAccount {
  ext_expires_in: number
}

declare module "next-auth" {
  interface Account extends AzureADAccount {}
}


export default NextAuth({
  providers: [
    AzureAD({
      ...
      // this would show a type error, because we required `ext_expires_in`
      account({ ext_expires_in, ...a }) {
        return a
      }
      // account: "minimal" // conversely, we can also only allow the most common properties
    })
  ]
})

Closes #4893

[vercel]

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

1 Ignored Deployment

Name	Status	Preview	Updated
next-auth	⬜️ Ignored (Inspect)		Sep 30, 2022 at 1:58PM (UTC)

[balazsorban44]

cc @palminha curious what you think. This would still introduce a new config option but would be already familiar since it's similar to the profile() callback and gives full control to the developer.

We could change the default value to "minimal" in a future major release.

It would align with the profile callback, which also only maps  id, name, image, and email by default. 👍

[balazsorban44]

These are the values currently in the default schemas.

[balazsorban44]

Closing as discussed with @ThangHuuVu. With some minor changes, this will be part of @auth/core, so the intention is to still simplify the default account model.