Request to update documentation regarding Custom Providers

[denik1981]

I found that there is a big mismatch in the Typed Provider the object is expecting and the one shown in the documentation.
Also is it possible to append a tiny description about each of the fields requested for a custom provider? It will help us know how to proceded when building a new one.

[balazsorban44]

Curious about the big mismatch.

Are you thinking of this: https://next-auth.js.org/configuration/providers/oauth#options

[denik1981]

From Using a Custom Provider docs:
)

{
  id: "google",
  name: "Google",
  type: "oauth",
  wellKnown: "https://accounts.google.com/.well-known/openid-configuration",
  authorization: { params: { scope: "openid email profile" } },
  idToken: true,
  checks: ["pkce", "state"],
  profile(profile) {
    return {
      id: profile.sub,
      name: profile.name,
      email: profile.email,
      image: profile.picture,
    }
  },
}

From providers.d.ts

export interface OAuthConfig<P extends Record<string, unknown> = Profile>
  extends CommonProviderOptions {
  authorizationParams?: Record<string, string>
  headers?: Record<string, any>
  type: "oauth"
  version: string
  scope: string | string[]
  params: { grant_type: string }
  accessTokenUrl: string
  requestTokenUrl?: string
  authorizationUrl: string
  profileUrl: string
  profile(profile: P, tokens: TokenSet): Awaitable<User & { id: string }>
  protection?: ProtectionType | ProtectionType[]
  clientId: string
  clientSecret:
    | string
    // TODO: only allow for Apple
    | Record<"appleId" | "teamId" | "privateKey" | "keyId", string>
  idToken?: boolean
  /**
   * @deprecated Will be removed in an upcoming major release. Use `protection: ["state"]` instead.
   */
  state?: boolean

  // TODO: only allow for BattleNet
  region?: string
  // TODO: only allow for some
  domain?: string
  // TODO: only allow for Azure Active Directory B2C and FusionAuth
  tenantId?: string
}

[denik1981]

The referenced example needs a revision cause that object isn't asignable to the type next-auth expects for a new custom provider.
Options docs are ok.

[balazsorban44]

you link to the wrong branch. that is for v3, the docs is currently the v4 version.

See this section of the migration guide explaining the changes https://next-auth.js.org/getting-started/upgrade-v4#providers

[denik1981]

Ok, I can see that. Thanks for pointing that out but please check that I was linking to v4 as well (not v3).

https://next-auth.js.org/getting-started/upgrade-v4#providers
https://next-auth.js.org/configuration/providers/oauth#using-a-custom-provider

Both of the above links below to v4 docs. Maybe the second one could be updated or include a warning sign for checking the breaking changes for v4 mentioned in the upgrade section. I was following the example code on v4 docs to build my custom provider and was a little bit confussed about why the type interface was so different.