fix: downgrade, split warning to a separate file

fix: downgrade

tryna fix

tryna fix

tryna fix

tryna fix

tryna fix

tryna fix

tryna fix

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/warnings/:path*",
+        destination: "https://authjs.dev/reference/core/types#warningcode",
         permanent: true,
       },
       {

docs/package.json

@@ -11,7 +11,8 @@
     "start": "next start",
     "lint": "eslint ./{components,pages,utils}",
     "lint:fix": "eslint ./{components,pages,utils} --fix",
-    "build:sitemap": "next-sitemap --config next-sitemap.config.cjs"
+    "build:sitemap": "next-sitemap --config next-sitemap.config.cjs",
+    "clean": "rm -rf .next build pages/reference/*.mdx pages/reference/**/*"
   },
   "repository": {
     "type": "git",
@@ -50,7 +51,7 @@
     "shiki": "^1.22.0",
     "tailwindcss": "^3.4.13",
     "typedoc": "^0.27.6",
-    "typedoc-plugin-markdown": "4.4.1",
+    "typedoc-plugin-markdown": "4.3.3",
     "typedoc-plugin-mdn-links": "4.0.11",
     "typedoc-plugin-no-inherit": "^1.5.0"
   }

docs/pages/reference/_meta.js

@@ -10,11 +10,6 @@ export default {
   express: "@auth/express",
   qwik: "@auth/qwik",
   "solid-start": "@auth/solid-start",
-  warnings: "Warnings",
-  errors: {
-    title: "Errors",
-    href: "/reference/core/errors",
-  },
   "--- adapters": {
     type: "separator",
     title: "Adapters",
@@ -33,6 +28,7 @@ export default {
   "mikro-orm-adapter": "@auth/mikro-orm-adapter",
   "mongodb-adapter": "@auth/mongodb-adapter",
   "neo4j-adapter": "@auth/neo4j-adapter",
+  "neon-adapter": "@auth/neon-adapter",
   "pg-adapter": "@auth/pg-adapter",
   "pouchdb-adapter": "@auth/pouchdb-adapter",
   "sequelize-adapter": "@auth/sequelize-adapter",

docs/pages/reference/warnings.mdx

@@ -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)
   })
 }
@@ -82,7 +82,7 @@ function writeMetaJsFiles(app) {
     ) => {
       const pages = defaultValue
       navigationItems.forEach((item) => {
-        const pageKey = item.url ? path.parse(item.url).name : null
+        const pageKey = item.path ? path.parse(item.path).name : null
         if (pageKey) {
           pages[pageKey] = item.title
           if (item?.children && item?.children?.length > 0) {
@@ -101,15 +101,19 @@ function writeMetaJsFiles(app) {
 
       const metaJString = `
 export default ${JSON.stringify(pages, null, 2)}`
+
       if (new RegExp(".*docs/pages/reference$").test(outputDirectory)) return
+
       fs.writeFileSync(path.join(outputDirectory, "_meta.js"), metaJString)
     }
 
     /**
      * Recursively write _meta.js files for each page based on output.navigation
      */
-    writeMetaJs(output.navigation, output.outputDirectory, {
-      overview: "Overview",
-    })
+    if (output.navigation) {
+      writeMetaJs(output.navigation, output.outputDirectory, {
+        overview: "Overview",
+      })
+    }
   })
 }

docs/typedoc-nextauth.js

@@ -32,7 +32,6 @@ module.exports = {
   excludeNotDocumented: true,
   excludeExternals: true,
   excludeInternal: true,
-  excludePrivate: true,
   excludeProtected: true,
   excludeReferences: true,
   cleanOutputDir: false,
@@ -77,8 +76,5 @@ module.exports = {
   expandObjects: true,
   parametersFormat: "table",
   indexFormat: "table",
-  textContentMappings: {
-    "label.packages": "Integrations",
-  },
   useCodeBlocks: true,
 }

docs/typedoc.config.cjs

@@ -3,6 +3,7 @@ export default {
   entryPointStrategy: "expand",
   tsconfig: "./tsconfig.json",
   entryModule: "@auth/prisma-adapter",
+  entryFileName: "../prisma-adapter.mdx",
   includeVersion: true,
   readme: 'none',
 };

packages/adapter-prisma/typedoc.config.js

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

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

@@ -1,13 +1,7 @@
 import { AuthError } from "../../errors.js"
+import type { WarningCode } from "../../warnings.js"
 import type { AuthConfig } from "../../index.js"
 
-export type WarningCode =
-  | "debug-enabled"
-  | "csrf-disabled"
-  | "experimental-webauthn"
-  | "env-url-basepath-redundant"
-  | "env-url-basepath-mismatch"
-
 /**
  * Override any of the methods, and the rest will use the default logger.
  *
@@ -47,7 +41,7 @@ const defaultLogger: LoggerInstance = {
     }
   },
   warn(code) {
-    const url = `https://warnings.authjs.dev#${code}`
+    const url = `https://warnings.authjs.dev`
     console.warn(`${yellow}[auth][warn][${code}]${reset}`, `Read more: ${url}`)
   },
   debug(message, metadata) {

packages/core/src/lib/utils/logger.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/types.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"

packages/core/src/warnings.ts

@@ -70,7 +70,14 @@
         "@auth/qwik#build"
       ],
       "persistent": true,
-      "cache": false
+      "cache": false,
+      "outputs": [
+        ".next/**/*",
+        "build/**/*",
+        "!.next/cache/**",
+        "docs/reference/**/*.mdx",
+        "docs/reference/*.mdx"
+      ]
     },
     "docs#build": {
       "inputs": [
@@ -117,9 +124,11 @@
       ],
       "outputs": [
         ".next/**/*",
+        "build/**/*",
         "!.next/cache/**",
-        "docs/reference/**",
-        "!docs/reference/_meta.js"
+        "docs/reference/**/*.mdx",
+        "docs/reference/**/*.js",
+        "docs/reference/*.mdx"
       ]
     }
   }