Skip to content

Commit d47bb20

Browse files
authored
Revert "docs: exclude inherits, update deps (#12628)" (#12645)
This reverts commit 3287f0b.
1 parent 59198d1 commit d47bb20

File tree

13 files changed

+74
-240
lines changed

13 files changed

+74
-240
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ packages/next-auth/providers
3232
# copied from @auth/core
3333
packages/frameworks-*/**/providers
3434
packages/*/*.js
35-
!packages/*/typedoc.config.js
3635
packages/*/*.d.ts
3736
packages/*/*.d.ts.map
3837
packages/*/lib

docs/package.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@
4949
"postcss": "^8.4.47",
5050
"shiki": "^1.22.0",
5151
"tailwindcss": "^3.4.13",
52-
"typedoc": "^0.27.6",
53-
"typedoc-plugin-markdown": "4.4.1",
54-
"typedoc-plugin-mdn-links": "4.0.11",
55-
"typedoc-plugin-no-inherit": "^1.5.0"
52+
"typedoc": "^0.25.13",
53+
"typedoc-plugin-markdown": "4.0.0-next.54",
54+
"typedoc-plugin-mdn-links": "^3.3.2"
5655
}
5756
}

docs/typedoc-nextauth.js renamed to docs/typedoc-nextauth.cjs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
// @ts-check
22

3-
import { MarkdownPageEvent } from "typedoc-plugin-markdown"
4-
import path from "path"
5-
import fs from "fs"
3+
const { MarkdownPageEvent } = require("typedoc-plugin-markdown")
4+
const path = require("path")
5+
const fs = require("fs")
66

77
/**
88
* Local plugin to tweak TypeDoc output for nextra docs
99
*
1010
* @param {import("typedoc-plugin-markdown").MarkdownApplication} app
1111
*/
12-
export function load(app) {
12+
module.exports.load = (app) => {
1313
injectNextraCalloutImport(app)
1414
parseOutput(app)
1515
writeMetaJsFiles(app)

docs/typedoc.config.cjs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,15 @@ module.exports = {
2424
tsconfig: "./tsconfig.json",
2525
plugin: [
2626
"typedoc-plugin-markdown",
27-
require.resolve("./typedoc-nextauth.js"),
27+
require.resolve("./typedoc-nextauth.cjs"),
2828
"typedoc-plugin-mdn-links",
29-
"typedoc-plugin-no-inherit",
3029
],
3130
disableSources: true,
3231
excludeNotDocumented: true,
3332
excludeExternals: true,
3433
excludeInternal: true,
3534
excludePrivate: true,
3635
excludeProtected: true,
37-
excludeReferences: true,
3836
cleanOutputDir: false,
3937
gitRevision: "main",
4038
githubPages: false,

packages/adapter-kysely/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22
* <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
33
* <p>Official <a href="https://kysely.dev/">Kysely</a> adapter for Auth.js / NextAuth.js.</p>
44
* <a href="https://kysely.dev/">
5-
* <img style={{display: "block"}} src="https://authjs.dev/img/adapters/kysely.svg" width="30" />
5+
* <img style={{display: "block"}} src="/img/adapters/kysely.svg" width="38" />
66
* </a>
77
* </div>
88
*
99
* ## Installation
1010
*
1111
* ```bash npm2yarn
12-
* npm install @auth/kysely-adapter kysely
12+
* npm install kysely @auth/kysely-adapter
1313
* ```
1414
*
1515
* @module @auth/kysely-adapter
1616
*/
17+
1718
import { Kysely, SqliteAdapter } from "kysely"
1819

1920
import {
@@ -204,7 +205,6 @@ export function KyselyAdapter(db: Kysely<Database>): Adapter {
204205
* requires. When used with `kysely-codegen`, the `Codegen` type can be passed as
205206
* the second generic argument. The generated types will be used, and
206207
* `KyselyAuth` will only verify that the correct fields exist.
207-
* @noInheritDoc
208208
*/
209209
export class KyselyAuth<DB extends T, T = Database> extends Kysely<DB> {}
210210

packages/adapter-mongodb/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface MongoDBAdapterOptions {
5252
databaseName?: string
5353
/**
5454
* Callback function for managing the closing of the MongoDB client.
55-
* This could be useful when `client` is provided as a function returning MongoClient.
55+
* This could be useful when `client` is provided as a function returning MongoClient | Promise<MongoClient>.
5656
* It allows for more customized management of database connections,
5757
* addressing persistence, container reuse, and connection closure issues.
5858
*/
@@ -115,7 +115,7 @@ export function MongoDBAdapter(
115115
* - A promise that resolves to a connected `MongoClient` (not recommended).
116116
* - A function, to handle more complex and custom connection strategies.
117117
*
118-
* 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.
118+
* 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.
119119
*/
120120
client:
121121
| MongoClient

packages/adapter-prisma/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"access": "public"
3838
},
3939
"scripts": {
40-
"clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf index.js *.d.ts*",
40+
"clean": "rm ./prisma/dev.db* || echo 'File deleted' && rm -rf *.js *.d.ts*",
4141
"init:default": "prisma migrate dev --name init --skip-seed",
4242
"init:custom": "prisma migrate dev --name init-custom --schema ./prisma/custom.prisma",
4343
"test:default": "pnpm init:default && vitest run -c ../utils/vitest.config.ts",
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// @ts-check
2+
3+
/**
4+
* @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions}
5+
*/
6+
module.exports = {
7+
entryPoints: ["src/index.ts"],
8+
entryPointStrategy: "expand",
9+
tsconfig: "./tsconfig.json",
10+
plugin: [
11+
require.resolve("./../../docs/typedoc-nextauth.cjs"),
12+
"typedoc-plugin-markdown",
13+
],
14+
entryFileName: "../prisma-adapter.mdx",
15+
entryModule: "@auth/prisma-adapter",
16+
includeVersion: true,
17+
readme: 'none'
18+
}

packages/adapter-prisma/typedoc.config.js

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)