Compare commits

...

7 Commits

Author SHA1 Message Date
Balázs Orbán
c8a201a247 Add missing installation requirements 2023-01-01 16:12:41 +01:00
Didi Keke
5586f07480 Add missing DynamoDBClientConfig interface import 2023-01-01 16:09:02 +01:00
Didi Keke
85ccd78977 Add @aws-sdk/client-dynamodb as peer dependency 2023-01-01 16:08:48 +01:00
Thang Vu
77d8f47f51 chore: restore turborepo next-auth#build.outputs 2023-01-01 22:06:50 +07:00
Balázs Orbán
3120d28299 chore: update lockfile 2023-01-01 16:03:09 +01:00
Nico Domino
e6a320bb0f chore(docs): fix homepage logo, build, and lighthouse improvements (#6238)
* chore(docs): fix homepage logo size

* chore(docs): fix sidebars.js solid-start doc path name

* chore(docs): image file and size optimizations

* chore(docs): fix semantic misordered headings

* chore(docs): make banner link more descriptive

* chore(docs): add solid-start redirect
2022-12-31 21:28:59 +01:00
Birk Skyum
7d4d436efe chore(examples): fix broken docs link in solidstart example (#6241) 2022-12-31 21:28:17 +01:00
17 changed files with 81 additions and 27 deletions

View File

@@ -29,7 +29,7 @@ const Home: ParentComponent = () => {
</A>{" "} </A>{" "}
with{" "} with{" "}
<A <A
href="https://authjs.dev/reference/solid-start/modules/main" href="https://authjs.dev/reference/solidstart"
class="text-blue-500 underline font-bold" class="text-blue-500 underline font-bold"
> >
SolidStart Auth SolidStart Auth

View File

@@ -3,7 +3,7 @@ id: dynamodb
title: DynamoDB title: DynamoDB
--- ---
This is the AWS DynamoDB Adapter for next-auth. This package can only be used in conjunction with the primary next-auth package. It is not a standalone package. This is the AWS DynamoDB Adapter for `next-auth`. This package can only be used in conjunction with the primary `next-auth` package. It is not a standalone package.
By default, the adapter expects a table with a partition key `pk` and a sort key `sk`, as well as a global secondary index named `GSI1` with `GSI1PK` as partition key and `GSI1SK` as sorting key. To automatically delete sessions and verification requests after they expire using [dynamodb TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) you should [enable the TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html) with attribute name 'expires'. You can set whatever you want as the table name and the billing method. By default, the adapter expects a table with a partition key `pk` and a sort key `sk`, as well as a global secondary index named `GSI1` with `GSI1PK` as partition key and `GSI1SK` as sorting key. To automatically delete sessions and verification requests after they expire using [dynamodb TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) you should [enable the TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html) with attribute name 'expires'. You can set whatever you want as the table name and the billing method.
@@ -11,10 +11,10 @@ You can find the full schema in the table structure section below.
## Getting Started ## Getting Started
1. Install `next-auth` and `@next-auth/dynamodb-adapter` 1. Install `next-auth`, `@next-auth/dynamodb-adapter`, `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb`
```bash npm2yarn ```bash npm2yarn2pnpm
npm install next-auth @next-auth/dynamodb-adapter npm install next-auth @next-auth/dynamodb-adapter @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb
``` ```
2. Add this adapter to your `pages/api/auth/[...nextauth].js` next-auth configuration object. 2. Add this adapter to your `pages/api/auth/[...nextauth].js` next-auth configuration object.
@@ -23,7 +23,7 @@ You need to pass `DynamoDBDocument` client from the modular [`aws-sdk`](https://
The default table name is `next-auth`, but you can customise that by passing `{ tableName: 'your-table-name' }` as the second parameter in the adapter. The default table name is `next-auth`, but you can customise that by passing `{ tableName: 'your-table-name' }` as the second parameter in the adapter.
```javascript title="pages/api/auth/[...nextauth].js" ```javascript title="pages/api/auth/[...nextauth].js"
import { DynamoDB } from "@aws-sdk/client-dynamodb" import { DynamoDB, DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"
import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb" import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb"
import NextAuth from "next-auth"; import NextAuth from "next-auth";
import Providers from "next-auth/providers"; import Providers from "next-auth/providers";
@@ -73,7 +73,7 @@ The table respects the single table design pattern. This has many advantages:
- Only one table to manage, monitor and provision. - Only one table to manage, monitor and provision.
- Querying relations is faster than with multi-table schemas (for eg. retrieving all sessions for a user). - Querying relations is faster than with multi-table schemas (for eg. retrieving all sessions for a user).
- Only one table needs to be replicated, if you want to go multi-region. - Only one table needs to be replicated if you want to go multi-region.
> This schema is adapted for use in DynamoDB and based upon our main [schema](/reference/adapters/models) > This schema is adapted for use in DynamoDB and based upon our main [schema](/reference/adapters/models)
@@ -94,7 +94,7 @@ new dynamodb.Table(this, `NextAuthTable`, {
}) })
``` ```
Alternatively you can use this cloudformation template: Alternatively, you can use this cloudformation template:
```yaml title=cloudformation.yaml ```yaml title=cloudformation.yaml
NextAuthTable: NextAuthTable:

View File

@@ -46,7 +46,7 @@ const docusaurusConfig = {
title: "Auth.js", title: "Auth.js",
logo: { logo: {
alt: "Auth.js Logo", alt: "Auth.js Logo",
src: "img/logo/logo-xs.png", src: "img/logo/logo-xs.webp",
}, },
items: [ items: [
{ {
@@ -101,7 +101,7 @@ const docusaurusConfig = {
announcementBar: { announcementBar: {
id: "new-major-announcement", id: "new-major-announcement",
content: content:
"<a target='_blank' rel='noopener noreferrer' href='https://next-auth.js.org'>NextAuth.js</a> is becoming Auth.js! 🎉 We're creating Authentication for the Web. Everyone included. Starting with SvelteKit, check out the docs <a href='/reference/sveltekit'>here</a>.", "<a target='_blank' rel='noopener noreferrer' href='https://next-auth.js.org'>NextAuth.js</a> is becoming Auth.js! 🎉 We're creating Authentication for the Web. Everyone included. Starting with SvelteKit, check out <a href='/reference/sveltekit'>the docs</a>.",
backgroundColor: "#000", backgroundColor: "#000",
textColor: "#fff", textColor: "#fff",
}, },
@@ -121,6 +121,7 @@ const docusaurusConfig = {
alt="Powered by Vercel" alt="Powered by Vercel"
style="margin-top: 8px" style="margin-top: 8px"
height="32" height="32"
width="167"
src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/docs/static/img/powered-by-vercel.svg" src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/docs/static/img/powered-by-vercel.svg"
/> />
</a>`, </a>`,
@@ -181,7 +182,10 @@ const docusaurusConfig = {
lastVersion: "current", lastVersion: "current",
showLastUpdateAuthor: true, showLastUpdateAuthor: true,
showLastUpdateTime: true, showLastUpdateTime: true,
remarkPlugins: [require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm, require("remark-github")], remarkPlugins: [
require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm,
require("remark-github"),
],
versions: { versions: {
current: { current: {
label: "experimental", label: "experimental",
@@ -201,7 +205,15 @@ const docusaurusConfig = {
...typedocConfig, ...typedocConfig,
id: "core", id: "core",
plugin: ["./tyepdoc"], 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", tsconfig: "../packages/core/tsconfig.json",
out: "reference/03-core", out: "reference/03-core",
watch: process.env.TYPEDOC_WATCH, watch: process.env.TYPEDOC_WATCH,
@@ -214,7 +226,9 @@ const docusaurusConfig = {
...typedocConfig, ...typedocConfig,
id: "sveltekit", id: "sveltekit",
plugin: ["./tyepdoc"], 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", tsconfig: "../packages/frameworks-sveltekit/tsconfig.json",
out: "reference/04-sveltekit", out: "reference/04-sveltekit",
watch: process.env.TYPEDOC_WATCH, watch: process.env.TYPEDOC_WATCH,

View File

@@ -58,9 +58,9 @@ module.exports = {
label: "@auth/solid-start", label: "@auth/solid-start",
link: { link: {
type: "doc", type: "doc",
id: "reference/solid-start/index", id: "reference/solidstart/index",
}, },
items: ["reference/solid-start/client", "reference/solid-start/protected"], items: ["reference/solidstart/client", "reference/solidstart/protected"],
}, },
{ {
type: "category", type: "category",

View File

@@ -140,19 +140,19 @@ html[data-theme="dark"] hr {
border-radius: 10rem; border-radius: 10rem;
overflow: visible; overflow: visible;
box-shadow: 0 0 2rem rgba(0, 0, 0, 0.1); box-shadow: 0 0 2rem rgba(0, 0, 0, 0.1);
background-image: url("/img/mesh-1.jpg"); background-image: url("/img/mesh-1.webp");
background-size: cover; background-size: cover;
background-origin: center; background-origin: center;
} }
.home-main .section-features .row .col:nth-child(2) .feature-image-wrapper { .home-main .section-features .row .col:nth-child(2) .feature-image-wrapper {
background-image: url("/img/mesh-2.jpg"); background-image: url("/img/mesh-2.webp");
background-size: cover; background-size: cover;
background-origin: center; background-origin: center;
} }
.home-main .section-features .row .col:nth-child(3) .feature-image-wrapper { .home-main .section-features .row .col:nth-child(3) .feature-image-wrapper {
background-image: url("/img/mesh-3.jpg"); background-image: url("/img/mesh-3.webp");
background-size: cover; background-size: cover;
background-origin: center; background-origin: center;
} }

View File

@@ -6,6 +6,11 @@
margin-right: 1rem !important; margin-right: 1rem !important;
} }
.navbar__logo {
width: 29px;
height: 32px;
}
.navbar__title { .navbar__title {
font-size: 1.2rem; font-size: 1.2rem;
margin-left: 0.2rem; margin-left: 0.2rem;

View File

@@ -117,9 +117,11 @@ export default function Home() {
<div className="container"> <div className="container">
<div className="hero-inner"> <div className="hero-inner">
<img <img
src="/img/logo/logo-sm.png" src="/img/logo/logo-sm.webp"
alt="Shield with key icon" alt="Shield with key icon"
className={styles.heroLogo} className={styles.heroLogo}
height="142"
width="128"
/> />
<div className={styles.heroText}> <div className={styles.heroText}>
<h1 className="hero__title">{siteConfig.title}</h1> <h1 className="hero__title">{siteConfig.title}</h1>
@@ -214,9 +216,9 @@ export default function Home() {
<div className="row"> <div className="row">
<div className="col col--6"> <div className="col col--6">
<div className="code"> <div className="code">
<h4 className="code-heading"> <div className="code-heading">
Next.js <span>/pages/api/auth/[...nextauth].ts</span> Next.js <span>/pages/api/auth/[...nextauth].ts</span>
</h4> </div>
<CodeBlock className="prism-code language-js"> <CodeBlock className="prism-code language-js">
{nextJsCode} {nextJsCode}
</CodeBlock> </CodeBlock>
@@ -224,9 +226,9 @@ export default function Home() {
</div> </div>
<div className="col col--6"> <div className="col col--6">
<div className="code"> <div className="code">
<h4 className="code-heading"> <div className="code-heading">
SvelteKit <span>/hooks.server.ts</span> SvelteKit <span>/hooks.server.ts</span>
</h4> </div>
<CodeBlock className="prism-code language-js"> <CodeBlock className="prism-code language-js">
{svelteKitCode} {svelteKitCode}
</CodeBlock> </CodeBlock>
@@ -234,9 +236,9 @@ export default function Home() {
</div> </div>
<div className="col col--6"> <div className="col col--6">
<div className="code"> <div className="code">
<h4 className="code-heading"> <div className="code-heading">
SolidStart <span>/routes/api/auth/[...solidauth].ts</span> SolidStart <span>/routes/api/auth/[...solidauth].ts</span>
</h4> </div>
<CodeBlock className="prism-code language-js"> <CodeBlock className="prism-code language-js">
{solidStartCode} {solidStartCode}
</CodeBlock> </CodeBlock>

BIN
docs/static/img/logo/logo-sm.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

BIN
docs/static/img/logo/logo-xs.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

BIN
docs/static/img/logo/logo.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/static/img/mesh-1.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

BIN
docs/static/img/mesh-2.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/static/img/mesh-3.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View File

@@ -60,6 +60,11 @@
"destination": "https://github.com/nextauthjs/next-auth/discussions/categories/questions", "destination": "https://github.com/nextauthjs/next-auth/discussions/categories/questions",
"permanent": true "permanent": true
}, },
{
"source": "/reference/solid-start/:path*",
"destination": "/reference/solidstart/:path*",
"permanent": true
},
{ {
"source": "/", "source": "/",
"has": [ "has": [

View File

@@ -31,6 +31,7 @@
"author": "Pol Marnette", "author": "Pol Marnette",
"license": "ISC", "license": "ISC",
"peerDependencies": { "peerDependencies": {
"@aws-sdk/client-dynamodb": "^3.36.1",
"@aws-sdk/lib-dynamodb": "^3.36.1", "@aws-sdk/lib-dynamodb": "^3.36.1",
"next-auth": "^4" "next-auth": "^4"
}, },

14
pnpm-lock.yaml generated
View File

@@ -13604,7 +13604,7 @@ packages:
/axios/0.21.4_debug@3.2.7: /axios/0.21.4_debug@3.2.7:
resolution: {integrity: sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==} resolution: {integrity: sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==}
dependencies: dependencies:
follow-redirects: 1.15.1 follow-redirects: 1.15.1_debug@3.2.7
transitivePeerDependencies: transitivePeerDependencies:
- debug - debug
dev: false dev: false
@@ -19295,6 +19295,18 @@ packages:
debug: debug:
optional: true optional: true
/follow-redirects/1.15.1_debug@3.2.7:
resolution: {integrity: sha512-yLAMQs+k0b2m7cVxpS1VKJVvoz7SS9Td1zss3XRwXj+ZDH00RJgnuLx7E44wx02kQLrdM3aOOy+FpzS7+8OizA==}
engines: {node: '>=4.0'}
peerDependencies:
debug: '*'
peerDependenciesMeta:
debug:
optional: true
dependencies:
debug: 3.2.7
dev: false
/follow-redirects/1.15.1_debug@4.3.4: /follow-redirects/1.15.1_debug@4.3.4:
resolution: {integrity: sha512-yLAMQs+k0b2m7cVxpS1VKJVvoz7SS9Td1zss3XRwXj+ZDH00RJgnuLx7E44wx02kQLrdM3aOOy+FpzS7+8OizA==} resolution: {integrity: sha512-yLAMQs+k0b2m7cVxpS1VKJVvoz7SS9Td1zss3XRwXj+ZDH00RJgnuLx7E44wx02kQLrdM3aOOy+FpzS7+8OizA==}
engines: {node: '>=4.0'} engines: {node: '>=4.0'}

View File

@@ -13,7 +13,22 @@
"dependsOn": ["^build"] "dependsOn": ["^build"]
}, },
"next-auth#build": { "next-auth#build": {
"dependsOn": ["^build"] "dependsOn": ["^build"],
"outputs": [
"lib/**",
"css/**",
"jwt/**",
"react/**",
"next/**",
"client/**",
"providers/**",
"core/**",
"index.d.ts",
"index.js",
"adapters.d.ts",
"middleware.d.ts",
"middleware.js"
]
}, },
"clean": { "clean": {
"cache": false "cache": false