Compare commits

..

21 Commits

Author SHA1 Message Date
GitHub Actions
0f4d43e9ad chore(release): bump package version(s) [skip ci] 2023-02-05 13:52:31 +00:00
Thang Vu
28583b8ab0 feat: drop crypto dependency, convert to ESM (#6603)
Co-authored-by: Balázs Orbán <info@balazsorban.com>

BREAKING CHANGE:
- This package now only ships ESM, as all maintained Node.js versions have native support
- Dropped the `crypto` Node.js import in favor of `uuid`. When `globalThis.crypto` is the default in the future, we can remove `uuid` again
2023-02-05 14:44:33 +01:00
Balázs Orbán
1e7538a955 fix: publish .d.ts.map, add experimental warning 2023-02-05 14:42:07 +01:00
Wyatt Ades
4258857e52 feat(adapters): move to firebase-admin in Firebase Adapter (#6225)
Co-authored-by: Balázs Orbán <info@balazsorban.com>
fixes https://github.com/nextauthjs/next-auth/issues/5049
closes https://github.com/nextauthjs/next-auth/pull/6230
closes https://github.com/nextauthjs/next-auth/pull/5449
closes https://github.com/nextauthjs/next-auth/pull/5055
fixes https://github.com/nextauthjs/next-auth/issues/4927

BREAKING CHANGE:
The adapter now expects `firebase-admin` instead of the `firebase` package and also supports either passing a config object or a firestore instance.
2023-02-05 14:41:20 +01:00
Balázs Orbán
e9d8805609 docs: api reference restructure (#6608) 2023-02-04 15:39:12 +01:00
Mayvis
fb43c5da05 docs: enhance prisma mongodb doc to prevent warning (#6598)
Fixes https://github.com/nextauthjs/next-auth/issues/6597
2023-02-02 13:28:17 +01:00
Corey Jepperson
326eadf0ed fix: don't add /error to url pathname when email verification is successful (#6492)
fix handleAuthorized making bad pth when authorize

Co-authored-by: Corey Jepperson <corey@entropy.cc>
Co-authored-by: Thang Vu <hi@thvu.dev>
2023-01-31 17:37:38 +07:00
Thang Vu
a5e0db4bb3 feat(providers): add Notion provider (#6567)
* add notion provider along with logo and styles
"

* adjust notion documentation

* update issue template with Notion provider

* update docs and provider with code from TomYeoman

* feat: move Notion provider to core

* get it working

---------

Co-authored-by: Harrison Broadbent <harrisonbroadbent@gmail.com>
Co-authored-by: Harrison Broadbent <harrisonbroadbent@Harrisons-MacBook-Air.local>
Co-authored-by: Thang Vu <hi@thvu.dev>
2023-01-31 17:10:47 +07:00
Balázs Orbán
334e23343a chore: fix typo 2023-01-31 01:19:16 +01:00
OrJDev
be046a6cb2 chore: suggest using the correct command to seek for packages (#6570)
* fix: suggest using the correct command to seek for packages

* seek for adapter packages aswell

* cleanup: seek for auth org packages
2023-01-30 20:39:37 +01:00
Frank Dumont
bdee262abe fix: typo in log message (#6569) 2023-01-30 20:37:53 +01:00
Balázs Orbán
3f89e668ec fix(ts): mark options provider config option internal (#6564)
* chore(dev): use workspace modules in Svelte app

* fix(ts): mark `options` provider config option internal
2023-01-30 12:34:54 +00:00
Balázs Orbán
533320eb94 chore: generate oauth-types on build 2023-01-29 14:33:41 +01:00
James
dfe6509472 fix: comment Discord profile, fix @auth/sveltekit build on Windows (#6550)
* fix: discord types were inaccurate

* fix: build on windows computers

* Apply review suggestions

* Update discord.ts

---------

Co-authored-by: Balázs Orbán <info@balazsorban.com>
2023-01-29 12:05:14 +00:00
Oskar
1bde7cc8df fix(core): correct docs link (#6446) 2023-01-26 12:16:47 +00:00
Balázs Orbán
cef05d5e2d Merge branch 'main' of github.com:nextauthjs/next-auth 2023-01-26 13:11:14 +01:00
Balázs Orbán
c0dea283ba fix(core): avoid circular dependency
Fixes #6508
2023-01-26 13:11:04 +01:00
Balázs Orbán
0204766e0f fix(core): don't lock nodemailer version as peer dependency 2023-01-25 14:29:16 +00:00
Jérémie Sellam
a336ba762c fix(adapters): allow already initialized firebase app 🐛 (#6230)
* 🐛 Fix already initialized firebase app

* remove comment

Co-authored-by: Jérémie Sellam <jeremie@southpigalle.io>
Co-authored-by: Thang Vu <hi@thvu.dev>
2023-01-25 19:57:52 +07:00
Balázs Orbán
681d53c2f8 chore(core): cleanup 2023-01-24 14:01:40 +01:00
Thang Vu
06e891c0ea chore: cache output for @auth/sveltekit 2023-01-24 15:22:42 +07:00
65 changed files with 3435 additions and 2847 deletions

View File

@@ -23,8 +23,8 @@ pnpm-lock.yaml
.docusaurus .docusaurus
build build
docs/docs/reference/03-core docs/docs/reference/core
docs/docs/reference/04-sveltekit docs/docs/reference/sveltekit
static static
# --------------- Packages --------------- # --------------- Packages ---------------

View File

@@ -30,7 +30,7 @@ body:
Run this command in your project's root folder and paste the result: Run this command in your project's root folder and paste the result:
```sh ```sh
npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth" npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth,@auth/*"
``` ```
Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using. Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using.
validations: validations:

View File

@@ -58,6 +58,7 @@ body:
- "Medium" - "Medium"
- "Naver" - "Naver"
- "Netlify" - "Netlify"
- "Notion"
- "Okta" - "Okta"
- "OneLogin" - "OneLogin"
- "Osso" - "Osso"
@@ -88,7 +89,7 @@ body:
Run this command in your project's root folder and paste the result: Run this command in your project's root folder and paste the result:
```sh ```sh
npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth" npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth,@auth/*"
``` ```
Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using. Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using.
validations: validations:

View File

@@ -44,7 +44,7 @@ body:
Run this command in your project's root folder and paste the result: Run this command in your project's root folder and paste the result:
```sh ```sh
npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth" && npx envinfo --npmPackages "@next-auth/*" npx envinfo --system --binaries --browsers --npmPackages "next,react,next-auth,@auth/*" && npx envinfo --npmPackages "@next-auth/*"
``` ```
Alternatively, if the above command did not work, we need the version of the following packages from your package.json: "next", "react", "next-auth" and your adapter. Please also mention your OS and Node.js version, as well as the browser you are using. Alternatively, if the above command did not work, we need the version of the following packages from your package.json: "next", "react", "next-auth" and your adapter. Please also mention your OS and Node.js version, as well as the browser you are using.
validations: validations:

22
.gitignore vendored
View File

@@ -12,6 +12,7 @@ npm-debug.log*
yarn-debug.log* yarn-debug.log*
yarn-error.log* yarn-error.log*
firebase-debug.log firebase-debug.log
ui-debug.log
.pnpm-debug.log .pnpm-debug.log
@@ -34,13 +35,10 @@ packages/next-auth/utils
packages/next-auth/core packages/next-auth/core
packages/next-auth/jwt packages/next-auth/jwt
packages/next-auth/react packages/next-auth/react
packages/next-auth/adapters.d.ts
packages/next-auth/adapters.js
packages/next-auth/index.d.ts
packages/next-auth/index.js
packages/next-auth/next packages/next-auth/next
packages/next-auth/middleware.d.ts packages/*/*.js
packages/next-auth/middleware.js packages/*/*.d.ts
packages/*/*.d.ts.map
# Development app # Development app
apps/dev/src/css apps/dev/src/css
@@ -81,14 +79,12 @@ docs/.docusaurus
docs/providers.json docs/providers.json
# Core # Core
packages/core/*.js packages/core/src/providers/oauth-types.ts
packages/core/*.d.ts
packages/core/*.d.ts.map
packages/core/lib packages/core/lib
packages/core/providers packages/core/providers
packages/core/src/lib/pages/styles.ts packages/core/src/lib/pages/styles.ts
docs/docs/reference/03-core docs/docs/reference/core
docs/docs/reference/04-sveltekit docs/docs/reference/sveltekit
# SvelteKit # SvelteKit
@@ -98,3 +94,7 @@ packages/frameworks-sveltekit/.svelte-kit
packages/frameworks-sveltekit/package packages/frameworks-sveltekit/package
packages/frameworks-sveltekit/vite.config.js.timestamp-* packages/frameworks-sveltekit/vite.config.js.timestamp-*
packages/frameworks-sveltekit/vite.config.ts.timestamp-* packages/frameworks-sveltekit/vite.config.ts.timestamp-*
# Adapters
docs/docs/reference/adapter

View File

@@ -20,8 +20,8 @@ pnpm-lock.yaml
.docusaurus .docusaurus
build build
docs/docs/reference/03-core docs/docs/reference/core
docs/docs/reference/04-sveltekit docs/docs/reference/sveltekit
static static
docs/providers.json docs/providers.json

View File

@@ -21,6 +21,10 @@ KEYCLOAK_ID=
KEYCLOAK_SECRET= KEYCLOAK_SECRET=
KEYCLOAK_ISSUER= KEYCLOAK_ISSUER=
NOTION_ID=
NOTION_SECRET=
NOTION_REDIRECT_URI=
IDS4_ID= IDS4_ID=
IDS4_SECRET= IDS4_SECRET=
IDS4_ISSUER= IDS4_ISSUER=

View File

@@ -24,6 +24,7 @@ import Instagram from "@auth/core/providers/instagram"
import Line from "@auth/core/providers/line" import Line from "@auth/core/providers/line"
import LinkedIn from "@auth/core/providers/linkedin" import LinkedIn from "@auth/core/providers/linkedin"
import Mailchimp from "@auth/core/providers/mailchimp" import Mailchimp from "@auth/core/providers/mailchimp"
import Notion from "@auth/core/providers/notion"
// import Okta from "@auth/core/providers/okta" // import Okta from "@auth/core/providers/okta"
import Osu from "@auth/core/providers/osu" import Osu from "@auth/core/providers/osu"
import Patreon from "@auth/core/providers/patreon" import Patreon from "@auth/core/providers/patreon"
@@ -69,7 +70,7 @@ import WorkOS from "@auth/core/providers/workos"
export const authConfig: AuthConfig = { export const authConfig: AuthConfig = {
// adapter, // adapter,
// debug: process.env.NODE_ENV !== "production", debug: process.env.NODE_ENV !== "production",
theme: { theme: {
logo: "https://next-auth.js.org/img/logo/logo-sm.png", logo: "https://next-auth.js.org/img/logo/logo-sm.png",
brandColor: "#1786fb", brandColor: "#1786fb",
@@ -107,6 +108,7 @@ export const authConfig: AuthConfig = {
Line({ clientId: process.env.LINE_ID, clientSecret: process.env.LINE_SECRET }), Line({ clientId: process.env.LINE_ID, clientSecret: process.env.LINE_SECRET }),
LinkedIn({ clientId: process.env.LINKEDIN_ID, clientSecret: process.env.LINKEDIN_SECRET }), LinkedIn({ clientId: process.env.LINKEDIN_ID, clientSecret: process.env.LINKEDIN_SECRET }),
Mailchimp({ clientId: process.env.MAILCHIMP_ID, clientSecret: process.env.MAILCHIMP_SECRET }), Mailchimp({ clientId: process.env.MAILCHIMP_ID, clientSecret: process.env.MAILCHIMP_SECRET }),
Notion({ clientId: process.env.NOTION_ID, clientSecret: process.env.NOTION_SECRET, redirectUri: process.env.NOTION_REDIRECT_URI }),
// Okta({ clientId: process.env.OKTA_ID, clientSecret: process.env.OKTA_SECRET, issuer: process.env.OKTA_ISSUER }), // Okta({ clientId: process.env.OKTA_ID, clientSecret: process.env.OKTA_SECRET, issuer: process.env.OKTA_ISSUER }),
Osu({ clientId: process.env.OSU_CLIENT_ID, clientSecret: process.env.OSU_CLIENT_SECRET }), Osu({ clientId: process.env.OSU_CLIENT_ID, clientSecret: process.env.OSU_CLIENT_SECRET }),
Patreon({ clientId: process.env.PATREON_ID, clientSecret: process.env.PATREON_SECRET }), Patreon({ clientId: process.env.PATREON_ID, clientSecret: process.env.PATREON_SECRET }),

View File

@@ -19,8 +19,8 @@
"vite": "4.0.1" "vite": "4.0.1"
}, },
"dependencies": { "dependencies": {
"@auth/core": "0.2.5", "@auth/core": "workspace:*",
"@auth/sveltekit": "0.1.12" "@auth/sveltekit": "workspace:*"
}, },
"type": "module" "type": "module"
} }

View File

@@ -2,11 +2,10 @@
"name": "playground-nuxt", "name": "playground-nuxt",
"private": true, "private": true,
"scripts": { "scripts": {
"build": "nuxt build", "build": "nuxt prepare && nuxt build",
"dev": "export NODE_OPTIONS='--no-experimental-fetch' && nuxt dev", "dev": "nuxt prepare && export NODE_OPTIONS='--no-experimental-fetch' && nuxt dev",
"generate": "nuxt generate", "generate": "nuxt generate",
"preview": "nuxt preview", "preview": "nuxt preview"
"postinstall": "nuxt prepare"
}, },
"devDependencies": { "devDependencies": {
"@nuxt/eslint-config": "^0.1.1", "@nuxt/eslint-config": "^0.1.1",

View File

@@ -22,7 +22,7 @@ Using a JWT to store the `refresh_token` is less secure than saving it in a data
#### JWT strategy #### JWT strategy
Using the [jwt](../../reference/03-core/interfaces/types.CallbacksOptions.md#jwt) and [session](../../reference/03-core/interfaces/types.CallbacksOptions.md#session) callbacks, we can persist OAuth tokens and refresh them when they expire. Using the [jwt](../../reference/core/types#jwt) and [session](../../reference/core/types#session) callbacks, we can persist OAuth tokens and refresh them when they expire.
Below is a sample implementation using Google's Identity Provider. Please note that the OAuth 2.0 request in the `refreshAccessToken()` function will vary between different providers, but the core logic should remain similar. Below is a sample implementation using Google's Identity Provider. Please note that the OAuth 2.0 request in the `refreshAccessToken()` function will vary between different providers, but the core logic should remain similar.

View File

@@ -1,75 +0,0 @@
---
id: firebase
title: Firebase
---
:::warning
This adapter is still experimental and does not work with Auth.js 4 or newer. If you would like to help out upgrading it, please visit [this PR](https://github.com/nextauthjs/next-auth/pull/3873)
:::
This is the Firebase Adapter for [`next-auth`](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` package. It is not a standalone package.
## Getting Started
1. Install the necessary packages
```bash npm2yarn
npm install next-auth @next-auth/firebase-adapter@experimental
```
2. Add this adapter to your `pages/api/auth/[...nextauth].js` next-auth configuration object.
```javascript title="pages/api/auth/[...nextauth].js"
import NextAuth from "next-auth"
import GoogleProvider from "next-auth/providers/google"
import { FirebaseAdapter } from "@next-auth/firebase-adapter"
import firebase from "firebase/app"
import "firebase/firestore"
const firestore = (
firebase.apps[0] ?? firebase.initializeApp(/* your config */)
).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: FirebaseAdapter(firestore),
...
})
```
## Options
When initializing the firestore adapter, you must pass in the firebase config object with the details from your project. More details on how to obtain that config object can be found [here](https://support.google.com/firebase/answer/7015592).
An example firebase config looks like this:
```js
const firebaseConfig = {
apiKey: "AIzaSyDOCAbC123dEf456GhI789jKl01-MnO",
authDomain: "myapp-project-123.firebaseapp.com",
databaseURL: "https://myapp-project-123.firebaseio.com",
projectId: "myapp-project-123",
storageBucket: "myapp-project-123.appspot.com",
messagingSenderId: "65211879809",
appId: "1:65211879909:web:3ae38ef1cdcb2e01fe5f0c",
measurementId: "G-8GSGZQ44ST",
}
```
See [firebase.google.com/docs/web/setup](https://firebase.google.com/docs/web/setup) for more details.
:::tip **From Firebase**
**Caution**: We do not recommend manually modifying an app's Firebase config file or object. If you initialize an app with invalid or missing values for any of these required "Firebase options", then your end users may experience serious issues.
For open source projects, we generally do not recommend including the app's Firebase config file or object in source control because, in most cases, your users should create their own Firebase projects and point their apps to their own Firebase resources (via their own Firebase config file or object).
:::

View File

@@ -139,9 +139,10 @@ Prisma supports MongoDB, and so does Auth.js. Following the instructions of the
id String @id @default(auto()) @map("_id") @db.ObjectId id String @id @default(auto()) @map("_id") @db.ObjectId
``` ```
2. The Native database type attribute to `@db.String` from `@db.Text`. 2. The Native database type attribute to `@db.String` from `@db.Text` and userId to `@db.ObjectId`.
```prisma ```prisma
user_id String @db.ObjectId
refresh_token String? @db.String refresh_token String? @db.String
access_token String? @db.String access_token String? @db.String
id_token String? @db.String id_token String? @db.String

View File

@@ -1,25 +0,0 @@
---
title: Overview
sidebar_label: Overview
sidebar_position: 0
---
## Core
## Providers
- OAuth/OIDC
- Email/Passwordless
- Credentials
## Database Adapters
## Frameworks
- Next.js
- SvelteKit
- SolidStart
- Remix
- Nuxt
- Gatsby
- etc.

View File

@@ -62,7 +62,7 @@ const docusaurusConfig = {
position: "left", position: "left",
}, },
{ {
to: "/reference/core/modules/main", to: "/reference/core",
// TODO: change to this when the overview page looks better. // TODO: change to this when the overview page looks better.
// to: "/reference", // to: "/reference",
activeBasePath: "/reference", activeBasePath: "/reference",
@@ -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 <a href='/reference/sveltekit'>the docs</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>. Note, this site is under active development.",
backgroundColor: "#000", backgroundColor: "#000",
textColor: "#fff", textColor: "#fff",
}, },
@@ -182,10 +182,7 @@ const docusaurusConfig = {
lastVersion: "current", lastVersion: "current",
showLastUpdateAuthor: true, showLastUpdateAuthor: true,
showLastUpdateTime: true, showLastUpdateTime: true,
remarkPlugins: [ remarkPlugins: [require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm],
require("@sapphire/docusaurus-plugin-npm2yarn2pnpm").npm2yarn2pnpm,
require("remark-github"),
],
versions: { versions: {
current: { current: {
label: "experimental", label: "experimental",
@@ -204,20 +201,14 @@ const docusaurusConfig = {
{ {
...typedocConfig, ...typedocConfig,
id: "core", id: "core",
plugin: ["./tyepdoc"], plugin: [require.resolve("./typedoc-mdn-links")],
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, watch: process.env.TYPEDOC_WATCH,
includeExtension: false, entryPoints: ["index.ts", "adapters.ts", "errors.ts", "jwt.ts", "types.ts"].map((e) => `${coreSrc}/${e}`).concat(providers),
tsconfig: "../packages/core/tsconfig.json",
out: "reference/core",
sidebar: {
indexLabel: "index",
},
}, },
], ],
[ [
@@ -225,14 +216,29 @@ const docusaurusConfig = {
{ {
...typedocConfig, ...typedocConfig,
id: "sveltekit", id: "sveltekit",
plugin: ["./tyepdoc"], plugin: [require.resolve("./typedoc-mdn-links")],
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, watch: process.env.TYPEDOC_WATCH,
includeExtension: false, entryPoints: ["index.ts", "client.ts"].map((e) => `../packages/frameworks-sveltekit/src/lib/${e}`),
tsconfig: "../packages/frameworks-sveltekit/tsconfig.json",
out: "reference/sveltekit",
sidebar: {
indexLabel: "index",
},
},
],
[
"docusaurus-plugin-typedoc",
{
...typedocConfig,
id: "firebase-adapter",
plugin: [require.resolve("./typedoc-mdn-links")],
watch: process.env.TYPEDOC_WATCH,
entryPoints: ["../packages/adapter-firebase/src/index.ts"],
tsconfig: "../packages/adapter-firebase/tsconfig.json",
out: "reference/adapter/firebase",
sidebar: {
indexLabel: "Firebase",
},
}, },
], ],
], ],

View File

@@ -3,7 +3,7 @@
"repository": "https://github.com/nextauthjs/next-auth", "repository": "https://github.com/nextauthjs/next-auth",
"name": "docs", "name": "docs",
"scripts": { "scripts": {
"start": "TYPEDOC_WATCH=true docusaurus start --no-open --port 8000", "start": "TYPEDOC_WATCH=true docusaurus start --no-open",
"dev": "pnpm providers && pnpm snippets && pnpm start", "dev": "pnpm providers && pnpm snippets && pnpm start",
"build": "pnpm providers && docusaurus build", "build": "pnpm providers && docusaurus build",
"docusaurus": "docusaurus", "docusaurus": "docusaurus",
@@ -27,7 +27,6 @@
"react": "^18.2.0", "react": "^18.2.0",
"react-dom": "^18.2.0", "react-dom": "^18.2.0",
"react-marquee-slider": "^1.1.5", "react-marquee-slider": "^1.1.5",
"remark-github": "10.1.0",
"styled-components": "5.3.6" "styled-components": "5.3.6"
}, },
"devDependencies": { "devDependencies": {
@@ -37,7 +36,9 @@
"@docusaurus/preset-classic": "2.2.0", "@docusaurus/preset-classic": "2.2.0",
"@docusaurus/theme-common": "2.2.0", "@docusaurus/theme-common": "2.2.0",
"@docusaurus/types": "2.2.0", "@docusaurus/types": "2.2.0",
"docusaurus-plugin-typedoc": "^0.18.0" "docusaurus-plugin-typedoc": "1.0.0-next.2",
"typedoc": "^0.23.24",
"typedoc-plugin-markdown": "4.0.0-next.2"
}, },
"browserslist": { "browserslist": {
"production": [ "production": [

View File

@@ -14,61 +14,28 @@ module.exports = {
}, },
], ],
referenceSidebar: [ referenceSidebar: [
"reference/index",
{ {
type: "category", type: "category",
label: "@auth/core", label: "@auth/core",
link: { link: { type: "doc", id: "reference/core/index" },
type: "doc", items: [{ type: "autogenerated", dirName: "reference/core" }],
id: "reference/core/modules/main",
},
items: [
{
type: "autogenerated",
dirName: "reference/03-core/modules",
// See: https://github.com/facebook/docusaurus/issues/5689
// exclude: ["index"],
},
{
type: "category",
label: "Reflections",
collapsed: true,
className: "reflection-category", // See src/index.css
items: [{ type: "autogenerated", dirName: "reference/03-core" }],
},
],
}, },
{ {
type: "category", type: "category",
label: "@auth/sveltekit", label: "@auth/sveltekit",
link: { type: "doc", id: "reference/sveltekit/modules/main" }, link: { type: "doc", id: "reference/sveltekit/index" },
items: [ items: [{ type: "autogenerated", dirName: "reference/sveltekit" }],
{ type: "autogenerated", dirName: "reference/04-sveltekit/modules" },
{
type: "category",
label: "Reflections",
collapsed: true,
className: "reflection-category", // See src/index.css
items: [{ type: "autogenerated", dirName: "reference/04-sveltekit" }],
},
],
}, },
{ {
type: "category", type: "category",
label: "@auth/solid-start", label: "@auth/solid-start",
link: { link: { type: "doc", id: "reference/solidstart/index" },
type: "doc", items: [{ type: "autogenerated", dirName: "reference/04-solidstart" }],
id: "reference/solidstart/index",
},
items: ["reference/solidstart/client", "reference/solidstart/protected"],
}, },
{ {
type: "category", type: "category",
label: "@auth/nextjs", label: "@auth/nextjs",
link: { link: { type: "doc", id: "reference/nextjs/index" },
type: "doc",
id: "reference/nextjs/index",
},
items: [ items: [
"reference/nextjs/client", "reference/nextjs/client",
{ {
@@ -83,12 +50,8 @@ module.exports = {
label: "Database Adapters", label: "Database Adapters",
link: { type: "doc", id: "reference/adapters/overview" }, link: { type: "doc", id: "reference/adapters/overview" },
items: [ items: [
{ { type: "doc", id: "reference/adapter/firebase/index" },
type: "autogenerated", { type: "autogenerated", dirName: "reference/06-adapters" },
dirName: "reference/06-adapters",
// See: https://github.com/facebook/docusaurus/issues/5689
// exclude: ["index"],
},
], ],
}, },
{ {

View File

@@ -273,26 +273,3 @@ html[data-theme="dark"] #carbonads .carbon-poweredby {
color: #aaa; color: #aaa;
background: #1e2021; background: #1e2021;
} }
/*
This is a hack to hide the "Reflection" category and "main" module from the sidebar.
This is because:
1. opening any page under the "Reflection" category would hide the entire sidebar.
2. the "main" module would show up twice.
See sidebars.js
*/
.reflection-category,
.theme-doc-sidebar-item-link-level-2 [href="/reference/core/modules/main"],
.theme-doc-sidebar-item-link-level-2
[href="/reference/sveltekit/modules/main"] {
display: none;
}
/*
HACK: to hide the "Classes" header and duplicate items together with the "typedoc-plugin-markdown" patch.
See: https://github.com/TypeStrong/typedoc/issues/2006
*/
/* h3.anchor + p:has(code, strong), */ /** hack did not work as it hides property types elsewhere */
#classes {
display: none;
}

5
docs/static/img/providers/notion.svg vendored Normal file
View File

@@ -0,0 +1,5 @@
<svg width="32" height="32" viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg">
<title>Notion icon</title>
<path d="M6.017 4.313l55.333 -4.087c6.797 -0.583 8.543 -0.19 12.817 2.917l17.663 12.443c2.913 2.14 3.883 2.723 3.883 5.053v68.243c0 4.277 -1.553 6.807 -6.99 7.193L24.467 99.967c-4.08 0.193 -6.023 -0.39 -8.16 -3.113L3.3 79.94c-2.333 -3.113 -3.3 -5.443 -3.3 -8.167V11.113c0 -3.497 1.553 -6.413 6.017 -6.8z" fill="#fff"/>
<path fill-rule="evenodd" clip-rule="evenodd" d="M61.35 0.227l-55.333 4.087C1.553 4.7 0 7.617 0 11.113v60.66c0 2.723 0.967 5.053 3.3 8.167l13.007 16.913c2.137 2.723 4.08 3.307 8.16 3.113l64.257 -3.89c5.433 -0.387 6.99 -2.917 6.99 -7.193V20.64c0 -2.21 -0.873 -2.847 -3.443 -4.733L74.167 3.143c-4.273 -3.107 -6.02 -3.5 -12.817 -2.917zM25.92 19.523c-5.247 0.353 -6.437 0.433 -9.417 -1.99L8.927 11.507c-0.77 -0.78 -0.383 -1.753 1.557 -1.947l53.193 -3.887c4.467 -0.39 6.793 1.167 8.54 2.527l9.123 6.61c0.39 0.197 1.36 1.36 0.193 1.36l-54.933 3.307 -0.68 0.047zM19.803 88.3V30.367c0 -2.53 0.777 -3.697 3.103 -3.893L86 22.78c2.14 -0.193 3.107 1.167 3.107 3.693v57.547c0 2.53 -0.39 4.67 -3.883 4.863l-60.377 3.5c-3.493 0.193 -5.043 -0.97 -5.043 -4.083zm59.6 -54.827c0.387 1.75 0 3.5 -1.75 3.7l-2.91 0.577v42.773c-2.527 1.36 -4.853 2.137 -6.797 2.137 -3.107 0 -3.883 -0.973 -6.21 -3.887l-19.03 -29.94v28.967l6.02 1.363s0 3.5 -4.857 3.5l-13.39 0.777c-0.39 -0.78 0 -2.723 1.357 -3.11l3.497 -0.97v-38.3L30.48 40.667c-0.39 -1.75 0.58 -4.277 3.3 -4.473l14.367 -0.967 19.8 30.327v-26.83l-5.047 -0.58c-0.39 -2.143 1.163 -3.7 3.103 -3.89l13.4 -0.78z" fill="#000"/>
</svg>

After

Width:  |  Height:  |  Size: 1.6 KiB

View File

@@ -1,23 +1,16 @@
{ {
"excludeNotDocumented": true,
"$schema": "https://typedoc.org/schema.json", "$schema": "https://typedoc.org/schema.json",
"allReflectionsHaveOwnDocument": true, "cleanOutputDir": true,
"disableSources": true, "disableSources": true,
"hideBreadcrumbs": true,
"excludeExternals": true, "excludeExternals": true,
"excludeInternal": true, "excludeInternal": true,
"excludeNotDocumented": true,
"excludePrivate": true, "excludePrivate": true,
"cleanOutputDir": true,
"excludeProtected": true, "excludeProtected": true,
"hideHierarchy": true,
"gitRevision": "main", "gitRevision": "main",
"hideBreadcrumbs": true,
"hideGenerator": true, "hideGenerator": true,
"intentionallyNotExported": [
"ReturnTypes",
"CallbackParameters",
"JsonValue"
],
"readme": "none",
"sort": ["kind", "static-first", "required-first", "alphabetical"],
"kindSortOrder": [ "kindSortOrder": [
"Function", "Function",
"TypeAlias", "TypeAlias",
@@ -41,5 +34,13 @@
"IndexSignature", "IndexSignature",
"GetSignature", "GetSignature",
"SetSignature" "SetSignature"
] ],
"readme": "none",
"sort": [
"kind",
"static-first",
"required-first",
"alphabetical"
],
"symbolsWithOwnFile": "none"
} }

View File

@@ -41,8 +41,6 @@
"prettier": "2.8.1", "prettier": "2.8.1",
"prettier-plugin-svelte": "^2.8.1", "prettier-plugin-svelte": "^2.8.1",
"turbo": "1.6.3", "turbo": "1.6.3",
"typedoc": "^0.23.22",
"typedoc-plugin-markdown": "^3.14.0",
"typescript": "4.9.4" "typescript": "4.9.4"
}, },
"engines": { "engines": {
@@ -64,7 +62,6 @@
"undici": "5.11.0" "undici": "5.11.0"
}, },
"patchedDependencies": { "patchedDependencies": {
"typedoc-plugin-markdown@3.14.0": "patches/typedoc-plugin-markdown@3.14.0.patch",
"@balazsorban/monorepo-release@0.1.8": "patches/@balazsorban__monorepo-release@0.1.8.patch" "@balazsorban/monorepo-release@0.1.8": "patches/@balazsorban__monorepo-release@0.1.8.patch"
} }
} }

View File

@@ -1,7 +1,7 @@
{ {
"name": "@next-auth/dynamodb-adapter", "name": "@next-auth/dynamodb-adapter",
"repository": "https://github.com/nextauthjs/next-auth", "repository": "https://github.com/nextauthjs/next-auth",
"version": "1.2.0", "version": "3.0.0",
"description": "AWS DynamoDB adapter for next-auth.", "description": "AWS DynamoDB adapter for next-auth.",
"keywords": [ "keywords": [
"next-auth", "next-auth",
@@ -9,11 +9,18 @@
"oauth", "oauth",
"dynamodb" "dynamodb"
], ],
"type": "module",
"types": "./index.d.ts",
"homepage": "https://authjs.dev", "homepage": "https://authjs.dev",
"bugs": { "bugs": {
"url": "https://github.com/nextauthjs/next-auth/issues" "url": "https://github.com/nextauthjs/next-auth/issues"
}, },
"main": "dist/index.js", "exports": {
".": {
"types": "./index.d.ts",
"import": "./index.js"
}
},
"private": false, "private": false,
"publishConfig": { "publishConfig": {
"access": "public" "access": "public"
@@ -26,7 +33,10 @@
}, },
"files": [ "files": [
"README.md", "README.md",
"dist" "index.js",
"index.d.ts",
"index.d.ts.map",
"src"
], ],
"author": "Pol Marnette", "author": "Pol Marnette",
"license": "ISC", "license": "ISC",
@@ -41,7 +51,11 @@
"@next-auth/adapter-test": "workspace:*", "@next-auth/adapter-test": "workspace:*",
"@next-auth/tsconfig": "workspace:*", "@next-auth/tsconfig": "workspace:*",
"@shelf/jest-dynamodb": "^2.1.0", "@shelf/jest-dynamodb": "^2.1.0",
"@types/uuid": "^9.0.0",
"jest": "^27.4.3", "jest": "^27.4.3",
"next-auth": "workspace:*" "next-auth": "workspace:*"
},
"dependencies": {
"uuid": "^9.0.0"
} }
} }

View File

@@ -1,4 +1,4 @@
import { randomBytes } from "crypto" import { v4 as uuid } from "uuid"
import type { import type {
BatchWriteCommandInput, BatchWriteCommandInput,
@@ -12,16 +12,12 @@ import type {
VerificationToken, VerificationToken,
} from "next-auth/adapters" } from "next-auth/adapters"
import { format, generateUpdateExpression } from "./utils"
export { format, generateUpdateExpression }
export interface DynamoDBAdapterOptions { export interface DynamoDBAdapterOptions {
tableName?: string, tableName?: string
partitionKey?: string, partitionKey?: string
sortKey?: string, sortKey?: string
indexName?: string, indexName?: string
indexPartitionKey?: string, indexPartitionKey?: string
indexSortKey?: string indexSortKey?: string
} }
@@ -30,17 +26,17 @@ export function DynamoDBAdapter(
options?: DynamoDBAdapterOptions options?: DynamoDBAdapterOptions
): Adapter { ): Adapter {
const TableName = options?.tableName ?? "next-auth" const TableName = options?.tableName ?? "next-auth"
const pk = options?.partitionKey ?? 'pk' const pk = options?.partitionKey ?? "pk"
const sk = options?.sortKey ?? 'sk' const sk = options?.sortKey ?? "sk"
const IndexName = options?.indexName ?? 'GSI1' const IndexName = options?.indexName ?? "GSI1"
const GSI1PK = options?.indexPartitionKey ?? 'GSI1PK' const GSI1PK = options?.indexPartitionKey ?? "GSI1PK"
const GSI1SK = options?.indexSortKey ?? 'GSI1SK' const GSI1SK = options?.indexSortKey ?? "GSI1SK"
return { return {
async createUser(data) { async createUser(data) {
const user: AdapterUser = { const user: AdapterUser = {
...(data as any), ...(data as any),
id: randomBytes(16).toString("hex"), id: uuid(),
} }
await client.put({ await client.put({
@@ -50,8 +46,8 @@ export function DynamoDBAdapter(
[pk]: `USER#${user.id}`, [pk]: `USER#${user.id}`,
[sk]: `USER#${user.id}`, [sk]: `USER#${user.id}`,
type: "USER", type: "USER",
[GSI1PK]: `USER#${user.email as string}`, [GSI1PK]: `USER#${user.email}`,
[GSI1SK]: `USER#${user.email as string}`, [GSI1SK]: `USER#${user.email}`,
}), }),
}) })
@@ -165,7 +161,7 @@ export function DynamoDBAdapter(
async linkAccount(data) { async linkAccount(data) {
const item = { const item = {
...data, ...data,
id: randomBytes(16).toString("hex"), id: uuid(),
[pk]: `USER#${data.userId}`, [pk]: `USER#${data.userId}`,
[sk]: `ACCOUNT#${data.provider}#${data.providerAccountId}`, [sk]: `ACCOUNT#${data.provider}#${data.providerAccountId}`,
[GSI1PK]: `ACCOUNT#${data.provider}`, [GSI1PK]: `ACCOUNT#${data.provider}`,
@@ -229,7 +225,7 @@ export function DynamoDBAdapter(
}, },
async createSession(data) { async createSession(data) {
const session = { const session = {
id: randomBytes(16).toString("hex"), id: uuid(),
...data, ...data,
} }
await client.put({ await client.put({
@@ -327,3 +323,73 @@ export function DynamoDBAdapter(
}, },
} }
} }
// https://github.com/honeinc/is-iso-date/blob/master/index.js
const isoDateRE =
/(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))/
function isDate(value: any) {
return value && isoDateRE.test(value) && !isNaN(Date.parse(value))
}
const format = {
/** Takes a plain old JavaScript object and turns it into a Dynamodb object */
to(object: Record<string, any>) {
const newObject: Record<string, unknown> = {}
for (const key in object) {
const value = object[key]
if (value instanceof Date) {
// DynamoDB requires the TTL attribute be a UNIX timestamp (in secs).
if (key === "expires") newObject[key] = value.getTime() / 1000
else newObject[key] = value.toISOString()
} else newObject[key] = value
}
return newObject
},
/** Takes a Dynamo object and returns a plain old JavaScript object */
from<T = Record<string, unknown>>(object?: Record<string, any>): T | null {
if (!object) return null
const newObject: Record<string, unknown> = {}
for (const key in object) {
// Filter DynamoDB specific attributes so it doesn't get passed to core,
// to avoid revealing the type of database
if (["pk", "sk", "GSI1PK", "GSI1SK"].includes(key)) continue
const value = object[key]
if (isDate(value)) newObject[key] = new Date(value)
// hack to keep type property in account
else if (key === "type" && ["SESSION", "VT", "USER"].includes(value))
continue
// The expires property is stored as a UNIX timestamp in seconds, but
// JavaScript needs it in milliseconds, so multiply by 1000.
else if (key === "expires" && typeof value === "number")
newObject[key] = new Date(value * 1000)
else newObject[key] = value
}
return newObject as T
},
}
function generateUpdateExpression(object: Record<string, any>): {
UpdateExpression: string
ExpressionAttributeNames: Record<string, string>
ExpressionAttributeValues: Record<string, unknown>
} {
const formatedSession = format.to(object)
let UpdateExpression = "set"
const ExpressionAttributeNames: Record<string, string> = {}
const ExpressionAttributeValues: Record<string, unknown> = {}
for (const property in formatedSession) {
UpdateExpression += ` #${property} = :${property},`
ExpressionAttributeNames["#" + property] = property
ExpressionAttributeValues[":" + property] = formatedSession[property]
}
UpdateExpression = UpdateExpression.slice(0, -1)
return {
UpdateExpression,
ExpressionAttributeNames,
ExpressionAttributeValues,
}
}
export { format, generateUpdateExpression }

View File

@@ -1,67 +0,0 @@
// https://github.com/honeinc/is-iso-date/blob/master/index.js
const isoDateRE =
/(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))/
function isDate(value: any) {
return value && isoDateRE.test(value) && !isNaN(Date.parse(value))
}
export const format = {
/** Takes a plain old JavaScript object and turns it into a Dynamodb object */
to(object: Record<string, any>) {
const newObject: Record<string, unknown> = {}
for (const key in object) {
const value = object[key]
if (value instanceof Date) {
// DynamoDB requires the TTL attribute be a UNIX timestamp (in secs).
if (key === "expires") newObject[key] = value.getTime() / 1000
else newObject[key] = value.toISOString()
} else newObject[key] = value
}
return newObject
},
/** Takes a Dynamo object and returns a plain old JavaScript object */
from<T = Record<string, unknown>>(object?: Record<string, any>): T | null {
if (!object) return null
const newObject: Record<string, unknown> = {}
for (const key in object) {
// Filter DynamoDB specific attributes so it doesn't get passed to core,
// to avoid revealing the type of database
if (["pk", "sk", "GSI1PK", "GSI1SK"].includes(key)) continue
const value = object[key]
if (isDate(value)) newObject[key] = new Date(value)
// hack to keep type property in account
else if (key === "type" && ["SESSION", "VT", "USER"].includes(value))
continue
// The expires property is stored as a UNIX timestamp in seconds, but
// JavaScript needs it in milliseconds, so multiply by 1000.
else if (key === "expires" && typeof value === "number")
newObject[key] = new Date(value * 1000)
else newObject[key] = value
}
return newObject as T
},
}
export function generateUpdateExpression(object: Record<string, any>): {
UpdateExpression: string
ExpressionAttributeNames: Record<string, string>
ExpressionAttributeValues: Record<string, unknown>
} {
const formatedSession = format.to(object)
let UpdateExpression = "set"
const ExpressionAttributeNames: Record<string, string> = {}
const ExpressionAttributeValues: Record<string, unknown> = {}
for (const property in formatedSession) {
UpdateExpression += ` #${property} = :${property},`
ExpressionAttributeNames["#" + property] = property
ExpressionAttributeValues[":" + property] = formatedSession[property]
}
UpdateExpression = UpdateExpression.slice(0, -1)
return {
UpdateExpression,
ExpressionAttributeNames,
ExpressionAttributeValues,
}
}

View File

@@ -1,4 +1,4 @@
import { format } from "../src/utils" import { format } from "../src/"
describe("dynamodb utils.format", () => { describe("dynamodb utils.format", () => {
it("format.to() preserves non-Date non-expires properties", () => { it("format.to() preserves non-Date non-expires properties", () => {

View File

@@ -2,7 +2,15 @@
"extends": "@next-auth/tsconfig/tsconfig.adapters.json", "extends": "@next-auth/tsconfig/tsconfig.adapters.json",
"compilerOptions": { "compilerOptions": {
"rootDir": "src", "rootDir": "src",
"outDir": "dist" "outDir": ".",
"target": "ES2020",
"module": "ESNext",
"moduleResolution": "node",
"skipDefaultLibCheck": true,
"strictNullChecks": true,
"stripInternal": true,
"declarationMap": true,
"declaration": true
}, },
"exclude": ["tests", "dist", "jest.config.js", "jest-dynamodb-config.js"] "exclude": ["tests", "dist", "jest.config.js", "jest-dynamodb-config.js"]
} }

View File

@@ -1 +0,0 @@
{}

View File

@@ -1,16 +0,0 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [0.1.3](https://github.com/nextauthjs/adapters/compare/@next-auth/firebase-adapter@0.1.2...@next-auth/firebase-adapter@0.1.3) (2021-08-17)
**Note:** Version bump only for package @next-auth/firebase-adapter
## [0.1.2](https://github.com/nextauthjs/adapters/compare/@next-auth/firebase-adapter@0.1.1...@next-auth/firebase-adapter@0.1.2) (2021-07-02)
**Note:** Version bump only for package @next-auth/firebase-adapter
## [0.1.1](https://github.com/nextauthjs/adapters/compare/@next-auth/firebase-adapter@0.1.0...@next-auth/firebase-adapter@0.1.1) (2021-06-30)
**Note:** Version bump only for package @next-auth/firebase-adapter

View File

@@ -1,8 +1,8 @@
<p align="center"> <p align="center">
<br/> <br/>
<a href="https://authjs.dev" target="_blank"> <a href="https://authjs.dev" target="_blank">
<img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" /></a><img height="64px" src="https://raw.githubusercontent.com/nextauthjs/adapters/main/packages/firebase/logo.svg" /> <img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" /></a><img height="64px" src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/packages/adapter-firebase/logo.svg" />
<h3 align="center"><b>Firebase Adapter</b> - NextAuth.js</h3> <h3 align="center"><b>Firebase Adapter</b> - Auth.js</h3>
<p align="center"> <p align="center">
Open Source. Full Stack. Own Your Data. Open Source. Full Stack. Own Your Data.
</p> </p>
@@ -13,72 +13,12 @@
</p> </p>
</p> </p>
## Overview
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. This is the official Firebase Adapter for [Auth.js](https://authjs.dev) / [NextAuth.js](https://next-auth.js.org/), using the [Firebase Admin SDK](https://firebase.google.com/docs/admin/setup) and [Firestore](https://firebase.google.com/docs/firestore).
You can find more Firebase information in the docs at [authjs.dev/reference/adapters/firebase](https://authjs.dev/reference/adapters/firebase). ## Documentation
## Getting Started Check out the [documentation](https://authjs.dev/reference/adapter/firebase) to learn how to use this adapter in your project.
1. Install `next-auth` and `@next-auth/firebase-adapter`.
```js
npm install next-auth @next-auth/firebase-adapter
```
2. Add this adapter to your `pages/api/[...nextauth].js` next-auth configuration object.
```js
import NextAuth from "next-auth"
import Providers from "next-auth/providers"
import { FirestoreAdapter } from "@next-auth/firebase-adapter"
import { initializeApp } from "firebase/app";
import { getFirestore } from "firebase/firestore"
const app = initializeApp({ projectId: "next-auth-test" });
const firestore = getFirestore(app);
// 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/oauth-builtin
providers: [
Providers.Google({
clientId: process.env.GOOGLE_ID,
clientSecret: process.env.GOOGLE_SECRET,
}),
],
adapter: FirestoreAdapter(firestore),
...
})
```
## Options
When initializing the firestore adapter, you must pass in the firebase config object with the details from your project. More details on how to obtain that config object can be found [here](https://support.google.com/firebase/answer/7015592).
An example firebase config looks like this:
```js
const firebaseConfig = {
apiKey: "AIzaSyDOCAbC123dEf456GhI789jKl01-MnO",
authDomain: "myapp-project-123.firebaseapp.com",
databaseURL: "https://myapp-project-123.firebaseio.com",
projectId: "myapp-project-123",
storageBucket: "myapp-project-123.appspot.com",
messagingSenderId: "65211879809",
appId: "1:65211879909:web:3ae38ef1cdcb2e01fe5f0c",
measurementId: "G-8GSGZQ44ST",
}
```
See [firebase.google.com/docs/web/setup](https://firebase.google.com/docs/web/setup) for more details.
> **From Firebase - Caution**: We do not recommend manually modifying an app's Firebase config file or object. If you initialize an app with invalid or missing values for any of these required "Firebase options", then your end users may experience serious issues.
>
> For open source projects, we generally do not recommend including the app's Firebase config file or object in source control because, in most cases, your users should create their own Firebase projects and point their apps to their own Firebase resources (via their own Firebase config file or object).
## Contributing ## Contributing

View File

@@ -1,5 +1,8 @@
{ {
"emulators": { "firestore": {
"rules": "firestore.rules"
},
"emulator": {
"firestore": { "firestore": {
"port": 8080 "port": 8080
} }

View File

@@ -0,0 +1,10 @@
rules_version = '2';
// Deny read/write access to all users under any conditions
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if false;
}
}
}

View File

@@ -1 +0,0 @@
module.exports = require("@next-auth/adapter-test/jest/jest-preset")

View File

@@ -1,6 +1,6 @@
{ {
"name": "@next-auth/firebase-adapter", "name": "@next-auth/firebase-adapter",
"version": "1.0.3", "version": "2.0.0",
"description": "Firebase adapter for next-auth.", "description": "Firebase adapter for next-auth.",
"homepage": "https://authjs.dev", "homepage": "https://authjs.dev",
"repository": "https://github.com/nextauthjs/next-auth", "repository": "https://github.com/nextauthjs/next-auth",
@@ -12,35 +12,44 @@
"Nico Domino <yo@ndo.dev>", "Nico Domino <yo@ndo.dev>",
"Alex Meuer <github@alexmeuer.com>" "Alex Meuer <github@alexmeuer.com>"
], ],
"main": "dist/index.js", "type": "module",
"exports": {
".": {
"types": "./index.d.ts",
"import": "./index.js"
}
},
"files": [ "files": [
"dist", "src",
"index.d.ts" "*.js",
"*.d.ts*"
], ],
"license": "ISC", "license": "ISC",
"keywords": [ "keywords": [
"next-auth", "next-auth",
"next.js", "next.js",
"firebase" "firebase",
"firebase-admin"
], ],
"private": false, "private": false,
"publishConfig": { "publishConfig": {
"access": "public" "access": "public"
}, },
"scripts": { "scripts": {
"dev": "tsc -w",
"build": "tsc", "build": "tsc",
"test": "FIRESTORE_EMULATOR_HOST=localhost:8080 firebase --token '$FIREBASE_TOKEN' emulators:exec --only firestore --project next-auth-test jest" "test": "firebase emulators:exec --only firestore --project next-auth-test 'jest -c tests/jest.config.js'"
}, },
"peerDependencies": { "peerDependencies": {
"firebase": "^9.7.0", "firebase-admin": "^11.4.1",
"next-auth": "^4" "next-auth": "^4"
}, },
"devDependencies": { "devDependencies": {
"@next-auth/adapter-test": "workspace:*", "@next-auth/adapter-test": "workspace:*",
"@next-auth/tsconfig": "workspace:*", "@next-auth/tsconfig": "workspace:*",
"firebase": "^9.14.0", "firebase-admin": "^11.4.1",
"firebase-tools": "^11.16.1", "firebase-tools": "^11.16.1",
"jest": "^27.4.3", "jest": "^29.3.1",
"next-auth": "workspace:*" "next-auth": "workspace:*"
} }
} }

View File

@@ -1,58 +0,0 @@
import { Timestamp } from "firebase/firestore"
import type {
FirestoreDataConverter,
QueryDocumentSnapshot,
WithFieldValue,
} from "firebase/firestore"
const isTimestamp = (value: unknown): value is Timestamp =>
typeof value === "object" && value !== null && value instanceof Timestamp
interface GetConverterOptions {
excludeId?: boolean
}
export const getConverter = <Document extends Record<string, unknown>>(
options?: GetConverterOptions
): FirestoreDataConverter<Document> => ({
// `PartialWithFieldValue` implicitly types `object` as `any`, so we want to explicitly type it
toFirestore(object: WithFieldValue<Document>) {
const document: Record<string, unknown> = {}
Object.keys(object).forEach((key) => {
if (object[key] !== undefined) {
document[key] = object[key]
}
})
return document
},
// We need to explicitly type `snapshot` since it uses `DocumentData` for generic type
fromFirestore(snapshot: QueryDocumentSnapshot<Document>) {
if (!snapshot.exists()) {
return snapshot
}
let document: Document = snapshot.data()
if (!options?.excludeId) {
document = {
...document,
id: snapshot.id,
}
}
for (const key in document) {
const value = document[key]
if (isTimestamp(value)) {
document = {
...document,
[key]: value.toDate(),
}
}
}
return document
},
})

View File

@@ -1,282 +1,302 @@
import { initializeApp } from "firebase/app" /**
import type { FirebaseOptions } from "firebase/app" * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
* <span>
* Official <b>Firebase</b> adapter for Auth.js / NextAuth.js,
* using the <a href="https://firebase.google.com/docs/admin/setup">Firebase Admin SDK</a>
* &nbsp;and <a href="https://firebase.google.com/docs/firestore">Firestore</a>.</span>
* <a href="https://firebase.google.com/">
* <img style={{display: "block"}} src="https://raw.githubusercontent.com/nextauthjs/next-auth/main/packages/adapter-firebase/logo.svg" height="48" width="48"/>
* </a>
* </div>
*
* ## Installation
*
* ```bash npm2yarn2pnpm
* npm install next-auth @next-auth/firebase-admin-adapter firebase-admin
* ```
*
* ## References
* - [`GOOGLE_APPLICATION_CREDENTIALS` environment variable](https://cloud.google.com/docs/authentication/application-default-credentials#GAC)
* - [Firebase Admin SDK setup](https://firebase.google.com/docs/admin/setup#initialize-sdk)
*
* @module @next-auth/firebase-adapter
*/
import { type AppOptions } from "firebase-admin"
import { Firestore } from "firebase-admin/firestore"
import type { Adapter, AdapterUser } from "next-auth/adapters"
import { import {
addDoc, collestionsFactory,
collection, deleteDocs,
deleteDoc, initFirestore,
doc,
getDoc, getDoc,
getDocs, getOneDoc,
getFirestore, mapFieldsFactory,
limit, } from "./utils"
query,
runTransaction,
setDoc,
where,
connectFirestoreEmulator,
} from "firebase/firestore"
import type { export { initFirestore } from "./utils"
Adapter,
AdapterUser,
AdapterAccount,
AdapterSession,
VerificationToken,
} from "next-auth/adapters"
import { getConverter } from "./converter" /** Configure the Firebase Adapter. */
export interface FirebaseAdapterConfig extends AppOptions {
export type IndexableObject = Record<string, unknown> /**
* The name of the app passed to {@link https://firebase.google.com/docs/reference/admin/node/firebase-admin.md#initializeapp `initializeApp()`}.
export interface FirestoreAdapterOptions { */
emulator?: { name?: string
host?: string firestore?: Firestore
port?: number /**
} * Use this option if mixed `snake_case` and `camelCase` field names in the database is an issue for you.
* Passing `snake_case` will convert all field and collection names to `snake_case`.
* E.g. the collection `verificationTokens` will be `verification_tokens`,
* and fields like `emailVerified` will be `email_verified` instead.
*
*
* @example
* ```ts title="pages/api/auth/[...nextauth].ts"
* import NextAuth from "next-auth"
* import { FirestoreAdapter } from "@next-auth/firebase-adapter"
*
* export default NextAuth({
* adapter: FirestoreAdapter({ namingStrategy: "snake_case" })
* // ...
* })
* ```
*/
namingStrategy?: "snake_case"
} }
export function FirestoreAdapter({ /**
emulator, * #### Usage
...firebaseOptions *
}: FirebaseOptions & FirestoreAdapterOptions): Adapter { * First, create a Firebase project and generate a service account key.
const firebaseApp = initializeApp(firebaseOptions) * Visit: `https://console.firebase.google.com/u/0/project/{project-id}/settings/serviceaccounts/adminsdk` (replace `{project-id}` with your project's id)
const db = getFirestore(firebaseApp) *
* Now you have a few options to authenticate with the Firebase Admin SDK in your app:
*
* ##### 1. `GOOGLE_APPLICATION_CREDENTIALS` environment variable:
* - Download the service account key and save it in your project. (Make sure to add the file to your `.gitignore`!)
* - Add [`GOOGLE_APPLICATION_CREDENTIALS`](https://cloud.google.com/docs/authentication/application-default-credentials#GAC) to your environment variables and point it to the service account key file.
* - The adapter will automatically pick up the environment variable and use it to authenticate with the Firebase Admin SDK.
*
* @example
* ```ts title="pages/api/auth/[...nextauth].ts"
* import NextAuth from "next-auth"
* import { FirestoreAdapter } from "@next-auth/firebase-adapter"
*
* export default NextAuth({
* adapter: FirestoreAdapter(),
* // ...
* })
* ```
*
* ##### 2. Service account values as environment variables
*
* - Download the service account key to a temporary location. (Make sure to not commit this file to your repository!)
* - Add the following environment variables to your project: `FIREBASE_PROJECT_ID`, `FIREBASE_CLIENT_EMAIL`, `FIREBASE_PRIVATE_KEY`.
* - Pass the config to the adapter, using the environment variables as shown in the example below.
*
* @example
* ```ts title="pages/api/auth/[...nextauth].ts"
* import NextAuth from "next-auth"
* import { FirestoreAdapter } from "@next-auth/firebase-adapter"
* import { cert } from "firebase-admin/app"
*
* export default NextAuth({
* adapter: FirestoreAdapter({
* credential: cert({
* projectId: process.env.FIREBASE_PROJECT_ID,
* clientEmail: process.env.FIREBASE_CLIENT_EMAIL,
* privateKey: process.env.FIREBASE_PRIVATE_KEY,
* })
* })
* // ...
* })
* ```
*
* ##### 3. Use an existing Firestore instance
*
* If you already have a Firestore instance, you can pass that to the adapter directly instead.
*
* :::note
* When passing an instance and in a serverless environment, remember to handle duplicate app initialization.
* :::
*
* :::tip
* You can use the {@link initFirestore} utility to initialize the app and get an instance safely.
* :::
*
* @example
* ```ts title="pages/api/auth/[...nextauth].ts"
* import NextAuth from "next-auth"
* import { FirestoreAdapter } from "@next-auth/firebase-adapter"
* import { firestore } from "lib/firestore"
*
* export default NextAuth({
* adapter: FirestoreAdapter(firestore),
* // ...
* })
* ```
*/
export function FirestoreAdapter(
config?: FirebaseAdapterConfig | Firestore
): Adapter {
const { db, namingStrategy = "default" } =
config instanceof Firestore
? { db: config }
: { ...config, db: config?.firestore ?? initFirestore(config) }
if (emulator) { const preferSnakeCase = namingStrategy === "snake_case"
connectFirestoreEmulator( const C = collestionsFactory(db, preferSnakeCase)
db, const mapper = mapFieldsFactory(preferSnakeCase)
emulator?.host ?? "localhost",
emulator?.port ?? 3001
)
}
const Users = collection(db, "users").withConverter(
getConverter<AdapterUser & IndexableObject>()
)
const Sessions = collection(db, "sessions").withConverter(
getConverter<AdapterSession & IndexableObject>()
)
const Accounts = collection(db, "accounts").withConverter(
getConverter<AdapterAccount>()
)
const VerificationTokens = collection(db, "verificationTokens").withConverter(
getConverter<VerificationToken & IndexableObject>({ excludeId: true })
)
return { return {
async createUser(newUser) { async createUser(userInit) {
const userRef = await addDoc(Users, newUser) const { id: userId } = await C.users.add(userInit as AdapterUser)
const userSnapshot = await getDoc(userRef)
if (userSnapshot.exists() && Users.converter) { const user = await getDoc(C.users.doc(userId))
return Users.converter.fromFirestore(userSnapshot) if (!user) throw new Error("[createUser] Failed to fetch created user")
}
throw new Error("[createUser] Failed to create user") return user
}, },
async getUser(id) { async getUser(id) {
const userSnapshot = await getDoc(doc(Users, id)) return await getDoc(C.users.doc(id))
if (userSnapshot.exists() && Users.converter) {
return Users.converter.fromFirestore(userSnapshot)
}
return null
}, },
async getUserByEmail(email) { async getUserByEmail(email) {
const userQuery = query(Users, where("email", "==", email), limit(1)) return await getOneDoc(C.users.where("email", "==", email))
const userSnapshots = await getDocs(userQuery)
const userSnapshot = userSnapshots.docs[0]
if (userSnapshot?.exists() && Users.converter) {
return Users.converter.fromFirestore(userSnapshot)
}
return null
}, },
async getUserByAccount({ provider, providerAccountId }) { async getUserByAccount({ provider, providerAccountId }) {
const accountQuery = query( const account = await getOneDoc(
Accounts, C.accounts
where("provider", "==", provider), .where("provider", "==", provider)
where("providerAccountId", "==", providerAccountId), .where(mapper.toDb("providerAccountId"), "==", providerAccountId)
limit(1)
) )
const accountSnapshots = await getDocs(accountQuery) if (!account) return null
const accountSnapshot = accountSnapshots.docs[0]
if (accountSnapshot?.exists()) { return await getDoc(C.users.doc(account.userId))
const { userId } = accountSnapshot.data()
const userDoc = await getDoc(doc(Users, userId))
if (userDoc.exists() && Users.converter) {
return Users.converter.fromFirestore(userDoc)
}
}
return null
}, },
async updateUser(partialUser) { async updateUser(partialUser) {
const userRef = doc(Users, partialUser.id) if (!partialUser.id) throw new Error("[updateUser] Missing id")
await setDoc(userRef, partialUser, { merge: true }) const userRef = C.users.doc(partialUser.id)
const userSnapshot = await getDoc(userRef) await userRef.set(partialUser, { merge: true })
if (userSnapshot.exists() && Users.converter) { const user = await getDoc(userRef)
return Users.converter.fromFirestore(userSnapshot) if (!user) throw new Error("[updateUser] Failed to fetch updated user")
}
throw new Error("[updateUser] Failed to update user") return user
}, },
async deleteUser(userId) { async deleteUser(userId) {
const userRef = doc(Users, userId) await db.runTransaction(async (transaction) => {
const accountsQuery = query(Accounts, where("userId", "==", userId)) const accounts = await C.accounts
const sessionsQuery = query(Sessions, where("userId", "==", userId)) .where(mapper.toDb("userId"), "==", userId)
.get()
const sessions = await C.sessions
.where(mapper.toDb("userId"), "==", userId)
.get()
// TODO: May be better to use events instead of transactions? transaction.delete(C.users.doc(userId))
await runTransaction(db, async (transaction) => {
const accounts = await getDocs(accountsQuery)
const sessions = await getDocs(sessionsQuery)
transaction.delete(userRef)
accounts.forEach((account) => transaction.delete(account.ref)) accounts.forEach((account) => transaction.delete(account.ref))
sessions.forEach((session) => transaction.delete(session.ref)) sessions.forEach((session) => transaction.delete(session.ref))
}) })
}, },
async linkAccount(account) { async linkAccount(accountInit) {
const accountRef = await addDoc(Accounts, account) const ref = await C.accounts.add(accountInit)
const accountSnapshot = await getDoc(accountRef) const account = await ref.get().then((doc) => doc.data())
return account ?? null
if (accountSnapshot.exists() && Accounts.converter) {
return Accounts.converter.fromFirestore(accountSnapshot)
}
}, },
async unlinkAccount({ provider, providerAccountId }) { async unlinkAccount({ provider, providerAccountId }) {
const accountQuery = query( await deleteDocs(
Accounts, C.accounts
where("provider", "==", provider), .where("provider", "==", provider)
where("providerAccountId", "==", providerAccountId), .where(mapper.toDb("providerAccountId"), "==", providerAccountId)
limit(1) .limit(1)
) )
const accountSnapshots = await getDocs(accountQuery)
const accountSnapshot = accountSnapshots.docs[0]
if (accountSnapshot?.exists()) {
await deleteDoc(accountSnapshot.ref)
}
}, },
async createSession(session) { async createSession(sessionInit) {
const sessionRef = await addDoc(Sessions, session) const ref = await C.sessions.add(sessionInit)
const sessionSnapshot = await getDoc(sessionRef) const session = await ref.get().then((doc) => doc.data())
if (sessionSnapshot.exists() && Sessions.converter) { if (session) return session ?? null
return Sessions.converter.fromFirestore(sessionSnapshot)
}
throw new Error("[createSession] Failed to create session") throw new Error("[createSession] Failed to fetch created session")
}, },
async getSessionAndUser(sessionToken) { async getSessionAndUser(sessionToken) {
const sessionQuery = query( const session = await getOneDoc(
Sessions, C.sessions.where(mapper.toDb("sessionToken"), "==", sessionToken)
where("sessionToken", "==", sessionToken),
limit(1)
) )
const sessionSnapshots = await getDocs(sessionQuery) if (!session) return null
const sessionSnapshot = sessionSnapshots.docs[0]
if (sessionSnapshot?.exists() && Sessions.converter) { const user = await getDoc(C.users.doc(session.userId))
const session = Sessions.converter.fromFirestore(sessionSnapshot) if (!user) return null
const userDoc = await getDoc(doc(Users, session.userId))
if (userDoc.exists() && Users.converter) {
const user = Users.converter.fromFirestore(userDoc)
return { session, user } return { session, user }
}
}
return null
}, },
async updateSession(partialSession) { async updateSession(partialSession) {
const sessionQuery = query( const sessionId = await db.runTransaction(async (transaction) => {
Sessions, const sessionSnapshot = (
where("sessionToken", "==", partialSession.sessionToken), await transaction.get(
limit(1) C.sessions
.where(
mapper.toDb("sessionToken"),
"==",
partialSession.sessionToken
) )
const sessionSnapshots = await getDocs(sessionQuery) .limit(1)
const sessionSnapshot = sessionSnapshots.docs[0] )
).docs[0]
if (!sessionSnapshot?.exists) return null
if (sessionSnapshot?.exists()) { transaction.set(sessionSnapshot.ref, partialSession, { merge: true })
await setDoc(sessionSnapshot.ref, partialSession, { merge: true })
const sessionDoc = await getDoc(sessionSnapshot.ref) return sessionSnapshot.id
})
if (sessionDoc?.exists() && Sessions.converter) { if (!sessionId) return null
const session = Sessions.converter.fromFirestore(sessionDoc)
return session const session = await getDoc(C.sessions.doc(sessionId))
} if (session) return session
} throw new Error("[updateSession] Failed to fetch updated session")
return null
}, },
async deleteSession(sessionToken) { async deleteSession(sessionToken) {
const sessionQuery = query( await deleteDocs(
Sessions, C.sessions
where("sessionToken", "==", sessionToken), .where(mapper.toDb("sessionToken"), "==", sessionToken)
limit(1) .limit(1)
) )
const sessionSnapshots = await getDocs(sessionQuery)
const sessionSnapshot = sessionSnapshots.docs[0]
if (sessionSnapshot?.exists()) {
await deleteDoc(sessionSnapshot.ref)
}
}, },
async createVerificationToken(verificationToken) { async createVerificationToken(verificationToken) {
const verificationTokenRef = await addDoc( await C.verification_tokens.add(verificationToken)
VerificationTokens,
verificationToken
)
const verificationTokenSnapshot = await getDoc(verificationTokenRef)
if (verificationTokenSnapshot.exists() && VerificationTokens.converter) {
const { id, ...verificationToken } =
VerificationTokens.converter.fromFirestore(verificationTokenSnapshot)
return verificationToken return verificationToken
}
}, },
async useVerificationToken({ identifier, token }) { async useVerificationToken({ identifier, token }) {
const verificationTokensQuery = query( const verificationTokenSnapshot = (
VerificationTokens, await C.verification_tokens
where("identifier", "==", identifier), .where("identifier", "==", identifier)
where("token", "==", token), .where("token", "==", token)
limit(1) .limit(1)
) .get()
const verificationTokenSnapshots = await getDocs(verificationTokensQuery) ).docs[0]
const verificationTokenSnapshot = verificationTokenSnapshots.docs[0]
if (verificationTokenSnapshot?.exists() && VerificationTokens.converter) { if (!verificationTokenSnapshot) return null
await deleteDoc(verificationTokenSnapshot.ref)
const { id, ...verificationToken } = const data = verificationTokenSnapshot.data()
VerificationTokens.converter.fromFirestore(verificationTokenSnapshot) await verificationTokenSnapshot.ref.delete()
return data
return verificationToken
}
return null
}, },
} }
} }

View File

@@ -0,0 +1,168 @@
import { AppOptions, getApps, initializeApp } from "firebase-admin/app"
import {
getFirestore,
initializeFirestore,
Timestamp,
} from "firebase-admin/firestore"
import type {
AdapterUser,
AdapterAccount,
AdapterSession,
VerificationToken,
} from "next-auth/adapters"
import { FirebaseAdapterConfig } from "."
// for consistency, store all fields as snake_case in the database
const MAP_TO_FIRESTORE: Record<string, string | undefined> = {
userId: "user_id",
sessionToken: "session_token",
providerAccountId: "provider_account_id",
emailVerified: "email_verified",
}
const MAP_FROM_FIRESTORE: Record<string, string | undefined> = {}
for (const key in MAP_TO_FIRESTORE) {
MAP_FROM_FIRESTORE[MAP_TO_FIRESTORE[key]!] = key
}
const identity = <T>(x: T) => x
/** @internal */
export function mapFieldsFactory(preferSnakeCase?: boolean) {
if (preferSnakeCase) {
return {
toDb: (field: string) => MAP_TO_FIRESTORE[field] ?? field,
fromDb: (field: string) => MAP_FROM_FIRESTORE[field] ?? field,
}
}
return { toDb: identity, fromDb: identity }
}
/** @internal */
export function getConverter<Document extends Record<string, any>>(options: {
excludeId?: boolean
preferSnakeCase?: boolean
}): FirebaseFirestore.FirestoreDataConverter<Document> {
const mapper = mapFieldsFactory(options?.preferSnakeCase ?? false)
return {
toFirestore(object) {
const document: Record<string, unknown> = {}
for (const key in object) {
if (key === "id") continue
const value = object[key]
if (value !== undefined) {
document[mapper.toDb(key)] = value
} else {
console.warn(`FirebaseAdapter: value for key "${key}" is undefined`)
}
}
return document
},
fromFirestore(
snapshot: FirebaseFirestore.QueryDocumentSnapshot<Document>
): Document {
const document = snapshot.data()! // we can guarentee it exists
const object: Record<string, unknown> = {}
if (!options?.excludeId) {
object.id = snapshot.id
}
for (const key in document) {
let value: any = document[key]
if (value instanceof Timestamp) value = value.toDate()
object[mapper.fromDb(key)] = value
}
return object as Document
},
}
}
/** @internal */
export async function getOneDoc<T>(
querySnapshot: FirebaseFirestore.Query<T>
): Promise<T | null> {
const querySnap = await querySnapshot.limit(1).get()
return querySnap.docs[0]?.data() ?? null
}
/** @internal */
export async function deleteDocs<T>(
querySnapshot: FirebaseFirestore.Query<T>
): Promise<void> {
const querySnap = await querySnapshot.get()
for (const doc of querySnap.docs) {
await doc.ref.delete()
}
}
/** @internal */
export async function getDoc<T>(
docRef: FirebaseFirestore.DocumentReference<T>
): Promise<T | null> {
const docSnap = await docRef.get()
return docSnap.data() ?? null
}
/** @internal */
export function collestionsFactory(
db: FirebaseFirestore.Firestore,
preferSnakeCase = false
) {
return {
users: db
.collection("users")
.withConverter(getConverter<AdapterUser>({ preferSnakeCase })),
sessions: db
.collection("sessions")
.withConverter(getConverter<AdapterSession>({ preferSnakeCase })),
accounts: db
.collection("accounts")
.withConverter(getConverter<AdapterAccount>({ preferSnakeCase })),
verification_tokens: db
.collection(
preferSnakeCase ? "verification_tokens" : "verificationTokens"
)
.withConverter(
getConverter<VerificationToken>({ preferSnakeCase, excludeId: true })
),
}
}
/**
* Utility function that helps making sure that there is no duplicate app initialization issues in serverless environments.
* If no parameter is passed, it will use the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to initialize a Firestore instance.
*
* @example
* ```ts title="lib/firestore.ts"
* import { initFirestore } from "@next-auth/firebase-adapter"
* import { cert } from "firebase-admin/app"
*
* export const firestore = initFirestore({
* credential: cert({
* projectId: process.env.FIREBASE_PROJECT_ID,
* clientEmail: process.env.FIREBASE_CLIENT_EMAIL,
* privateKey: process.env.FIREBASE_PRIVATE_KEY,
* })
* })
* ```
*/
export function initFirestore(
options: AppOptions & { name?: FirebaseAdapterConfig["name"] } = {}
) {
const apps = getApps()
const app = options.name ? apps.find((a) => a.name === options.name) : apps[0]
if (app) return getFirestore(app)
return initializeFirestore(initializeApp(options, options.name))
}

View File

@@ -1,118 +1,57 @@
import { runBasicTests } from "@next-auth/adapter-test" import { runBasicTests } from "@next-auth/adapter-test"
import { FirestoreAdapter } from "../src"
import { FirestoreAdapter, type FirebaseAdapterConfig } from "../src"
import { import {
getFirestore, collestionsFactory,
connectFirestoreEmulator, initFirestore,
terminate,
collection,
query,
where,
limit,
getDocs,
getDoc, getDoc,
doc, getOneDoc,
} from "firebase/firestore" mapFieldsFactory,
import { initializeApp } from "firebase/app" } from "../src/utils"
import { getConverter } from "../src/converter"
import type {
AdapterSession,
AdapterUser,
VerificationToken,
} from "next-auth/adapters"
import type { Account } from "next-auth"
const app = initializeApp({ projectId: "next-auth-test" }) describe.each([
const firestore = getFirestore(app) { namingStrategy: "snake_case" },
{ namingStrategy: "default" },
] as Partial<FirebaseAdapterConfig>[])(
"FirebaseAdapter with config: %s",
(config) => {
config.name = `next-auth-test-${config.namingStrategy}`
config.projectId = "next-auth-test"
config.databaseURL = "http://localhost:8080"
connectFirestoreEmulator(firestore, "localhost", 8080) const db = initFirestore(config)
const preferSnakeCase = config.namingStrategy === "snake_case"
const mapper = mapFieldsFactory(preferSnakeCase)
const C = collestionsFactory(db, preferSnakeCase)
type IndexableObject = Record<string, unknown> for (const [name, collection] of Object.entries(C)) {
test(`collection "${name}" should be empty`, async () => {
const Users = collection(firestore, "users").withConverter( expect((await collection.count().get()).data().count).toBe(0)
getConverter<AdapterUser & IndexableObject>() })
) }
const Sessions = collection(firestore, "sessions").withConverter(
getConverter<AdapterSession & IndexableObject>()
)
const Accounts = collection(firestore, "accounts").withConverter(
getConverter<Account>()
)
const VerificationTokens = collection(
firestore,
"verificationTokens"
).withConverter(
getConverter<VerificationToken & IndexableObject>({ excludeId: true })
)
runBasicTests({ runBasicTests({
adapter: FirestoreAdapter({ projectId: "next-auth-test" }), adapter: FirestoreAdapter(config),
db: { db: {
async disconnect() { disconnect: async () => await db.terminate(),
await terminate(firestore) session: (sessionToken) =>
}, getOneDoc(
async session(sessionToken) { C.sessions.where(mapper.toDb("sessionToken"), "==", sessionToken)
const snapshotQuery = query( ),
Sessions, user: (userId) => getDoc(C.users.doc(userId)),
where("sessionToken", "==", sessionToken), account: ({ provider, providerAccountId }) =>
limit(1) getOneDoc(
) C.accounts
const snapshots = await getDocs(snapshotQuery) .where("provider", "==", provider)
const snapshot = snapshots.docs[0] .where(mapper.toDb("providerAccountId"), "==", providerAccountId)
),
if (snapshot?.exists() && Sessions.converter) { verificationToken: ({ identifier, token }) =>
const session = Sessions.converter.fromFirestore(snapshot) getOneDoc(
C.verification_tokens
return session .where("identifier", "==", identifier)
} .where("token", "==", token)
),
return null
},
async user(id) {
const snapshot = await getDoc(doc(Users, id))
if (snapshot?.exists() && Users.converter) {
const user = Users.converter.fromFirestore(snapshot)
return user
}
return null
},
async account({ provider, providerAccountId }) {
const snapshotQuery = query(
Accounts,
where("provider", "==", provider),
where("providerAccountId", "==", providerAccountId),
limit(1)
)
const snapshots = await getDocs(snapshotQuery)
const snapshot = snapshots.docs[0]
if (snapshot?.exists() && Accounts.converter) {
const account = Accounts.converter.fromFirestore(snapshot)
return account
}
return null
},
async verificationToken({ identifier, token }) {
const snapshotQuery = query(
VerificationTokens,
where("identifier", "==", identifier),
where("token", "==", token),
limit(1)
)
const snapshots = await getDocs(snapshotQuery)
const snapshot = snapshots.docs[0]
if (snapshot?.exists() && VerificationTokens.converter) {
const verificationToken =
VerificationTokens.converter.fromFirestore(snapshot)
return verificationToken
}
},
}, },
}) })
}
)

View File

@@ -0,0 +1,11 @@
import config from "@next-auth/adapter-test/jest/jest-preset.js"
//TODO: update rest of the packages to Jest 29+
const {testURL, ...rest} = config
export default {
...rest,
testEnvironmentOptions: {
url: testURL
},
rootDir: ".."
}

View File

@@ -1,11 +1,23 @@
{ {
"extends": "@next-auth/tsconfig/tsconfig.adapters.json", "extends": "@next-auth/tsconfig/tsconfig.adapters.json",
"compilerOptions": { "compilerOptions": {
"rootDir": "src",
"outDir": "dist",
"strict": true, "strict": true,
"noUncheckedIndexedAccess": true, "noUncheckedIndexedAccess": true,
"moduleResolution": "node" "target": "ES2020",
"module": "ESNext",
"moduleResolution": "node",
"outDir": ".",
"rootDir": "src",
"skipDefaultLibCheck": true,
"strictNullChecks": true,
"stripInternal": true,
"declarationMap": true,
"declaration": true
}, },
"exclude": ["tests", "dist", "jest.config.js"] "include": [
"src/**/*"
],
"exclude": [
"tests"
]
} }

View File

@@ -1,6 +1,6 @@
{ {
"name": "@auth/core", "name": "@auth/core",
"version": "0.3.0", "version": "0.4.0",
"description": "Authentication for the Web.", "description": "Authentication for the Web.",
"keywords": [ "keywords": [
"authentication", "authentication",
@@ -27,7 +27,7 @@
"types": "./index.d.ts", "types": "./index.d.ts",
"files": [ "files": [
"*.js", "*.js",
"*.d.ts", "*.d.ts*",
"lib", "lib",
"providers", "providers",
"src" "src"
@@ -69,7 +69,7 @@
"preact-render-to-string": "5.2.3" "preact-render-to-string": "5.2.3"
}, },
"peerDependencies": { "peerDependencies": {
"nodemailer": "6.8.0" "nodemailer": "^6.8.0"
}, },
"peerDependenciesMeta": { "peerDependenciesMeta": {
"nodemailer": { "nodemailer": {
@@ -77,10 +77,11 @@
} }
}, },
"scripts": { "scripts": {
"build": "pnpm css && tsc", "build": "pnpm css && pnpm providers && tsc",
"clean": "rm -rf *.js *.d.ts* lib providers", "clean": "rm -rf *.js *.d.ts* lib providers",
"css": "node scripts/generate-css", "css": "node scripts/generate-css",
"dev": "pnpm css && tsc -w" "dev": "pnpm css && pnpm providers && tsc -w",
"providers": "node scripts/generate-providers"
}, },
"devDependencies": { "devDependencies": {
"@next-auth/tsconfig": "workspace:*", "@next-auth/tsconfig": "workspace:*",

View File

@@ -0,0 +1,18 @@
import { join } from "path"
import { readdirSync, writeFileSync } from "fs"
const providersPath = join(process.cwd(), "src/providers")
const files = readdirSync(providersPath, "utf8")
const providers = files.map((file) => {
const strippedProviderName = file.substring(0, file.indexOf("."))
return `"${strippedProviderName}"`
}).filter((provider) => provider !== '"oauth-types"' && provider !== '"index"')
const result = `
// THIS FILE IS AUTOGENERATED. DO NOT EDIT.
export type OAuthProviderType =
| ${providers.join("\n | ")}`
writeFileSync(join(providersPath, "oauth-types.ts"), result)

View File

@@ -1,4 +1,8 @@
/** /**
*
* :::warning Experimental
* `@auth/core` is under active development.
* :::
* *
* This is the main entry point to the Auth.js library. * This is the main entry point to the Auth.js library.
* *
@@ -27,14 +31,14 @@
* ## Resources * ## Resources
* *
* - [Getting started](https://authjs.dev/getting-started/introduction) * - [Getting started](https://authjs.dev/getting-started/introduction)
* - [Most common use case guides](https://authjs.dev/guides/overview) * - [Most common use case guides](https://authjs.dev/guides)
* *
* @module main * @module index
*/ */
import { assertConfig } from "./lib/assert.js" import { assertConfig } from "./lib/assert.js"
import { ErrorPageLoop } from "./errors.js" import { ErrorPageLoop } from "./errors.js"
import { AuthInternal } from "./lib/index.js" import { AuthInternal, skipCSRFCheck } from "./lib/index.js"
import renderPage from "./lib/pages/index.js" import renderPage from "./lib/pages/index.js"
import { logger, setLogger, type LoggerInstance } from "./lib/utils/logger.js" import { logger, setLogger, type LoggerInstance } from "./lib/utils/logger.js"
import { toInternalRequest, toResponse } from "./lib/web.js" import { toInternalRequest, toResponse } from "./lib/web.js"
@@ -51,6 +55,8 @@ import type {
import type { Provider } from "./providers/index.js" import type { Provider } from "./providers/index.js"
import { JWTOptions } from "./jwt.js" import { JWTOptions } from "./jwt.js"
export { skipCSRFCheck }
/** /**
* Core functionality provided by Auth.js. * Core functionality provided by Auth.js.
* *
@@ -298,14 +304,3 @@ export interface AuthConfig {
trustHost?: boolean trustHost?: boolean
skipCSRFCheck?: typeof skipCSRFCheck skipCSRFCheck?: typeof skipCSRFCheck
} }
/**
* :::danger
* This option is inteded for framework authors.
* :::
*
* Auth.js comes with built-in {@link https://authjs.dev/concepts/security#csrf CSRF} protection, but
* if you are implementing a framework that is already protected against CSRF attacks, you can skip this check by
* passing this value to {@link AuthConfig.skipCSRFCheck}.
*/
export const skipCSRFCheck = Symbol("skip-csrf-check")

View File

@@ -1,5 +1,4 @@
import { UnknownAction } from "../errors.js" import { UnknownAction } from "../errors.js"
import { skipCSRFCheck } from "../index.js"
import { SessionStore } from "./cookie.js" import { SessionStore } from "./cookie.js"
import { init } from "./init.js" import { init } from "./init.js"
import renderPage from "./pages/index.js" import renderPage from "./pages/index.js"
@@ -72,9 +71,9 @@ export async function AuthInternal<
if (pages.signIn) { if (pages.signIn) {
let signinUrl = `${pages.signIn}${ let signinUrl = `${pages.signIn}${
pages.signIn.includes("?") ? "&" : "?" pages.signIn.includes("?") ? "&" : "?"
}callbackUrl=${encodeURIComponent(options.callbackUrl)}` }${new URLSearchParams({ callbackUrl: options.callbackUrl })}`
if (error) if (error)
signinUrl = `${signinUrl}&error=${encodeURIComponent(error)}` signinUrl = `${signinUrl}&${new URLSearchParams({ error })}`
return { redirect: signinUrl, cookies } return { redirect: signinUrl, cookies }
} }
@@ -186,3 +185,14 @@ export async function AuthInternal<
} }
throw new UnknownAction(`Cannot handle action: ${action}`) throw new UnknownAction(`Cannot handle action: ${action}`)
} }
/**
* :::danger
* This option is intended for framework authors.
* :::
*
* Auth.js comes with built-in {@link https://authjs.dev/concepts/security#csrf CSRF} protection, but
* if you are implementing a framework that is already protected against CSRF attacks, you can skip this check by
* passing this value to {@link AuthConfig.skipCSRFCheck}.
*/
export const skipCSRFCheck = Symbol("skip-csrf-check")

View File

@@ -90,5 +90,5 @@ export async function getAuthorizationUrl(
} }
logger.debug("authorization url is ready", { url, cookies, provider }) logger.debug("authorization url is ready", { url, cookies, provider })
return { redirect: url, cookies } return { redirect: url.toString(), cookies }
} }

View File

@@ -203,7 +203,7 @@ async function getProfile(
// If we didn't get a response either there was a problem with the provider // If we didn't get a response either there was a problem with the provider
// response *or* the user cancelled the action with the provider. // response *or* the user cancelled the action with the provider.
// //
// Unfortuately, we can't tell which - at least not in a way that works for // Unfortunately, we can't tell which - at least not in a way that works for
// all providers, so we return an empty object; the user should then be // all providers, so we return an empty object; the user should then be
// redirected back to the sign up page. We log the error to help developers // redirected back to the sign up page. We log the error to help developers
// who might be trying to debug this when configuring a new provider. // who might be trying to debug this when configuring a new provider.

View File

@@ -53,7 +53,7 @@ export async function callback(params: {
cookies.push(...authorizationResult.cookies) cookies.push(...authorizationResult.cookies)
} }
logger.debug("authroization result", authorizationResult) logger.debug("authorization result", authorizationResult)
const { profile, account, OAuthProfile } = authorizationResult const { profile, account, OAuthProfile } = authorizationResult
@@ -149,7 +149,7 @@ export async function callback(params: {
return { return {
redirect: `${pages.newUser}${ redirect: `${pages.newUser}${
pages.newUser.includes("?") ? "&" : "?" pages.newUser.includes("?") ? "&" : "?"
}callbackUrl=${encodeURIComponent(callbackUrl)}`, }${new URLSearchParams({ callbackUrl })}`,
cookies, cookies,
} }
} }
@@ -256,7 +256,7 @@ export async function callback(params: {
return { return {
redirect: `${pages.newUser}${ redirect: `${pages.newUser}${
pages.newUser.includes("?") ? "&" : "?" pages.newUser.includes("?") ? "&" : "?"
}callbackUrl=${encodeURIComponent(callbackUrl)}`, }${new URLSearchParams({ callbackUrl })}`,
cookies, cookies,
} }
} }
@@ -350,6 +350,6 @@ export async function callback(params: {
logger.error(error) logger.error(error)
url.searchParams.set("error", CallbackRouteError.name) url.searchParams.set("error", CallbackRouteError.name)
url.pathname += "/error" url.pathname += "/error"
return { redirect: url, cookies } return { redirect: url.toString(), cookies }
} }
} }

View File

@@ -7,19 +7,20 @@ export async function handleAuthorized(
params: any, params: any,
{ url, logger, callbacks: { signIn } }: InternalOptions { url, logger, callbacks: { signIn } }: InternalOptions
) { ) {
url.pathname += "/error"
try { try {
const authorized = await signIn(params) const authorized = await signIn(params)
if (!authorized) { if (!authorized) {
url.pathname += "/error"
logger.debug("User not authorized", params) logger.debug("User not authorized", params)
url.searchParams.set("error", "AccessDenied") url.searchParams.set("error", "AccessDenied")
return { status: 403 as const, redirect: url } return { status: 403 as const, redirect: url.toString() }
} }
} catch (e) { } catch (e) {
url.pathname += "/error"
const error = new AuthorizedCallbackError(e as Error) const error = new AuthorizedCallbackError(e as Error)
logger.error(error) logger.error(error)
url.searchParams.set("error", "Configuration") url.searchParams.set("error", "Configuration")
return { status: 500 as const, redirect: url } return { status: 500 as const, redirect: url.toString() }
} }
} }

View File

@@ -54,7 +54,7 @@ export async function signin(
logger.error(error) logger.error(error)
url.searchParams.set("error", error.name) url.searchParams.set("error", error.name)
url.pathname += "/error" url.pathname += "/error"
return { redirect: url } return { redirect: url.toString() }
} }
} }

View File

@@ -8,7 +8,7 @@ import type { SessionStore } from "../cookie.js"
* If the session strategy is database, * If the session strategy is database,
* The session is also deleted from the database. * The session is also deleted from the database.
* In any case, the session cookie is cleared and * In any case, the session cookie is cleared and
* an `events.signOut` is emitted. * {@link EventCallbacks.signOut} is emitted.
*/ */
export async function signout( export async function signout(
sessionStore: SessionStore, sessionStore: SessionStore,

View File

@@ -76,27 +76,22 @@ export function toResponse(res: ResponseInternal): Response {
res.cookies?.forEach((cookie) => { res.cookies?.forEach((cookie) => {
const { name, value, options } = cookie const { name, value, options } = cookie
const cookieHeader = serialize(name, value, options) const cookieHeader = serialize(name, value, options)
if (headers.has("Set-Cookie")) { if (headers.has("Set-Cookie")) headers.append("Set-Cookie", cookieHeader)
headers.append("Set-Cookie", cookieHeader) else headers.set("Set-Cookie", cookieHeader)
} else {
headers.set("Set-Cookie", cookieHeader)
}
// headers.set("Set-Cookie", cookieHeader) // TODO: Remove. Seems to be a bug with Headers in the runtime // headers.set("Set-Cookie", cookieHeader) // TODO: Remove. Seems to be a bug with Headers in the runtime
}) })
const body = let body = res.body
headers.get("content-type") === "application/json"
? JSON.stringify(res.body)
: res.body
const response = new Response(body, { if (headers.get("content-type") === "application/json")
headers, body = JSON.stringify(res.body)
status: res.redirect ? 302 : res.status ?? 200, else if (headers.get("content-type") === "application/x-www-form-urlencoded")
}) body = new URLSearchParams(res.body).toString()
if (res.redirect) { const status = res.redirect ? 302 : res.status ?? 200
response.headers.set("Location", res.redirect.toString()) const response = new Response(body, { headers, status })
}
if (res.redirect) response.headers.set("Location", res.redirect)
return response return response
} }

View File

@@ -49,10 +49,6 @@ export interface CredentialsConfig<
export type CredentialsProviderType = "Credentials" export type CredentialsProviderType = "Credentials"
export type CredentialsConfigInternal<
C extends Record<string, CredentialInput> = Record<string, CredentialInput>
> = CredentialsConfig<C> & { options: CredentialsConfig<C> }
/** /**
* The Credentials provider allows you to handle signing in with arbitrary credentials, * The Credentials provider allows you to handle signing in with arbitrary credentials,
* such as a username and password, domain, or two factor authentication or hardware device (e.g. YubiKey U2F / FIDO). * such as a username and password, domain, or two factor authentication or hardware device (e.g. YubiKey U2F / FIDO).

View File

@@ -1,21 +1,77 @@
import type { OAuthConfig, OAuthUserConfig } from "./index.js" import type { OAuthConfig, OAuthUserConfig } from "./index.js"
/**
* Corresponds to the user structure documented here:
* https://discord.com/developers/docs/resources/user#user-object-user-structure
*/
export interface DiscordProfile extends Record<string, any> { export interface DiscordProfile extends Record<string, any> {
accent_color: number /** the user's id (i.e. the numerical snowflake) */
avatar: string
banner: string
banner_color: string
discriminator: string
email: string
flags: number
id: string id: string
image_url: string /** the user's username, not unique across the platform */
locale: string
mfa_enabled: boolean
premium_type: number
public_flags: number
username: string username: string
/** the user's 4-digit discord-tag */
discriminator: string
/**
* the user's avatar hash:
* https://discord.com/developers/docs/reference#image-formatting
*/
avatar: string | null
/** whether the user belongs to an OAuth2 application */
bot?: boolean
/**
* whether the user is an Official Discord System user (part of the urgent
* message system)
*/
system?: boolean
/** whether the user has two factor enabled on their account */
mfa_enabled: boolean
/**
* the user's banner hash:
* https://discord.com/developers/docs/reference#image-formatting
*/
banner: string | null
/** the user's banner color encoded as an integer representation of hexadecimal color code */
accent_color: number | null
/**
* the user's chosen language option:
* https://discord.com/developers/docs/reference#locales
*/
locale: string
/** whether the email on this account has been verified */
verified: boolean verified: boolean
/** the user's email */
email: string | null
/**
* the flags on a user's account:
* https://discord.com/developers/docs/resources/user#user-object-user-flags
*/
flags: number
/**
* the type of Nitro subscription on a user's account:
* https://discord.com/developers/docs/resources/user#user-object-premium-types
*/
premium_type: number
/**
* the public flags on a user's account:
* https://discord.com/developers/docs/resources/user#user-object-user-flags
*/
public_flags: number
/** undocumented field; corresponds to the user's custom nickname */
display_name: string | null
/**
* undocumented field; corresponds to the Discord feature where you can e.g.
* put your avatar inside of an ice cube
*/
avatar_decoration: string | null
/**
* undocumented field; corresponds to the premium feature where you can
* select a custom banner color
*/
banner_color: string | null
/** undocumented field; the CDN URL of their profile picture */
image_url: string
} }
export default function Discord<P extends DiscordProfile>( export default function Discord<P extends DiscordProfile>(

View File

@@ -65,12 +65,16 @@ export type Provider<P extends Profile = Profile> = (
| EmailConfig | EmailConfig
| CredentialsConfig | CredentialsConfig
) & { ) & {
/**
* Used to deep merge user-provided config with the default config
* @internal
*/
options: Record<string, unknown> options: Record<string, unknown>
} }
export type BuiltInProviders = Record< export type BuiltInProviders = Record<
OAuthProviderType, OAuthProviderType,
(options: Partial<OAuthConfig<any>>) => OAuthConfig<any> (config: Partial<OAuthConfig<any>>) => OAuthConfig<any>
> & > &
Record<CredentialsProviderType, typeof CredentialsProvider> & Record<CredentialsProviderType, typeof CredentialsProvider> &
Record<EmailProviderType, typeof EmailProvider> Record<EmailProviderType, typeof EmailProvider>

View File

@@ -0,0 +1,166 @@
/**
* <div style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
* <span>Built-in <b>Notion</b> integration.</span>
* <a href="https://notion.so">
* <img style={{display: "block"}} src="https://authjs.dev/img/providers/notion.svg" height="48" width="48"/>
* </a>
* </div>
*
* ---
* @module providers/notion
*/
import type { OAuthConfig, OAuthUserConfig } from "."
export interface Person extends Record<string, any> {
email: string
}
// https://developers.notion.com/reference/user
export interface User extends Record<string, any> {
object: "user" | "bot"
id: string
type: string
name: string
avatar_url: null | string
person: Person
owner?: {
type: "workspace" | "user"
workspace: string
}
workspace_name?: string | null
}
export interface Owner {
type: string
user: User
}
// Notion responds with an access_token + some additional information, which we define here
// More info - https://developers.notion.com/docs/authorization#step-4-notion-responds-with-an-access_token-and-some-additional-information
export interface NotionProfile extends Record<string, any> {
access_token: string
bot_id: string
duplicated_template_id: string
owner?: Owner
workspace_icon: string
workspace_id: number
workspace_name: string
}
// Any config required that isn't part of the `OAuthUserConfig` spec should belong here
// For example, we must pass a `redirectUri` to the Notion API when requesting tokens, therefore we add it here
interface AdditionalConfig {
redirectUri: string
}
const NOTION_HOST = "https://api.notion.com"
const NOTION_API_VERSION = "2022-06-28"
/**
* Add Notion login to your page.
*
* ## Example
*
* ```ts
* import { Auth } from "@auth/core"
* import Notion from "@auth/core/providers/notion"
*
* const request = new Request("https://example.com")
* const response = await Auth(request, {
* providers: [Notion({ clientId: "", clientSecret: "", redirectUri: "" })],
* })
* ```
*
* ---
*
* ## Resources
* - [Notion Docs](https://developers.notion.com/docs)
* - [Notion Authorization Docs](https://developers.notion.com/docs/authorization)
* - [Notion Integrations](https://www.notion.so/my-integrations)
*
* ---
*
* ## Notes
* You need to select "Public Integration" on the configuration page to get an `oauth_id` and `oauth_secret`. Private integrations do not provide these details.
* You must provide a `clientId` and `clientSecret` to use this provider, as-well as a redirect URI (due to this being required by Notion endpoint to fetch tokens).
*
* :::tip
*
* The Notion provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/notion.ts).
* To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/providers/custom-provider#override-default-options).
*
* :::
*
* :::info **Disclaimer**
*
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
*
* Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
* the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
* we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
*
* :::
*/
export default function NotionProvider<P extends NotionProfile>(
options: OAuthUserConfig<P> & AdditionalConfig
): OAuthConfig<P> {
return {
id: "notion",
name: "Notion",
type: "oauth",
token: {
url: `${NOTION_HOST}/v1/oauth/token`,
},
userinfo: {
url: `${NOTION_HOST}/v1/users`,
// The result of this method will be the input to the `profile` callback.
// We use a custom request handler, since we need to do things such as pass the "Notion-Version" header
// More info: https://next-auth.js.org/configuration/providers/oauth
async request(context) {
const profile = await fetch(`${NOTION_HOST}/v1/users/me`, {
headers: {
Authorization: `Bearer ${context.tokens.access_token}`,
"Notion-Version": NOTION_API_VERSION,
},
})
const {
bot: {
owner: { user },
},
} = await profile.json()
return user
},
},
authorization: {
params: {
client_id: options.clientId,
response_type: "code",
owner: "user",
redirect_uri: options.redirectUri,
},
url: `${NOTION_HOST}/v1/oauth/authorize`,
},
async profile(profile, tokens) {
return {
id: profile.id,
name: profile.name,
email: profile.person.email,
image: profile.avatar_url,
}
},
style: {
logo: "/notion.svg",
logoDark: "/notion.svg",
bg: "#fff",
text: "#000",
bgDark: "#fff",
textDark: "#000",
},
options,
}
}

View File

@@ -1,69 +0,0 @@
// THIS FILE IS AUTOGENERATED. DO NOT EDIT.
export type OAuthProviderType =
| "42-school"
| "apple"
| "atlassian"
| "auth0"
| "authentik"
| "azure-ad-b2c"
| "azure-ad"
| "battlenet"
| "box"
| "boxyhq-saml"
| "bungie"
| "cognito"
| "coinbase"
| "credentials"
| "discord"
| "dropbox"
| "duende-identity-server6"
| "email"
| "eveonline"
| "facebook"
| "faceit"
| "foursquare"
| "freshbooks"
| "fusionauth"
| "github"
| "gitlab"
| "google"
| "hubspot"
| "identity-server4"
| "index"
| "instagram"
| "kakao"
| "keycloak"
| "line"
| "linkedin"
| "mailchimp"
| "mailru"
| "medium"
| "naver"
| "netlify"
| "oauth-types.js"
| "oauth"
| "okta"
| "onelogin"
| "osso"
| "osu"
| "patreon"
| "pinterest"
| "pipedrive"
| "reddit"
| "salesforce"
| "slack"
| "spotify"
| "strava"
| "todoist"
| "trakt"
| "twitch"
| "twitter"
| "united-effects"
| "vk"
| "wikimedia"
| "wordpress"
| "workos"
| "yandex"
| "zitadel"
| "zoho"
| "zoom"

View File

@@ -66,7 +66,7 @@ export type TokenEndpointHandler = EndpointHandler<
params: CallbackParamsType params: CallbackParamsType
/** /**
* When using this custom flow, make sure to do all the necessary security checks. * When using this custom flow, make sure to do all the necessary security checks.
* Thist object contains parameters you have to match against the request to make sure it is valid. * This object contains parameters you have to match against the request to make sure it is valid.
*/ */
checks: OAuthChecks checks: OAuthChecks
}, },

View File

@@ -452,7 +452,7 @@ export interface ResponseInternal<
status?: number status?: number
headers?: Headers | HeadersInit headers?: Headers | HeadersInit
body?: Body body?: Body
redirect?: URL | string redirect?: string
cookies?: Cookie[] cookies?: Cookie[]
} }

View File

@@ -1,6 +1,6 @@
{ {
"name": "@auth/sveltekit", "name": "@auth/sveltekit",
"version": "0.2.0", "version": "0.2.1",
"description": "Authentication for SvelteKit.", "description": "Authentication for SvelteKit.",
"keywords": [ "keywords": [
"authentication", "authentication",

View File

@@ -1,8 +1,16 @@
// After build, copy the files in ./package to the root directory, excluding the package.json file. // After build, copy the files in ./package to the root directory, excluding the package.json file.
import fs from "fs/promises" import fs from "fs/promises"
import path from "path" import path from "path"
const __dirname = path.dirname(new URL(import.meta.url).pathname) let __dirname = path.dirname(new URL(import.meta.url).pathname)
// The above hack to polyfill "__dirname" for ESM does not work on Windows computers,
// so we might have to manually perform more steps.
__dirname = __dirname.split(path.sep).join(path.posix.sep)
if (__dirname.match(/^\/\w:\//)) {
__dirname = __dirname.slice(3) // Remove the drive prefix.
}
const root = path.join(__dirname, "..") const root = path.join(__dirname, "..")
const pkgDir = path.join(root, "package") const pkgDir = path.join(root, "package")

View File

@@ -183,7 +183,7 @@
* PRs to improve this documentation are welcome! See [this file](https://github.com/nextauthjs/next-auth/blob/main/packages/frameworks-sveltekit/src/lib/index.ts). * PRs to improve this documentation are welcome! See [this file](https://github.com/nextauthjs/next-auth/blob/main/packages/frameworks-sveltekit/src/lib/index.ts).
* ::: * :::
* *
* @module main * @module index
*/ */
/// <reference types="@sveltejs/kit" /> /// <reference types="@sveltejs/kit" />

View File

@@ -1,23 +0,0 @@
diff --git a/dist/theme.js b/dist/theme.js
index 1483a4b4ec69583aa3086eac83b2b31ae8bb6777..c30e7a4f7785fc230099e8b904040dd4aa57c38e 100644
--- a/dist/theme.js
+++ b/dist/theme.js
@@ -221,12 +221,12 @@ class MarkdownTheme extends typedoc_1.Theme {
directory: 'enums',
template: this.getReflectionTemplate(),
},
- {
- kind: [typedoc_1.ReflectionKind.Class],
- isLeaf: false,
- directory: 'classes',
- template: this.getReflectionTemplate(),
- },
+ // {
+ // kind: [typedoc_1.ReflectionKind.Class],
+ // isLeaf: false,
+ // directory: 'classes',
+ // template: this.getReflectionTemplate(),
+ // },
{
kind: [typedoc_1.ReflectionKind.Interface],
isLeaf: false,

4238
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -25,6 +25,10 @@
"dependsOn": ["^build"], "dependsOn": ["^build"],
"outputs": ["lib/**", "providers/**", "*.js", "*.d.ts", "*.d.ts.map"] "outputs": ["lib/**", "providers/**", "*.js", "*.d.ts", "*.d.ts.map"]
}, },
"@auth/sveltekit#build": {
"dependsOn": ["^build"],
"outputs": ["client.*", "index.*"]
},
"clean": { "clean": {
"cache": false "cache": false
}, },
@@ -39,6 +43,10 @@
}, },
"@next-auth/upstash-redis-adapter#test": { "@next-auth/upstash-redis-adapter#test": {
"env": ["UPSTASH_REDIS_KEY", "UPSTASH_REDIS_URL"] "env": ["UPSTASH_REDIS_KEY", "UPSTASH_REDIS_URL"]
},
"docs#dev": {
"dependsOn": ["^build"],
"cache": false
} }
} }
} }