@auth/fauna-adapter 3.0.0 → 3.2.0

package/README.md

@@ -18,7 +18,7 @@
       <img src="https://img.shields.io/npm/dm/@auth/fauna-adapter?label=%20downloads&style=flat-square" alt="Downloads" />
     </a>
     <a href="https://github.com/nextauthjs/next-auth/stargazers">
-      <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="Github Stars" />
+      <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
     </a>
   </p>
 </p>

package/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
- *  <p style={{fontWeight: "300"}}>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <p>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://fauna.com/features">
- *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" height="30"/>
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" width="64" />
  *  </a>
  * </div>
  *
@@ -33,179 +33,6 @@ type AdapterConfig = {
         verificationToken: string;
     };
 };
-/**
- *
- * ## Setup
- *
- * This is the Fauna Adapter for [Auth.js](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` and other framework packages. It is not a standalone package.
- *
- * You can find the Fauna schema and seed information in the docs at [authjs.dev/reference/adapter/fauna](https://authjs.dev/reference/adapter/fauna).
- *
- * ### Configure Auth.js
- *
- * ```js title="pages/api/auth/[...nextauth].js"
- * import NextAuth from "next-auth"
- * import { Client } from "fauna"
- * import { FaunaAdapter } from "@auth/fauna-adapter"
- *
- * const client = new Client({
- *   secret: "secret",
- *   endpoint: new URL('http://localhost:8443')
- * })
- *
- * // For more information on each option (and a full list of options) go to
- * // https://authjs.dev/reference/core/types#authconfig
- * export default NextAuth({
- *   // https://authjs.dev/getting-started/authentication/oauth
- *   providers: [],
- *   adapter: FaunaAdapter(client)
- * })
- * ```
- *
- * ### Schema
- *
- * Run the following FQL code inside the `Shell` tab in the Fauna dashboard to set up the appropriate collections and indexes.
- *
- * ```javascript
- * Collection.create({
- *   name: "Account",
- *   indexes: {
- *     byUserId: {
- *       terms: [
- *         { field: "userId" }
- *       ]
- *     },
- *     byProviderAndProviderAccountId: {
- *       terms [
- *         { field: "provider" },
- *         { field: "providerAccountId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "Session",
- *   constraints: [
- *     {
- *       unique: ["sessionToken"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     bySessionToken: {
- *       terms: [
- *         { field: "sessionToken" }
- *       ]
- *     },
- *     byUserId: {
- *       terms [
- *         { field: "userId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "User",
- *   constraints: [
- *     {
- *       unique: ["email"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     byEmail: {
- *       terms [
- *         { field: "email" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *       terms [
- *         { field: "identifier" },
- *         { field: "token" }
- *       ]
- *     },
- *   }
- * })
- * ```
- *
- * > This schema is adapted for use in Fauna and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * #### Custom collection names
- * If you want to use custom collection names, you can pass them as an option to the adapter, like this:
- *
- * ```javascript
- * FaunaAdapter(client, {
- *   collectionNames: {
- *     user: "CustomUser",
- *     account: "CustomAccount",
- *     session: "CustomSession",
- *     verificationToken: "CustomVerificationToken",
- *   }
- * })
- * ```
- *
- * Make sure the collection names you pass to the provider match the collection names of your Fauna database.
- *
- * ### Migrating from v1
- * In v2, we've renamed the collections to use uppercase naming, in accordance with Fauna best practices. If you're migrating from v1, you'll need to rename your collections to match the new naming scheme.
- * Additionally, we've renamed the indexes to match the new method-like index names.
- *
- * #### Migration script
- * Run this FQL script inside a Fauna shell for the database you're migrating from v1 to v2 (it will rename your collections and indexes to match):
- *
- * ```javascript
- * Collection.byName("accounts")!.update({
- *   name: "Account"
- *   indexes: {
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     byProviderAndProviderAccountId: {
- *         terms: [{ field: "provider" }, { field: "providerAccountId" }]
- *     },
- *     account_by_provider_and_provider_account_id: null,
- *     accounts_by_user_id: null
- *   }
- * })
- * Collection.byName("sessions")!.update({
- *   name: "Session",
- *   indexes: {
- *     bySessionToken: {
- *         terms: [{ field: "sessionToken" }]
- *     },
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     session_by_session_token: null,
- *     sessions_by_user_id: null
- *   }
- * })
- * Collection.byName("users")!.update({
- *   name: "User",
- *   indexes: {
- *     byEmail: {
- *         terms: [{ field: "email" }]
- *     },
- *     user_by_email: null
- *   }
- * })
- * Collection.byName("verification_tokens")!.update({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *         terms: [{ field: "identifier" }, { field: "token" }]
- *     },
- *     verification_token_by_identifier_and_token: null
- *   }
- * })
- * ```
- *
- **/
 export declare function FaunaAdapter(client: Client, config?: AdapterConfig): Adapter;
 export declare const format: {
     /** Takes an object that's coming from the database and converts it to plain JavaScript. */

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EACL,MAAM,EACN,QAAQ,EAGR,UAAU,EACV,gBAAgB,EAEjB,MAAM,OAAO,CAAA;AAEd,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACf,MAAM,qBAAqB,CAAA;AAE5B,KAAK,OAAO,CAAC,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GACpC,QAAQ,GAAG,IAAI,GACf,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GACpB,IAAI,GACJ,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GACrB,CAAC,CAAC,CAAC,CAAC,GACJ,gBAAgB;CACzB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC5C,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;AAClD,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAChF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;AAElD,KAAK,aAAa,GAAG;IACnB,eAAe,EAAE;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;QACf,iBAAiB,EAAE,MAAM,CAAA;KAC1B,CAAA;CACF,CAAA;AASD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA4KI;AACJ,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAsI5E;AAED,eAAO,MAAM,MAAM;IACjB,2FAA2F;qBAC3E,OAAO,MAAM,EAAE,GAAG,CAAC;IASnC,gGAAgG;oBAClF,OAAO,MAAM,EAAE,GAAG,CAAC;CAUlC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EACL,MAAM,EACN,QAAQ,EAGR,UAAU,EACV,gBAAgB,EAEjB,MAAM,OAAO,CAAA;AAEd,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACf,MAAM,qBAAqB,CAAA;AAE5B,KAAK,OAAO,CAAC,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GACpC,QAAQ,GAAG,IAAI,GACf,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GACpB,IAAI,GACJ,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GACrB,CAAC,CAAC,CAAC,CAAC,GACJ,gBAAgB;CACzB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC5C,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;AAClD,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAChF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;AAElD,KAAK,aAAa,GAAG;IACnB,eAAe,EAAE;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;QACf,iBAAiB,EAAE,MAAM,CAAA;KAC1B,CAAA;CACF,CAAA;AASD,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAsI5E;AAED,eAAO,MAAM,MAAM;IACjB,2FAA2F;qBAC3E,OAAO,MAAM,EAAE,GAAG,CAAC;IASnC,gGAAgG;oBAClF,OAAO,MAAM,EAAE,GAAG,CAAC;CAUlC,CAAA"}

package/index.js

@@ -1,8 +1,8 @@
 /**
  * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
- *  <p style={{fontWeight: "300"}}>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <p>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://fauna.com/features">
- *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" height="30"/>
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" width="64" />
  *  </a>
  * </div>
  *
@@ -21,179 +21,6 @@ const defaultCollectionNames = {
     account: "Account",
     verificationToken: "VerificationToken",
 };
-/**
- *
- * ## Setup
- *
- * This is the Fauna Adapter for [Auth.js](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` and other framework packages. It is not a standalone package.
- *
- * You can find the Fauna schema and seed information in the docs at [authjs.dev/reference/adapter/fauna](https://authjs.dev/reference/adapter/fauna).
- *
- * ### Configure Auth.js
- *
- * ```js title="pages/api/auth/[...nextauth].js"
- * import NextAuth from "next-auth"
- * import { Client } from "fauna"
- * import { FaunaAdapter } from "@auth/fauna-adapter"
- *
- * const client = new Client({
- *   secret: "secret",
- *   endpoint: new URL('http://localhost:8443')
- * })
- *
- * // For more information on each option (and a full list of options) go to
- * // https://authjs.dev/reference/core/types#authconfig
- * export default NextAuth({
- *   // https://authjs.dev/getting-started/authentication/oauth
- *   providers: [],
- *   adapter: FaunaAdapter(client)
- * })
- * ```
- *
- * ### Schema
- *
- * Run the following FQL code inside the `Shell` tab in the Fauna dashboard to set up the appropriate collections and indexes.
- *
- * ```javascript
- * Collection.create({
- *   name: "Account",
- *   indexes: {
- *     byUserId: {
- *       terms: [
- *         { field: "userId" }
- *       ]
- *     },
- *     byProviderAndProviderAccountId: {
- *       terms [
- *         { field: "provider" },
- *         { field: "providerAccountId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "Session",
- *   constraints: [
- *     {
- *       unique: ["sessionToken"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     bySessionToken: {
- *       terms: [
- *         { field: "sessionToken" }
- *       ]
- *     },
- *     byUserId: {
- *       terms [
- *         { field: "userId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "User",
- *   constraints: [
- *     {
- *       unique: ["email"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     byEmail: {
- *       terms [
- *         { field: "email" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *       terms [
- *         { field: "identifier" },
- *         { field: "token" }
- *       ]
- *     },
- *   }
- * })
- * ```
- *
- * > This schema is adapted for use in Fauna and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * #### Custom collection names
- * If you want to use custom collection names, you can pass them as an option to the adapter, like this:
- *
- * ```javascript
- * FaunaAdapter(client, {
- *   collectionNames: {
- *     user: "CustomUser",
- *     account: "CustomAccount",
- *     session: "CustomSession",
- *     verificationToken: "CustomVerificationToken",
- *   }
- * })
- * ```
- *
- * Make sure the collection names you pass to the provider match the collection names of your Fauna database.
- *
- * ### Migrating from v1
- * In v2, we've renamed the collections to use uppercase naming, in accordance with Fauna best practices. If you're migrating from v1, you'll need to rename your collections to match the new naming scheme.
- * Additionally, we've renamed the indexes to match the new method-like index names.
- *
- * #### Migration script
- * Run this FQL script inside a Fauna shell for the database you're migrating from v1 to v2 (it will rename your collections and indexes to match):
- *
- * ```javascript
- * Collection.byName("accounts")!.update({
- *   name: "Account"
- *   indexes: {
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     byProviderAndProviderAccountId: {
- *         terms: [{ field: "provider" }, { field: "providerAccountId" }]
- *     },
- *     account_by_provider_and_provider_account_id: null,
- *     accounts_by_user_id: null
- *   }
- * })
- * Collection.byName("sessions")!.update({
- *   name: "Session",
- *   indexes: {
- *     bySessionToken: {
- *         terms: [{ field: "sessionToken" }]
- *     },
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     session_by_session_token: null,
- *     sessions_by_user_id: null
- *   }
- * })
- * Collection.byName("users")!.update({
- *   name: "User",
- *   indexes: {
- *     byEmail: {
- *         terms: [{ field: "email" }]
- *     },
- *     user_by_email: null
- *   }
- * })
- * Collection.byName("verification_tokens")!.update({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *         terms: [{ field: "identifier" }, { field: "token" }]
- *     },
- *     verification_token_by_identifier_and_token: null
- *   }
- * })
- * ```
- *
- **/
 export function FaunaAdapter(client, config) {
     const { collectionNames = defaultCollectionNames } = config || {};
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/fauna-adapter",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Fauna Adapter for Auth.js",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",
@@ -38,7 +38,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@auth/core": "0.30.0"
+    "@auth/core": "0.32.0"
   },
   "peerDependencies": {
     "fauna": "^1.3.1"

package/src/index.ts

@@ -1,8 +1,8 @@
 /**
  * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: "16px"}}>
- *  <p style={{fontWeight: "300"}}>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <p>Official <a href="https://docs.fauna.com/fauna/current/">Fauna</a> adapter for Auth.js / NextAuth.js.</p>
  *  <a href="https://fauna.com/features">
- *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" height="30"/>
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/adapters/fauna.svg" width="64" />
  *  </a>
  * </div>
  *
@@ -63,179 +63,6 @@ const defaultCollectionNames = {
   verificationToken: "VerificationToken",
 }
 
-/**
- *
- * ## Setup
- *
- * This is the Fauna Adapter for [Auth.js](https://authjs.dev). This package can only be used in conjunction with the primary `next-auth` and other framework packages. It is not a standalone package.
- *
- * You can find the Fauna schema and seed information in the docs at [authjs.dev/reference/adapter/fauna](https://authjs.dev/reference/adapter/fauna).
- *
- * ### Configure Auth.js
- *
- * ```js title="pages/api/auth/[...nextauth].js"
- * import NextAuth from "next-auth"
- * import { Client } from "fauna"
- * import { FaunaAdapter } from "@auth/fauna-adapter"
- *
- * const client = new Client({
- *   secret: "secret",
- *   endpoint: new URL('http://localhost:8443')
- * })
- *
- * // For more information on each option (and a full list of options) go to
- * // https://authjs.dev/reference/core/types#authconfig
- * export default NextAuth({
- *   // https://authjs.dev/getting-started/authentication/oauth
- *   providers: [],
- *   adapter: FaunaAdapter(client)
- * })
- * ```
- *
- * ### Schema
- *
- * Run the following FQL code inside the `Shell` tab in the Fauna dashboard to set up the appropriate collections and indexes.
- *
- * ```javascript
- * Collection.create({
- *   name: "Account",
- *   indexes: {
- *     byUserId: {
- *       terms: [
- *         { field: "userId" }
- *       ]
- *     },
- *     byProviderAndProviderAccountId: {
- *       terms [
- *         { field: "provider" },
- *         { field: "providerAccountId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "Session",
- *   constraints: [
- *     {
- *       unique: ["sessionToken"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     bySessionToken: {
- *       terms: [
- *         { field: "sessionToken" }
- *       ]
- *     },
- *     byUserId: {
- *       terms [
- *         { field: "userId" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "User",
- *   constraints: [
- *     {
- *       unique: ["email"],
- *       status: "active",
- *     }
- *   ],
- *   indexes: {
- *     byEmail: {
- *       terms [
- *         { field: "email" }
- *       ]
- *     },
- *   }
- * })
- * Collection.create({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *       terms [
- *         { field: "identifier" },
- *         { field: "token" }
- *       ]
- *     },
- *   }
- * })
- * ```
- *
- * > This schema is adapted for use in Fauna and based upon our main [schema](https://authjs.dev/reference/core/adapters#models)
- *
- * #### Custom collection names
- * If you want to use custom collection names, you can pass them as an option to the adapter, like this:
- *
- * ```javascript
- * FaunaAdapter(client, {
- *   collectionNames: {
- *     user: "CustomUser",
- *     account: "CustomAccount",
- *     session: "CustomSession",
- *     verificationToken: "CustomVerificationToken",
- *   }
- * })
- * ```
- *
- * Make sure the collection names you pass to the provider match the collection names of your Fauna database.
- *
- * ### Migrating from v1
- * In v2, we've renamed the collections to use uppercase naming, in accordance with Fauna best practices. If you're migrating from v1, you'll need to rename your collections to match the new naming scheme.
- * Additionally, we've renamed the indexes to match the new method-like index names.
- *
- * #### Migration script
- * Run this FQL script inside a Fauna shell for the database you're migrating from v1 to v2 (it will rename your collections and indexes to match):
- *
- * ```javascript
- * Collection.byName("accounts")!.update({
- *   name: "Account"
- *   indexes: {
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     byProviderAndProviderAccountId: {
- *         terms: [{ field: "provider" }, { field: "providerAccountId" }]
- *     },
- *     account_by_provider_and_provider_account_id: null,
- *     accounts_by_user_id: null
- *   }
- * })
- * Collection.byName("sessions")!.update({
- *   name: "Session",
- *   indexes: {
- *     bySessionToken: {
- *         terms: [{ field: "sessionToken" }]
- *     },
- *     byUserId: {
- *         terms: [{ field: "userId" }]
- *     },
- *     session_by_session_token: null,
- *     sessions_by_user_id: null
- *   }
- * })
- * Collection.byName("users")!.update({
- *   name: "User",
- *   indexes: {
- *     byEmail: {
- *         terms: [{ field: "email" }]
- *     },
- *     user_by_email: null
- *   }
- * })
- * Collection.byName("verification_tokens")!.update({
- *   name: "VerificationToken",
- *   indexes: {
- *     byIdentifierAndToken: {
- *         terms: [{ field: "identifier" }, { field: "token" }]
- *     },
- *     verification_token_by_identifier_and_token: null
- *   }
- * })
- * ```
- *
- **/
 export function FaunaAdapter(client: Client, config?: AdapterConfig): Adapter {
   const { collectionNames = defaultCollectionNames } = config || {}