autogenerate docs from source

.github/ISSUE_TEMPLATE/3_bug_adapter.yml

@@ -25,7 +25,6 @@ body:
         - "@next-auth/dynamodb-adapter"
         - "@next-auth/fauna-adapter"
         - "@next-auth/firebase-adapter"
-        - "@next-auth/firebase-admin-adapter"
         - "@next-auth/mikro-orm-adapter"
         - "@next-auth/mongodb-adapter"
         - "@next-auth/neo4j-adapter"

.github/issue-labeler.yml

@@ -12,9 +12,6 @@ fauna:
 firebase:
   - "@next-auth/firebase-adapter"
 
-firebase-admin:
-  - "@next-auth/firebase-admin-adapter"
-
 mikro-orm:
   - "@next-auth/mikro-orm-adapter"
 

.gitignore

@@ -99,3 +99,7 @@ packages/frameworks-sveltekit/.svelte-kit
 packages/frameworks-sveltekit/package
 packages/frameworks-sveltekit/vite.config.js.timestamp-*
 packages/frameworks-sveltekit/vite.config.ts.timestamp-*
+
+# Adapters
+
+docs/docs/reference/adapter

docs/docusaurus.config.js

@@ -182,10 +182,7 @@ const docusaurusConfig = {
           lastVersion: "current",
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
-          remarkPlugins: [
-            require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm,
-            require("remark-github"),
-          ],
+          remarkPlugins: [require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm, require("remark-github")],
           versions: {
             current: {
               label: "experimental",
@@ -205,15 +202,7 @@ const docusaurusConfig = {
         ...typedocConfig,
         id: "core",
         plugin: ["./tyepdoc"],
-        entryPoints: [
-          "index.ts",
-          "adapters.ts",
-          "errors.ts",
-          "jwt.ts",
-          "types.ts",
-        ]
-          .map((e) => `${coreSrc}/${e}`)
-          .concat(providers),
+        entryPoints: ["index.ts", "adapters.ts", "errors.ts", "jwt.ts", "types.ts"].map((e) => `${coreSrc}/${e}`).concat(providers),
         tsconfig: "../packages/core/tsconfig.json",
         out: "reference/03-core",
         watch: process.env.TYPEDOC_WATCH,
@@ -226,15 +215,30 @@ const docusaurusConfig = {
         ...typedocConfig,
         id: "sveltekit",
         plugin: ["./tyepdoc"],
-        entryPoints: ["index.ts", "client.ts"].map(
-          (e) => `../packages/frameworks-sveltekit/src/lib/${e}`
-        ),
+        entryPoints: ["index.ts", "client.ts"].map((e) => `../packages/frameworks-sveltekit/src/lib/${e}`),
         tsconfig: "../packages/frameworks-sveltekit/tsconfig.json",
         out: "reference/04-sveltekit",
         watch: process.env.TYPEDOC_WATCH,
         includeExtension: false,
       },
     ],
+    [
+      "docusaurus-plugin-typedoc",
+      {
+        ...typedocConfig,
+        id: "firebase-adapter",
+        plugin: ["./tyepdoc"],
+        entryPoints: ["../packages/adapter-firebase/src/index.ts"],
+        tsconfig: "../packages/adapter-firebase/tsconfig.json",
+        out: "reference/adapter/firebase",
+        watch: process.env.TYPEDOC_WATCH,
+        includeExtension: false,
+        sidebar: {
+          position: 1,
+          indexLabel: "Firebase",
+        },
+      },
+    ],
   ],
 }
 

docs/sidebars.js

@@ -83,6 +83,10 @@ module.exports = {
       label: "Database Adapters",
       link: { type: "doc", id: "reference/adapters/overview" },
       items: [
+        {
+          type: "doc",
+          id: "reference/adapter/firebase/index",
+        },
         {
           type: "autogenerated",
           dirName: "reference/06-adapters",

docs/typedoc.json

@@ -1,7 +1,6 @@
 {
   "excludeNotDocumented": true,
   "$schema": "https://typedoc.org/schema.json",
-  "allReflectionsHaveOwnDocument": true,
   "disableSources": true,
   "hideBreadcrumbs": true,
   "excludeExternals": true,
@@ -17,7 +16,12 @@
     "JsonValue"
   ],
   "readme": "none",
-  "sort": ["kind", "static-first", "required-first", "alphabetical"],
+  "sort": [
+    "kind",
+    "static-first",
+    "required-first",
+    "alphabetical"
+  ],
   "kindSortOrder": [
     "Function",
     "TypeAlias",
@@ -42,4 +46,4 @@
     "GetSignature",
     "SetSignature"
   ]
-}
+}

packages/adapter-firebase/README.md

@@ -15,7 +15,7 @@
 
 ## Overview
 
-This is the Firebase Admin Adapter for [`auth.js`](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` package. It is not a standalone package.
+This is the Firebase Adapter for [`auth.js`](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` package. It is not a standalone package.
 
 You can find more Firebase information in the docs at [authjs.dev/reference/adapters/firebase-admin](https://authjs.dev/reference/adapters/firebase-admin).
 

packages/adapter-firebase/src/index.ts

@@ -1,3 +1,8 @@
+/**
+ *
+ * @module @next-auth/firebase-adapter
+ */
+
 import { firestore } from "firebase-admin"
 
 import type {
@@ -133,6 +138,57 @@ export interface FirestoreAdapterOptions {
   preferSnakeCase?: boolean
 }
 
+/**
+ *
+ * 1. Install the necessary packages
+ *
+ * ```bash npm2yarn2pnpm
+ * npm install next-auth @next-auth/firebase-admin-adapter firebase-admin
+ * ```
+ *
+ * 2. Create a Firebase project and generate a service account key. See [instructions](https://firebase.google.com/docs/admin/setup).
+ *
+ * 3. Add this adapter to your `pages/api/auth/[...nextauth].js` next-auth configuration object.
+ *
+ * ```ts title="pages/api/auth/[...nextauth].js"
+ * import NextAuth from "next-auth"
+ * import GoogleProvider from "next-auth/providers/google"
+ * import { FirestoreAdminAdapter } from "@next-auth/firebase-admin-adapter"
+ *
+ * import admin from "firebase-admin"
+ *
+ * // Initialize the firebase admin app. By default, the firebase admin sdk will
+ * // look for the GOOGLE_APPLICATION_CREDENTIALS environment variable and use
+ * // that to authenticate with the firebase project. See other authentication
+ * // methods here: https://firebase.google.com/docs/admin/setup
+ * const app = admin.initializeApp()
+ *
+ * const firestore = app.firestore()
+ *
+ * // For more information on each option (and a full list of options) go to
+ * // https://authjs.dev/reference/configuration/auth-options
+ * export default NextAuth({
+ *   // https://authjs.dev/reference/providers/
+ *   providers: [
+ *     GoogleProvider({
+ *       clientId: process.env.GOOGLE_ID,
+ *       clientSecret: process.env.GOOGLE_SECRET,
+ *     }),
+ *   ],
+ *   adapter: FirestoreAdminAdapter(firestore),
+ *   ...
+ * })
+ * ```
+ *
+ * ## Naming Conventions
+ *
+ * If mixed snake_case and camelCase field names in the database is an issue for you, you can pass the option `preferSnakeCase: true` to the adapter. This will convert all
+ * fields names and collection names to snake_case e.g. the collection `verificationTokens` will instead be `verification_tokens`, and fields like `emailVerified` will instead be `email_verified`.
+ *
+ * ```ts
+ * FirestoreAdminAdapter(firestore, { preferSnakeCase: true })
+ * ```
+ */
 export function FirestoreAdapter(options: FirestoreAdapterOptions): Adapter {
   const { db, preferSnakeCase = false } = options
   const C = collestionsFactory(db, preferSnakeCase)