fix(adapter): improve Adapter docs, add runtime assertions (#6877)

* docs(adapters): move dgraph adapters docs to source code

* refactor: review suggestions (1)

* docs(prisma): move content to source code

* chore: sort

* fix: dgraph logo and content

docs/docusaurus.config.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 const fs = require("fs")
 const path = require("path")
 
@@ -11,6 +13,25 @@ const providers = fs
 const typedocConfig = require("./typedoc.json")
 delete typedocConfig.$schema
 
+/**
+ * @param {string} name
+ * @returns Record<string, any>
+ */
+function createTypeDocAdapterConfig(name) {
+  const slug = name.toLowerCase().replace(" ", "-")
+  return {
+    id: slug,
+    plugin: [require.resolve("./typedoc-mdn-links")],
+    watch: process.env.TYPEDOC_WATCH,
+    entryPoints: [`../packages/adapter-${slug}/src/index.ts`],
+    tsconfig: `../packages/adapter-${slug}/tsconfig.json`,
+    out: `reference/adapter/${slug}`,
+    sidebar: {
+      indexLabel: name,
+    },
+  }
+}
+
 /** @type {import("@docusaurus/types").Config} */
 const docusaurusConfig = {
   title: "Auth.js",
@@ -230,30 +251,21 @@ const docusaurusConfig = {
       "docusaurus-plugin-typedoc",
       {
         ...typedocConfig,
-        id: "firebase-adapter",
-        plugin: [require.resolve("./typedoc-mdn-links")],
-        watch: process.env.TYPEDOC_WATCH,
-        entryPoints: ["../packages/adapter-firebase/src/index.ts"],
-        tsconfig: "../packages/adapter-firebase/tsconfig.json",
-        out: "reference/adapter/firebase",
-        sidebar: {
-          indexLabel: "Firebase",
-        },
+        ...createTypeDocAdapterConfig("Firebase"),
       },
     ],
     [
       "docusaurus-plugin-typedoc",
       {
         ...typedocConfig,
-        id: "dgraph-adapter",
-        plugin: [require.resolve("./typedoc-mdn-links")],
-        watch: process.env.TYPEDOC_WATCH,
-        entryPoints: ["../packages/adapter-dgraph/src/index.ts"],
-        tsconfig: "../packages/adapter-dgraph/tsconfig.json",
-        out: "reference/adapter/dgraph",
-        sidebar: {
-          indexLabel: "Dgraph",
-        },
+        ...createTypeDocAdapterConfig("Dgraph"),
+      },
+    ],
+    [
+      "docusaurus-plugin-typedoc",
+      {
+        ...typedocConfig,
+        ...createTypeDocAdapterConfig("Prisma"),
       },
     ],
   ],

docs/sidebars.js

@@ -50,8 +50,9 @@ module.exports = {
       label: "Database Adapters",
       link: { type: "doc", id: "reference/adapters/overview" },
       items: [
-        { type: "doc", id: "reference/adapter/firebase/index" },
         { type: "doc", id: "reference/adapter/dgraph/index" },
+        { type: "doc", id: "reference/adapter/firebase/index" },
+        { type: "doc", id: "reference/adapter/prisma/index" },
         { type: "autogenerated", dirName: "reference/06-adapters" },
       ],
     },

packages/adapter-dgraph/README.md

@@ -5,11 +5,6 @@
    <p align="center">
    Open Source. Full Stack. Own Your Data.
    </p>
-   <!-- <p align="center" style="align: center;">
-      <img src="https://github.com/nextauthjs/next-auth/actions/workflows/release.yml/badge.svg?branch=main" alt="CI Test" />
-      <img src="https://img.shields.io/bundlephobia/minzip/@next-auth/prisma-adapter" alt="Bundle Size"/>
-      <img src="https://img.shields.io/npm/v/@next-auth/prisma-adapter" alt="@next-auth/prisma-adapter Version" />
-   </p> -->
 </p>
 
 ## Overview
@@ -152,7 +147,6 @@ type User
 
 We're open to all community contributions! If you'd like to contribute in any way, please read our [Contributing Guide](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md).
 
-
 ## License
 
 ISC

packages/adapter-dgraph/src/index.ts

@@ -1,6 +1,9 @@
 /**
  * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
- *  <p style={{fontWeight: "normal"}}>Official <a href="https://dgraph.io/">Dgraph</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <p style={{fontWeight: "normal"}}>Official <a href="https://dgraph.io/docs">Dgraph</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <a href="https://dgraph.io/">
+ *   <img style={{display: "block"}} src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/packages/adapter-dgraph/logo.svg" height="30"/>
+ *  </a>
  * </div>
  *
  * ## Installation
@@ -41,7 +44,7 @@ export { format }
 /**
  * ### Basic usage
  *
- * Add this adapter to your `pages/api/[...nextauth].js` next-auth configuration object.
+ * Add this adapter to your `pages/api/[...nextauth].js` next-auth configuration object:
  *
  * ```ts title="pages/api/auth/[...nextauth].js"
  * import NextAuth from "next-auth"