Skip to content

Commit

Permalink
Revert "docs: exclude inherits, update deps (nextauthjs#12628)" (next…
Browse files Browse the repository at this point in the history
…authjs#12645)

This reverts commit 3287f0b.
  • Loading branch information
ThangHuuVu authored Feb 12, 2025
1 parent 59198d1 commit d47bb20
Show file tree
Hide file tree
Showing 13 changed files with 74 additions and 240 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ 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
Expand Down
7 changes: 3 additions & 4 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,8 @@
"postcss": "^8.4.47",
"shiki": "^1.22.0",
"tailwindcss": "^3.4.13",
"typedoc": "^0.27.6",
"typedoc-plugin-markdown": "4.4.1",
"typedoc-plugin-mdn-links": "4.0.11",
"typedoc-plugin-no-inherit": "^1.5.0"
"typedoc": "^0.25.13",
"typedoc-plugin-markdown": "4.0.0-next.54",
"typedoc-plugin-mdn-links": "^3.3.2"
}
}
8 changes: 4 additions & 4 deletions docs/typedoc-nextauth.js → docs/typedoc-nextauth.cjs
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
// @ts-check

import { MarkdownPageEvent } from "typedoc-plugin-markdown"
import path from "path"
import fs from "fs"
const { MarkdownPageEvent } = require("typedoc-plugin-markdown")
const path = require("path")
const fs = require("fs")

/**
* Local plugin to tweak TypeDoc output for nextra docs
*
* @param {import("typedoc-plugin-markdown").MarkdownApplication} app
*/
export function load(app) {
module.exports.load = (app) => {
injectNextraCalloutImport(app)
parseOutput(app)
writeMetaJsFiles(app)
Expand Down
4 changes: 1 addition & 3 deletions docs/typedoc.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,15 @@ module.exports = {
tsconfig: "./tsconfig.json",
plugin: [
"typedoc-plugin-markdown",
require.resolve("./typedoc-nextauth.js"),
require.resolve("./typedoc-nextauth.cjs"),
"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,
Expand Down
6 changes: 3 additions & 3 deletions packages/adapter-kysely/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@
* <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="https://authjs.dev/img/adapters/kysely.svg" width="30" />
* <img style={{display: "block"}} src="/img/adapters/kysely.svg" width="38" />
* </a>
* </div>
*
* ## Installation
*
* ```bash npm2yarn
* npm install @auth/kysely-adapter kysely
* npm install kysely @auth/kysely-adapter
* ```
*
* @module @auth/kysely-adapter
*/

import { Kysely, SqliteAdapter } from "kysely"

import {
Expand Down Expand Up @@ -204,7 +205,6 @@ 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> {}

Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-mongodb/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* This could be useful when `client` is provided as a function returning MongoClient | Promise<MongoClient>.
* It allows for more customized management of database connections,
* addressing persistence, container reuse, and connection closure issues.
*/
Expand Down Expand Up @@ -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 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 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.
*/
client:
| MongoClient
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-prisma/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"access": "public"
},
"scripts": {
"clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf index.js *.d.ts*",
"clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf *.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",
Expand Down
18 changes: 18 additions & 0 deletions packages/adapter-prisma/typedoc.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// @ts-check

/**
* @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions}
*/
module.exports = {
entryPoints: ["src/index.ts"],
entryPointStrategy: "expand",
tsconfig: "./tsconfig.json",
plugin: [
require.resolve("./../../docs/typedoc-nextauth.cjs"),
"typedoc-plugin-markdown",
],
entryFileName: "../prisma-adapter.mdx",
entryModule: "@auth/prisma-adapter",
includeVersion: true,
readme: 'none'
}
8 changes: 0 additions & 8 deletions packages/adapter-prisma/typedoc.config.js

This file was deleted.

Loading

0 comments on commit d47bb20

Please sign in to comment.