Next.js route handler auth return type conflicts

[SongDerrick]

What is the improvement or update you wish to see?

import { auth } from "auth"

export const GET = auth((req) => {
  if (req.auth) {
    return Response.json({ data: "Protected data" })
  }

  return Response.json({ message: "Not authenticated" }, { status: 401 })
}) as any // TODO: Fix `auth()` return type

This code is from next-auth-example template.

without explicit type casting as any, type error occurs

such as

Type error: Route "app/api/protected/route.ts" has an invalid export:
  "unknown" is not a valid POST return type:
    Expected "void | Response | Promise<void | Response>", got "unknown".

For my case, I handled with explicit type casting by createing new type and interface to deal with it.

app/api/sample/route.ts

interface AuthRequest extends Request {
  auth?: any
}

type NextAuthAPIRouteHandler = (req: Request) => Promise<
  NextResponse<
    | {
        error: string
      }
    | {
        ok: boolean
      }
  >
>


export const POST = auth(async function POST(request: AuthRequest) {
  if (!request.auth) {
    return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
  }
  try {
    await businessLogic()
    return NextResponse.json({ ok: true }, { status: 200 })
  } catch (error) {
    return NextResponse.json(
      { ok: false, error: 'Sending Data Failed' },
      { status: 500 }
    )
  }
}) as NextAuthAPIRouteHandler

Therefore, there must be docs fixed since there is no explanations about explicit type casting.
Build Error always occurs without it, so i think it needs to be fixed.
Thanks.

Is there any context that might help us understand?

Reproduction environment

  System:
    OS: macOS 14.6.1
    CPU: (8) arm64 Apple M2
    Memory: 85.50 MB / 16.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 22.0.0 
    npm: 10.5.1 
    pnpm: 9.6.0 
  Browsers:
    Chrome: 128.0.6613.113
    Safari: 17.6

Does the docs page already exist? Please link to it.

https://authjs.dev/getting-started/session-management/protecting

[SongDerrick]

Created PR regarding this issues #11729

[github-actions]

This issue was marked with the help needed label by a maintainer.

The issue might require some digging, so it is recommended to have some experience with the project.

Have a look at the Contributing Guide first.

This will help you set up your development environment to get started. When you are ready, open a PR, and link back to this issue in the form of adding Fixes #1234 to the PR description, where 1234 is the issue number. This will auto-close the issue when the PR gets merged, making it easier for us to keep track of what has been fixed.

Please make sure that - if applicable - you add tests for the changes you make.

If you have any questions, feel free to ask in the comments below or the PR. Generally, you don't need to @mention anyone directly, as we will get notified anyway and will respond as soon as we can)

Note

There is no need to ask for permission "can I work on this?" Please, go ahead if there is no linked PR 🙂

[fprl]

Any update on this one? I see that the PR got closed

[SongDerrick]

i havent got any response