docs: Reapply "docs: exclude inherits, update deps (#12628)" (#12645) (#12690)

* Reapply "docs: exclude inherits, update deps (#12628)" (#12645)

This reverts commit d47bb20.

Author: ThangHuuVu

.gitignore

@@ -32,6 +32,7 @@ packages/next-auth/providers
 # copied from @auth/core
 packages/frameworks-*/**/providers
 packages/*/*.js
+!packages/*/typedoc.config.js
 packages/*/*.d.ts
 packages/*/*.d.ts.map
 packages/*/lib

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",
@@ -49,8 +50,9 @@
     "postcss": "^8.4.47",
     "shiki": "^1.22.0",
     "tailwindcss": "^3.4.13",
-    "typedoc": "^0.25.13",
-    "typedoc-plugin-markdown": "4.0.0-next.54",
-    "typedoc-plugin-mdn-links": "^3.3.2"
+    "typedoc": "^0.27.6",
+    "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

@@ -1,15 +1,15 @@
 // @ts-check
 
-const { MarkdownPageEvent } = require("typedoc-plugin-markdown")
-const path = require("path")
-const fs = require("fs")
+import { MarkdownPageEvent } from "typedoc-plugin-markdown"
+import path from "path"
+import fs from "fs"
 
 /**
  * Local plugin to tweak TypeDoc output for nextra docs
  *
  *  @param {import("typedoc-plugin-markdown").MarkdownApplication} app
  */
-module.exports.load = (app) => {
+export function load(app) {
   injectNextraCalloutImport(app)
   parseOutput(app)
   writeMetaJsFiles(app)
@@ -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.cjs docs/typedoc-nextauth.jsdocs/typedoc-nextauth.cjs renamed to docs/typedoc-nextauth.js

@@ -24,15 +24,16 @@ module.exports = {
   tsconfig: "./tsconfig.json",
   plugin: [
     "typedoc-plugin-markdown",
-    require.resolve("./typedoc-nextauth.cjs"),
+    require.resolve("./typedoc-nextauth.js"),
     "typedoc-plugin-mdn-links",
+    "typedoc-plugin-no-inherit",
   ],
   disableSources: true,
   excludeNotDocumented: true,
   excludeExternals: true,
   excludeInternal: true,
-  excludePrivate: true,
   excludeProtected: true,
+  excludeReferences: true,
   cleanOutputDir: false,
   gitRevision: "main",
   githubPages: false,
@@ -75,8 +76,5 @@ module.exports = {
   expandObjects: true,
   parametersFormat: "table",
   indexFormat: "table",
-  textContentMappings: {
-    "label.packages": "Integrations",
-  },
   useCodeBlocks: true,
 }

docs/typedoc.config.cjs

@@ -2,19 +2,18 @@
  * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
  *  <p>Official <a href="https://kysely.dev/">Kysely</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://kysely.dev/">
- *   <img style={{display: "block"}} src="/img/adapters/kysely.svg" width="38" />
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/kysely.svg" width="30" />
  *  </a>
  * </div>
  *
  * ## Installation
  *
  * ```bash npm2yarn
- * npm install kysely @auth/kysely-adapter
+ * npm install @auth/kysely-adapter kysely
  * ```
  *
  * @module @auth/kysely-adapter
  */
-
 import { Kysely, SqliteAdapter } from "kysely"
 
 import {
@@ -205,6 +204,7 @@ export function KyselyAdapter(db: Kysely<Database>): Adapter {
  * requires. When used with `kysely-codegen`, the `Codegen` type can be passed as
  * the second generic argument. The generated types will be used, and
  * `KyselyAuth` will only verify that the correct fields exist.
+ * @noInheritDoc
  */
 export class KyselyAuth<DB extends T, T = Database> extends Kysely<DB> {}
 

packages/adapter-kysely/src/index.ts

@@ -52,7 +52,7 @@ export interface MongoDBAdapterOptions {
   databaseName?: string
   /**
    * Callback function for managing the closing of the MongoDB client.
-   * This could be useful when `client` is provided as a function returning MongoClient | Promise<MongoClient>.
+   * This could be useful when `client` is provided as a function returning MongoClient.
    * It allows for more customized management of database connections,
    * addressing persistence, container reuse, and connection closure issues.
    */
@@ -115,7 +115,7 @@ export function MongoDBAdapter(
    * - A promise that resolves to a connected `MongoClient` (not recommended).
    * - A function, to handle more complex and custom connection strategies.
    *
-   * Using a function that returns `MongoClient | Promise<MongoClient>`, combined with `options.onClose`, can be useful when you want a more advanced and customized connection strategy to address challenges related to persistence, container reuse, and connection closure.
+   * Using a function combined with `options.onClose`, can be useful when you want a more advanced and customized connection strategy to address challenges related to persistence, container reuse, and connection closure.
    */
   client:
     | MongoClient

packages/adapter-mongodb/src/index.ts

@@ -37,7 +37,7 @@
     "access": "public"
   },
   "scripts": {
-    "clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf *.js *.d.ts*",
+    "clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf index.js *.d.ts*",
     "init:default": "prisma migrate dev --name init --skip-seed",
     "init:custom": "prisma migrate dev --name init-custom --schema ./prisma/custom.prisma",
     "test:default": "pnpm init:default && vitest run -c ../utils/vitest.config.ts",