My Next.js app isn’t building and returning a type error, how do I fix?

huangapple go评论787阅读模式
英文:

My Next Js app isn't building and returing a type error, how do I fix?

问题

Your provided content:

"My NextJS 13 app isn't building and is returning a type error but it is completely working on development environment.

The type error is shown in this file:

import NextAuth, { AuthOptions } from "next-auth";
import GoogleProvider from "next-auth/providers/google";

export const authOptions: AuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

The file path is app/api/auth/[...nextauth]/route.ts.

This is the error message shown in the console:

.next/types/app/api/auth/[...nextauth]/route.ts:8:13
Type error: Type 'OmitWithTag<typeof import("D:/4 - Coding/Training/NextAuth/next-auth-new/app/api/auth/[...nextauth]/route"), "config" | "generateStaticParams" | "revalidate" | "dynamic" | "dynamicParams" | ... 9 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'.

   6 |
   7 | // Check that the entry is a valid entry
>  8 | checkFields<Diff<{
     |             ^
   9 |   GET?: Function
  10 |   HEAD?: Function
  11 |   OPTIONS?: Function
- info Linting and checking validity of types ...

I have provided the translated content.

英文:

My NextJS 13 app isn't building and is returning a type error but it is completely working on development environment

the type error is shown in this file

import NextAuth, { AuthOptions } from &quot;next-auth&quot;;
import GoogleProvider from &quot;next-auth/providers/google&quot;

export const authOptions: AuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

the file path is app/api/auth/[...nextauth]/route.ts

This is the error message shown in the console ⬇️

.next/types/app/api/auth/[...nextauth]/route.ts:8:13
Type error: Type &#39;OmitWithTag&lt;typeof import(&quot;D:/4 - Coding/Training/NextAuth/next-auth-new/app/api/auth/[...nextauth]/route&quot;), &quot;config&quot; | &quot;generateStaticParams&quot; | &quot;revalidate&quot; | &quot;dynamic&quot; | &quot;dynamicParams&quot; | ... 9 more ... | &quot;PATCH&quot;, &quot;&quot;&gt;&#39; does not satisfy the constraint &#39;{ [x: string]: never; }&#39;.
  Property &#39;authOptions&#39; is incompatible with index signature.
    Type &#39;AuthOptions&#39; is not assignable to type &#39;never&#39;.

   6 |
   7 | // Check that the entry is a valid entry
&gt;  8 | checkFields&lt;Diff&lt;{
     |             ^
   9 |   GET?: Function
  10 |   HEAD?: Function
  11 |   OPTIONS?: Function
- info Linting and checking validity of types ...

I don't know where to start since I'm new to the NextJs front ,
tried to google the error but it isn't returning any relevant answers, bard AI is no help also

答案1

得分: 10

对我来说,问题出在export const authOptions位于route.ts

导入NextAuth和AuthOptions来自"next-auth";
导入GoogleProvider来自"next-auth/providers/google";

/* 你不应该在API route.ts / route.js文件中导出authOptions。
这是错误的原因!! */

export const authOptions: AuthOptions = {
providers: [
GoogleProvider({
clientId: process.env.GOOGLE_ID as string,
clientSecret: process.env.GOOGLE_SECRET as string,
}),
],
}

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

只需分离authOptions文件,然后将authOptions导入到您的[...nextauth]/route.ts中。应该可以正常工作!

参见:https://nextjs.org/docs/app/building-your-application/routing/router-handlers#supported-http-methods (您只能导出HTTP方法)

英文:

For me, The problem came from export const authOptions is in the route.ts

<!-- begin snippet: js hide: false console: true babel: false -->

<!-- language: lang-js -->

import NextAuth, { AuthOptions } from &quot;next-auth&quot;;
import GoogleProvider from &quot;next-auth/providers/google&quot;

/* You shouldn't export authOptions in API route.ts / route.js file.
This is the cause of error!! */

export const authOptions: AuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

<!-- end snippet -->

Just seperate authOptions file then import the authOptions to your [...nextauth]/route.ts. It should works!

See : https://nextjs.org/docs/app/building-your-application/routing/router-handlers#supported-http-methods (You are only allowed to export HTTP Methods)

答案2

得分: 1

I was building an app with NextAuth recently and as I recall they still suggest you using 'pages' folder to handle all api requests. So you can try to:

  1. create pages/api/auth folder in src directory
  2. create file called [...nextauth].ts inside of it
  3. create a file that would hold authOptions somewhere in your project, for example in features/lib
  4. export your options from this file:
    export const authOptions: AuthOptions = {...}
    and import them in your route to consume:
    export default NextAuth(authOptions);

Alternatively, you can configure your Next project to forget about TS errors when building as noted here:

[1]

  typescript: {
    // !! WARN !!
    // Dangerously allow production builds to successfully complete even if
    // your project has type errors.
    // !! WARN !!
    ignoreBuildErrors: true,
  },
}```

Cheers!

[1]: https://github.com/vercel/next.js/blob/canary/docs/api-reference/next.config.js/ignoring-typescript-errors.md

<details>
<summary>英文:</summary>

I was building an app with NextAuth recently and as I recall they still suggest you using &#39;pages&#39; folder to handle all api requests. So you can try to:

1) create pages/api/auth folder in src directory
2) create file called [...nextauth].ts inside of it
3) create a file that would hold authOptions somewhere in your project, for example in features/lib
4) export your options from this file:

export const authOptions: AuthOptions = {...}

and import them in your route to consume:

export default NextAuth(authOptions);


Alternatively, you can configure your Next project to forget about TS errros when building as noted here: 
[1]

module.exports = {
typescript: {
// !! WARN !!
// Dangerously allow production builds to successfully complete even if
// your project has type errors.
// !! WARN !!
ignoreBuildErrors: true,
},
}


Cheers!


  [1]: https://github.com/vercel/next.js/blob/canary/docs/api-reference/next.config.js/ignoring-typescript-errors.md

</details>



# 答案3
**得分**: 1

你在使用NextJS的route.ts文件时,不允许导出任意对象。你只能导出命名为GET、POST、PATCH等的对象。因为你正在导出authOptions,所以构建失败了。

如果你需要在应用的其他部分使用authOptions,你需要将它移动到除了route.ts之外的文件中。如果你不需要在应用的其他部分使用authOptions,只需删除导出语句,然后应该能够构建成功。

<details>
<summary>英文:</summary>

You are not allowed to export any arbitrary object when using a route.ts file in NextJS. You can only export objects named GET, POST, PATCH, etc. Since you are exporting authOptions, the build is failing. 

If you need authOptions in another part of your app, you will need to move into a file other than route.ts. If you don&#39;t need authOptions in another part of your app, just get rid of the export and it should build. 

</details>



# 答案4
**得分**: 1

这对我有用!

将`authOptions`移到不同的文件夹中

```javascript
import { AuthOptions } from "next-auth";
import GoogleProvider from 'next-auth/providers/google';

export const authOptions: AuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

然后导入到route.ts

import { authOptions } from '@/lib/authOptions';

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST }

这是因为你只允许导出HTTP方法(GETHEADPOSTPUTDELETE等)。如果调用不受支持的方法,Next.js 将返回错误。链接到文档

英文:

This worked for me!

Move the authOptions in a different folder

import { AuthOptions } from &quot;next-auth&quot;;
import GoogleProvider from &#39;next-auth/providers/google&#39;;

export const authOptions: AuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

And import into the route.ts

import { authOptions } from &#39;@/lib/authOptions&#39;;

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

This is because you are only allowed to export HTTP Methods (GET, HEAD, POST, PUT, DELETE, etc). If an unsupported method is called, Next.js will return an error. Link to the documentation.

答案5

得分: 0

我认为问题出在你的导入部分,请尝试这样更改:

import { NextAuthOptions } from "next-auth";
import NextAuth from "next-auth/next";    
import GoogleProvider from "next-auth/providers/google"

这意味着将AuthOption更改为NextAuthOptions并将import NextAuth from &quot;next-auth/next&quot;更改为import NextAuth from "next-auth/next";

英文:

i think the problem is your imports try this :

import { NextAuthOptions } from &quot;next-auth&quot;;
import NextAuth from &quot;next-auth/next&quot;;    
import GoogleProvider from &quot;next-auth/providers/google&quot;

export const authOptions: NextAuthOptions = {
    providers: [
        GoogleProvider({
            clientId: process.env.GOOGLE_ID as string,
            clientSecret: process.env.GOOGLE_SECRET as string,
        }),
    ],
}

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST}

so that mean change AuthOption to NextAuthOptions and import NextAuth from &quot;next-auth/next&quot;;

huangapple
  • 本文由 发表于 2023年5月21日 14:04:46
  • 转载请务必保留本文链接:https://go.coder-hub.com/76298505.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定