export const authOptions produces error

[lwensveen]

Question 💬

I was following the examples on this page: https://next-auth.js.org/getting-started/example#add-api-route which gave me the following error

app/api/auth/[...nextauth]/route.ts
Type error: Route "app/api/auth/[...nextauth]/route.ts" does not match the required types of a Next.js Route.
  "authOptions" is not a valid Route export field.

which is confusing me, since

  const session = await getServerSession(req, res, authOptions)

is then unusable? The error goes away if you remove the export from export const authOptions

I'm on next@13.4.1 and next-auth@4.22.1 and I'm using the new app directory

How to reproduce ☕️

app/api/auth/[...nextauth]/route.ts
Type error: Route "app/api/auth/[...nextauth]/route.ts" does not match the required types of a Next.js Route.
  "authOptions" is not a valid Route export field.

const authOptions = {
  adapter: undefined,
  callbacks: undefined,
  cookies: undefined,
  debug: false,
  events: undefined,
  jwt: undefined,
  logger: undefined,
  pages: undefined,
  providers: [
    GithubProvider({
      clientId: process.env.GITHUB_ID as string,
      clientSecret: process.env.GITHUB_SECRET as string,
    }),
  ],

  secret: '',
  session: undefined,
  theme: undefined,
  useSecureCookies: false,
};

  const session = await getServerSession(req, res, authOptions)

Contributing 🙌🏽

Yes, I am willing to help answer this question in a PR

[OtisTemler]

Yeah, same problem here.

[austins]

Getting something similar, which I believe is a related if not same underlying issue with next-auth@4.22.1:

.next/types/app/auth/[...nextauth]/route.ts:8:13
Type error: Type 'OmitWithTag<typeof import("/src/app/auth/[...nextauth]/route"), "config" | "generateStaticParams" | "revalidate" | "dynamic" | "dynamicParams" | "fetchCache" | ... 8 more ... | "PATCH", "">' does not satisfy the constraint '{ [x: string]: never; }'.
  Property 'authOptions' is incompatible with index signature.
    Type 'AuthOptions' is not assignable to type 'never'.

import NextAuth, { type AuthOptions } from "next-auth";
import GitHubProvider from "next-auth/providers/github";

export const authOptions: AuthOptions = {
    providers: [GitHubProvider({ clientId: "example", clientSecret: "example" })]
};

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST };

[austins]

Fixed it by moving the authOptions export to another file that's not a route. Also, make sure you follow the Route Handler guide for /app dir, not /pages/api: https://next-auth.js.org/configuration/initialization#route-handlers-app

[theDanielJLewis]

This was the strangest thing! I was exporting authOptions from my route.ts folder, too, and had no problems until tonight. I suddenly started getting this same error message on next build.

So I imported authOptions from a different file (that exports on its own) and now it's working.

STRANGE! But I'm grateful that the answer was already shared!