Merge branch 'feat/add-a12n1' of github.com:curveball/next-auth into feat/add-a12n1

Author: usrrname

.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

README.md

@@ -1,3 +1,6 @@
+> [!NOTE]
+> The Auth.js/NextAuth.js project is not provided by, nor otherwise affiliated with Vercel Inc. or its subsidiaries. Any contributions to this project by individuals affiliated with Vercel are made in their personal capacity.
+
 <p align="center">
   <br/>
   <a href="https://authjs.dev" target="_blank"><img width="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
@@ -10,7 +13,7 @@
     <a href="https://github.com/nextauthjs/next-auth/releases"><img src="https://img.shields.io/npm/v/next-auth/beta?style=flat-square&label=latest%20NextAuth.js v5" alt="NPM next-auth@beta release" /></a>
     <!-- TODO: Should count `@auth/core` when NextAuth.js v5 is released as stable. -->
     <a href="https://www.npmtrends.com/next-auth"><img src="https://img.shields.io/npm/dm/next-auth?style=flat-square&color=cyan" alt="Downloads" /></a>
-    <a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
+    <a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="GitHub Stars" /></a>
     <!-- <a href="https://codecov.io/gh/nextauthjs/next-auth" ><img alt="Codecov" src="https://img.shields.io/codecov/c/github/nextauthjs/next-auth?token=o2KN5GrPsY&style=flat-square&logo=codecov"></a> -->
     <img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
   </p>

apps/dev/qwik/README.md

@@ -58,7 +58,7 @@ pnpm preview # or `pnpm preview`
 
 ## Production
 
-The production build will generate client and server modules by running both client and server build commands. The build command will use Typescript to run a type check on the source code.
+The production build will generate client and server modules by running both client and server build commands. The build command will use TypeScript to run a type check on the source code.
 
 ```shell
 pnpm build # or `pnpm build`

apps/examples/qwik/README.md

@@ -58,7 +58,7 @@ pnpm preview # or `pnpm preview`
 
 ## Production
 
-The production build will generate client and server modules by running both client and server build commands. The build command will use Typescript to run a type check on the source code.
+The production build will generate client and server modules by running both client and server build commands. The build command will use TypeScript to run a type check on the source code.
 
 ```shell
 pnpm build # or `pnpm build`

apps/examples/qwik/package.json

@@ -45,7 +45,7 @@
     "typescript": "5.4.5",
     "undici": "*",
     "vercel": "^29.1.1",
-    "vite": "^5.2.10",
+    "vite": "^5.4.12",
     "vite-tsconfig-paths": "^4.2.1"
   }
 }

apps/examples/solid-start/package.json

@@ -14,7 +14,7 @@
     "solid-start-vercel": "^0.2.9",
     "tailwindcss": "^3.2.4",
     "typescript": "5.2.2",
-    "vite": "^3.1.0"
+    "vite": "^4.5.6"
   },
   "dependencies": {
     "@auth/solid-start": "latest",

docs/components/OAuthProviderInstructions/content/components/SetupCode.tsx

@@ -3,12 +3,12 @@ import { Pre, Code as NXCode } from "nextra/components"
 import { TSIcon } from "./TSIcon"
 
 interface Props {
-  providerName: string
+  providerSymbol: string
   providerId: string
   highlight: (code: string) => string
 }
 
-export function SetupCode({ providerId, providerName, highlight }: Props) {
+export function SetupCode({ providerId, providerSymbol, highlight }: Props) {
   return (
     <Code>
       <Code.Next>
@@ -25,10 +25,10 @@ export function SetupCode({ providerId, providerName, highlight }: Props) {
           dangerouslySetInnerHTML={{
             __html: highlight(`
 import NextAuth from "next-auth"
-import ${providerName} from "next-auth/providers/${providerId}"
+import ${providerSymbol} from "next-auth/providers/${providerId}"
  
 export const { handlers, signIn, signOut, auth } = NextAuth({
-  providers: [${providerName}],
+  providers: [${providerSymbol}],
 })`),
           }}
         />
@@ -64,10 +64,10 @@ export const { GET, POST } = handlers
           dangerouslySetInnerHTML={{
             __html: highlight(`
 import { QwikAuth$ } from "@auth/qwik"
-import ${providerName} from "@auth/qwik/providers/${providerId}"
+import ${providerSymbol} from "@auth/qwik/providers/${providerId}"
 
 export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$({
-  providers: [${providerName}],
+  providers: [${providerSymbol}],
 }) `),
           }}
         />
@@ -86,10 +86,10 @@ export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$({
           dangerouslySetInnerHTML={{
             __html: highlight(`
 import { SvelteKitAuth } from "@auth/sveltekit"
-import ${providerName} from "@auth/sveltekit/providers/${providerId}"
+import ${providerSymbol} from "@auth/sveltekit/providers/${providerId}"
  
 export const { handle, signIn } = SvelteKitAuth({
-  providers: [${providerName}],
+  providers: [${providerSymbol}],
 }) `),
           }}
         />
@@ -145,14 +145,14 @@ export const load: LayoutServerLoad = async (event) => {
           dangerouslySetInnerHTML={{
             __html: highlight(`
 import { ExpressAuth } from "@auth/express"
-import ${providerName} from "@auth/express/providers/${providerId}"
+import ${providerSymbol} from "@auth/express/providers/${providerId}"
 import express from "express"
  
 const app = express()
  
 // If app is served through a proxy, trust the proxy to allow HTTPS protocol to be detected
 app.set('trust proxy', true)
-app.use("/auth/*", ExpressAuth({ providers: [ ${providerName} ] }))
+app.use("/auth/*", ExpressAuth({ providers: [ ${providerSymbol} ] }))
 `),
           }}
         />

docs/components/OAuthProviderInstructions/content/index.tsx

@@ -38,6 +38,7 @@ export function OAuthInstructions({ providerId, disabled = false }: Props) {
   }
 
   const providerName = manifest.providersOAuth[providerId]
+  const providerSymbol = providerName.replace(/\s+/g, "")
   const envVars = [
     `AUTH_${providerId.toUpperCase().replace(/-/gi, "_")}_ID={CLIENT_ID}`,
     `AUTH_${providerId.toUpperCase().replace(/-/gi, "_")}_SECRET={CLIENT_SECRET}`,
@@ -205,7 +206,7 @@ export function OAuthInstructions({ providerId, disabled = false }: Props) {
       </p>
       <SetupCode
         providerId={providerId}
-        providerName={providerName}
+        providerSymbol={providerSymbol}
         highlight={highlight}
       />
       {/* Step 4 */}

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/getting-started/adapters/dynamodb.mdx

@@ -161,7 +161,7 @@ app.set("trust proxy", true)
 app.use(
   "/auth/*",
   ExpressAuth({
-    providers: []
+    providers: [],
     adapter: DynamoDBAdapter(client),
   })
 )

docs/pages/getting-started/providers/microsoft-entra-id.mdx

@@ -161,7 +161,7 @@ In `.env.local` create the following entries:
 ```
 AUTH_MICROSOFT_ENTRA_ID_ID=<copy Application (client) ID here>
 AUTH_MICROSOFT_ENTRA_ID_SECRET=<copy generated client secret value here>
-AUTH_MICROSOFT_ENTRA_ID_ISSUER=<copy the issuer here>
+AUTH_MICROSOFT_ENTRA_ID_ISSUER=https://login.microsoftonline.com/<copy the issuer here>/v2.0
 ```
 
 That will default the tenant to use the `common` authorization endpoint. [For more details see here](https://learn.microsoft.com/en-us/entra/identity-platform/v2-protocols#endpoints).

docs/pages/getting-started/providers/postmark.mdx

@@ -27,9 +27,9 @@ If someone provides the email address of an _existing account_ when signing in,
 
 ## Configuration
 
-1. First, you'll need to [add your domain](https://postmark.com/domains) to your Postmark account. This is required by Postmark and this domain of the address you use in the `from` provider option.
+1. First, you'll need to [add your domain](https://account.postmarkapp.com/sign_up) to your Postmark account. This is required by Postmark and this domain of the address you use in the `from` provider option.
 
-2. Next, you will have to generate an API key in the [Postmark Dashboard](https://postmark.com/api-keys). You can save this API key as the `AUTH_POSTMARK_KEY` environment variable.
+2. Next, you will have to generate an API key in the [Postmark Dashboard](https://account.postmarkapp.com/api_tokens). You can save this API key as the `AUTH_POSTMARK_KEY` environment variable.
 
 ```sh
 AUTH_POSTMARK_KEY=abc

docs/pages/getting-started/session-management/get-session.mdx

@@ -205,3 +205,8 @@ app.get("/", (req, res) => {
 </Code>
 
 If you'd like to extend your session with more fields from your OAuth provider, for example, please check out our ["extending the session" guide](/guides/extending-the-session).
+
+<Callout>
+  By default, GET requests to the session endpoint will automatically return the
+  headers to prevent caching.
+</Callout>

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/public/img/providers/clickup.svg docs/public/img/providers/click-up.svg

@@ -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-nextauth.cjs docs/typedoc-nextauth.js

@@ -1,6 +1,6 @@
 {
   "name": "@auth/azure-tables-adapter",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "Azure Tables Storage adapter for next-auth.",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",

docs/typedoc.config.cjs

@@ -1,6 +1,6 @@
 {
   "name": "@auth/d1-adapter",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "A Cloudflare D1 adapter for Auth.js",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",

packages/adapter-azure-tables/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/dgraph-adapter",
-  "version": "2.7.4",
+  "version": "2.8.0",
   "description": "Dgraph adapter for Auth.js",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",

packages/adapter-d1/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/drizzle-adapter",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "Drizzle adapter for Auth.js.",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",

packages/adapter-dgraph/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@auth/dynamodb-adapter",
   "repository": "https://github.com/nextauthjs/next-auth",
-  "version": "2.7.4",
+  "version": "2.8.0",
   "description": "AWS DynamoDB adapter for next-auth.",
   "keywords": [
     "next-auth",