split warning to a separate file

Author: ThangHuuVu

docs/next.config.js

@@ -72,7 +72,7 @@ export default withNextra({
       {
         source: "/:path(.*)",
         has: [{ type: "host", value: "warnings.authjs.dev" }],
-        destination: "https://authjs.dev/reference/core/errors#warningcode",
+        destination: "https://authjs.dev/reference/core/types#warningcode",
         permanent: true,
       },
       {

docs/package.json

@@ -12,7 +12,7 @@
     "lint": "eslint ./{components,pages,utils}",
     "lint:fix": "eslint ./{components,pages,utils} --fix",
     "build:sitemap": "next-sitemap --config next-sitemap.config.cjs",
-    "clean": "rm -rf .next build pages/reference/**/*.mdx pages/reference/*.mdx"
+    "clean": "rm -rf .next build pages/reference/*.mdx pages/reference/**/*"
   },
   "repository": {
     "type": "git",

docs/typedoc-nextauth.js

@@ -57,7 +57,7 @@ function parseOutput(app) {
     const replaceCodeBlockTitle = (match, p1, p2, p3) => `${p1}filename="${p3}"`
 
     page.contents = page.contents
-      .replace(calloutRegex, replaceCallout)
+      ?.replace(calloutRegex, replaceCallout)
       .replace(codeBlockRegex, replaceCodeBlockTitle)
   })
 }

packages/core/src/errors.ts

@@ -585,24 +585,3 @@ export class ExperimentalFeatureNotEnabled extends AuthError {
   /** @internal */
   static type = "ExperimentalFeatureNotEnabled"
 }
-
-/**
- * - `debug-enabled`: The `debug` option was evaluated to `true`. It adds extra logs in the terminal which is useful in development,
- *   but since it can print sensitive information about users, make sure to set this to `false` in production.
- *   In Node.js environments, you can for example set `debug: process.env.NODE_ENV !== "production"`.
- *   Consult with your runtime/framework on how to set this value correctly.
- * - `csrf-disabled`: You were trying to get a CSRF response from Auth.js (eg.: by calling a `/csrf` endpoint),
- *   but in this setup, CSRF protection via Auth.js was turned off. This is likely if you are not directly using `@auth/core`
- *   but a framework library (like `@auth/sveltekit`) that already has CSRF protection built-in. You likely won't need the CSRF response.
- * - `env-url-basepath-redundant`: `AUTH_URL` (or `NEXTAUTH_URL`) and `authConfig.basePath` are both declared. This is a configuration mistake - you should either remove the `authConfig.basePath` configuration,
- *   or remove the `pathname` of `AUTH_URL` (or `NEXTAUTH_URL`). Only one of them is needed.
- * - `env-url-basepath-mismatch`: `AUTH_URL` (or `NEXTAUTH_URL`) and `authConfig.basePath` are both declared, but they don't match. This is a configuration mistake.
- *   `@auth/core` will use `basePath` to construct the full URL to the corresponding action (/signin, /signout, etc.) in this case.
- * - `experimental-webauthn`: Experimental WebAuthn feature is enabled.
- */
-export type WarningCode =
-  | "debug-enabled"
-  | "csrf-disabled"
-  | "env-url-basepath-redundant"
-  | "env-url-basepath-mismatch"
-  | "experimental-webauthn"

packages/core/src/lib/utils/assert.ts

@@ -15,7 +15,7 @@ import {
 } from "../../errors.js"
 
 import type { RequestInternal, SemverString } from "../../types.js"
-import type { WarningCode } from "../../errors.js"
+import type { WarningCode } from "../../warnings.js"
 import { Adapter } from "../../adapters.js"
 import type { AuthConfig } from "../../index.js"
 

packages/core/src/lib/utils/logger.ts

@@ -1,4 +1,5 @@
-import { AuthError, WarningCode } from "../../errors.js"
+import { AuthError } from "../../errors.js"
+import type { WarningCode } from "../../warnings.js"
 import type { AuthConfig } from "../../index.js"
 
 /**

packages/core/src/types.ts

@@ -58,6 +58,7 @@ import { AuthConfig } from "./index.js"
 import type { JWTOptions } from "./jwt.js"
 import type { Cookie } from "./lib/utils/cookie.js"
 import type { LoggerInstance } from "./lib/utils/logger.js"
+import type { WarningCode } from "./warnings.js"
 import type {
   CredentialsConfig,
   EmailConfig,
@@ -72,7 +73,7 @@ import type {
 
 export type { WebAuthnOptionsResponseBody } from "./lib/utils/webauthn-utils.js"
 export type { AuthConfig } from "./index.js"
-export type { LoggerInstance }
+export type { LoggerInstance, WarningCode }
 export type Awaitable<T> = T | PromiseLike<T>
 export type Awaited<T> = T extends Promise<infer U> ? U : T
 

packages/core/src/warnings.ts

@@ -0,0 +1,21 @@
+/**
+ * - `debug-enabled`: The `debug` option was evaluated to `true`. It adds extra logs in the terminal which is useful in development,
+ *   but since it can print sensitive information about users, make sure to set this to `false` in production.
+ *   In Node.js environments, you can for example set `debug: process.env.NODE_ENV !== "production"`.
+ *   Consult with your runtime/framework on how to set this value correctly.
+ * - `csrf-disabled`: You were trying to get a CSRF response from Auth.js (eg.: by calling a `/csrf` endpoint),
+ *   but in this setup, CSRF protection via Auth.js was turned off. This is likely if you are not directly using `@auth/core`
+ *   but a framework library (like `@auth/sveltekit`) that already has CSRF protection built-in. You likely won't need the CSRF response.
+ * - `env-url-basepath-redundant`: `AUTH_URL` (or `NEXTAUTH_URL`) and `authConfig.basePath` are both declared. This is a configuration mistake - you should either remove the `authConfig.basePath` configuration,
+ *   or remove the `pathname` of `AUTH_URL` (or `NEXTAUTH_URL`). Only one of them is needed.
+ * - `env-url-basepath-mismatch`: `AUTH_URL` (or `NEXTAUTH_URL`) and `authConfig.basePath` are both declared, but they don't match. This is a configuration mistake.
+ *   `@auth/core` will use `basePath` to construct the full URL to the corresponding action (/signin, /signout, etc.) in this case.
+ * - `experimental-webauthn`: Experimental WebAuthn feature is enabled.
+ *
+ */
+export type WarningCode =
+  | "debug-enabled"
+  | "csrf-disabled"
+  | "env-url-basepath-redundant"
+  | "env-url-basepath-mismatch"
+  | "experimental-webauthn"

turbo.json

@@ -127,6 +127,7 @@
         "build/**/*",
         "!.next/cache/**",
         "docs/reference/**/*.mdx",
+        "docs/reference/**/*.js",
         "docs/reference/*.mdx"
       ]
     }