Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fedeya/next-auth-sanity
NextAuth Adapter and Provider for Sanity
https://github.com/fedeya/next-auth-sanity
next-auth nextjs react sanity
Last synced: 1 day ago
JSON representation
NextAuth Adapter and Provider for Sanity
- Host: GitHub
- URL: https://github.com/fedeya/next-auth-sanity
- Owner: fedeya
- License: mit
- Created: 2021-04-25T05:09:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T15:12:59.000Z (3 months ago)
- Last Synced: 2025-02-02T14:43:15.415Z (1 day ago)
- Topics: next-auth, nextjs, react, sanity
- Language: TypeScript
- Homepage: https://sanity.io/plugins/next-auth-sanity
- Size: 468 KB
- Stars: 80
- Watchers: 6
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Welcome to next-auth-sanity 👋
> NextAuth Adapter and Provider for Sanity
## Overview
### Features
- Saving users and account in Sanity
- Email Provider Support
- Retrieving of full linked provider information for a user
- Auth with Credentials
- Hash Credentials Passwords with Argon2
### Database sessions
Database sessions are not implemented, this adapter relies on usage of JSON Web Tokens for stateless session management.
### Privacy and user information
Storing people's user credentials is always a big responsibility. Make sure you understand the risks and inform your users accordingly. This adapter store the user information with [the `_id` on the `user.` path](https://www.sanity.io/docs/ids#fdc25ada5db2). In other words, these documents can't be queried without authentication, even if your dataset is set to be public. That also means that these documents are available for everyone that's part of your Sanity project.
## Requirements
- Sanity Token for Read+Write
## Installation
### yarn
```sh
yarn add next-auth-sanity
```
### npm
```sh
npm i next-auth-sanity
```
## Usage
[Full Example](https://github.com/Fedeya/next-auth-sanity/tree/main/examples/full-example)
```ts
import NextAuth, { NextAuthOptions } from 'next-auth';
import GitHub from 'next-auth/providers/github';
import { NextApiRequest, NextApiResponse } from 'next';
import { SanityAdapter, SanityCredentials } from 'next-auth-sanity';
import { client } from 'your/sanity/client';
const options: NextAuthOptions = {
providers: [
GitHub({
clientId: process.env.GITHUB_CLIENT_ID,
clientSecret: process.env.GITHUB_CLIENT_SECRET
}),
SanityCredentials(client) // only if you use sign in with credentials
],
session: {
strategy: 'jwt'
},
adapter: SanityAdapter(client)
};
export default NextAuth(options);
```
### Sanity Schemas
you can install this package in your studio project and use the schemas like this
```ts
import createSchema from 'part:@sanity/base/schema-creator';
import schemaTypes from 'all:part:@sanity/base/schema-type';
import { user, account, verificationToken } from 'next-auth-sanity/schemas';
export default createSchema({
name: 'default',
types: schemaTypes.concat([user, account, verificationToken])
});
```
Or copy paste the schemas
```ts
// user - required
export default {
name: 'user',
title: 'User',
type: 'document',
fields: [
{
name: 'name',
title: 'Name',
type: 'string'
},
{
name: 'email',
title: 'Email',
type: 'string'
},
{
name: 'image',
title: 'Image',
type: 'url'
},
{
// this is only if you use credentials provider
name: 'password',
type: 'string',
hidden: true
},
{
name: 'emailVerified',
type: 'datetime',
hidden: true,
}
]
};
```
```ts
// account - required
export default {
name: 'account',
title: 'Account',
type: 'document',
fields: [
{
name: 'providerType',
type: 'string'
},
{
name: 'providerId',
type: 'string'
},
{
name: 'providerAccountId',
type: 'string'
},
{
name: 'refreshToken',
type: 'string'
},
{
name: 'accessToken',
type: 'string'
},
{
name: 'accessTokenExpires',
type: 'number'
},
{
name: 'user',
title: 'User',
type: 'reference',
to: { type: 'user' }
}
]
};
```
```ts
// verification-token - only if you use email provider
export default {
name: 'verification-token',
title: 'Verification Token',
type: 'document',
fields: [
{
name: 'identifier',
title: 'Identifier',
type: 'string'
},
{
name: 'token',
title: 'Token',
type: 'string'
},
{
name: 'expires',
title: 'Expires',
type: 'datetime'
}
]
};
```
### Sign Up and Sign In With Credentials
### Setup
`API Route` (with pages)
```ts
// pages/api/sanity/signUp.ts
import { signUpHandler } from 'next-auth-sanity';
import { client } from 'your/sanity/client';
export default signUpHandler(client);
```
`Route Handler` (with app directory)
```ts
// app/api/sanity/signUp/route.ts
import { signUpHandler } from 'next-auth-sanity';
import { client } from 'your/sanity/client';
export const POST = signUpHandler(client);
```
`Client`
```ts
import { signUp } from 'next-auth-sanity/client';
import { signIn } from 'next-auth/react';
const user = await signUp({
email,
password,
name
});
await signIn('sanity-login', {
redirect: false,
email,
password
});
```
## Custom Schemas
if you want to use another schema or upgrade from previous version you can change the default schema used in the library, to do so you can pass a second argument to all methods with config
```ts
SanityAdapter(client, {
schemas: {
verificationToken: 'verification-request',
account: 'account',
user: 'profile'
}
})
// the second argument is the name of the user schema
// default: 'user'
SanityCredentials(client, 'profile');
signUpHandler(client, 'profile');
```
## Author
👤 **Fedeya **
- Website: [fedeminaya.com](https://fedeminaya.com)
- Twitter: [@fedeminaya](https://twitter.com/fedeminaya)
- Github: [@Fedeya](https://github.com/Fedeya)
- LinkedIn: [@federico-minaya](https://linkedin.com/in/federico-minaya)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Fedeya/next-auth-sanity/issues).
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_