@auth/fauna-adapter 2.1.1 → 2.2.0

package/index.d.ts

@@ -25,6 +25,14 @@ export type FaunaVerificationToken = ToFauna<VerificationToken> & {
     id: string;
 };
 export type FaunaAccount = ToFauna<AdapterAccount>;
+type AdapterConfig = {
+    collectionNames: {
+        user: string;
+        session: string;
+        account: string;
+        verificationToken: string;
+    };
+};
 /**
  *
  * ## Setup
@@ -128,6 +136,22 @@ export type FaunaAccount = ToFauna<AdapterAccount>;
  *
  * > 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.
@@ -183,7 +207,7 @@ export type FaunaAccount = ToFauna<AdapterAccount>;
  * ```
  *
  **/
-export declare function FaunaAdapter(client: Client): Adapter;
+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. */
     from<T>(object?: Record<string, any>): T;

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAqB,UAAU,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAA;AAEzF,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,GAAG,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB;CAC/I,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6JI;AACJ,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CA4HpD;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,EAAE,MAAM,EAAE,QAAQ,EAAqB,UAAU,EAAE,gBAAgB,EAAU,MAAM,OAAO,CAAA;AAEjG,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,GAAG,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB;CAC/I,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6KI;AACJ,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CA8H5E;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

@@ -15,6 +15,12 @@
  * @module @auth/fauna-adapter
  */
 import { TimeStub, fql, NullDocument } from "fauna";
+const defaultCollectionNames = {
+    user: "User",
+    session: "Session",
+    account: "Account",
+    verificationToken: "VerificationToken",
+};
 /**
  *
  * ## Setup
@@ -118,6 +124,22 @@ import { TimeStub, fql, NullDocument } from "fauna";
  *
  * > 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.
@@ -173,29 +195,30 @@ import { TimeStub, fql, NullDocument } from "fauna";
  * ```
  *
  **/
-export function FaunaAdapter(client) {
+export function FaunaAdapter(client, config) {
+    const { collectionNames = defaultCollectionNames } = config || {};
     return {
         async createUser(user) {
-            const response = await client.query(fql `User.create(${format.to(user)})`);
+            const response = await client.query(fql `Collection(${collectionNames.user}).create(${format.to(user)})`);
             return format.from(response.data);
         },
         async getUser(id) {
-            const response = await client.query(fql `User.byId(${id})`);
+            const response = await client.query(fql `Collection(${collectionNames.user}).byId(${id})`);
             if (response.data instanceof NullDocument)
                 return null;
             return format.from(response.data);
         },
         async getUserByEmail(email) {
-            const response = await client.query(fql `User.byEmail(${email}).first()`);
+            const response = await client.query(fql `Collection(${collectionNames.user}).byEmail(${email}).first()`);
             if (response.data === null)
                 return null;
             return format.from(response.data);
         },
         async getUserByAccount({ provider, providerAccountId }) {
             const response = await client.query(fql `
-        let account = Account.byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first()
+        let account = Collection(${collectionNames.account}).byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first()
         if (account != null) {
-          User.byId(account.userId)
+          Collection(${collectionNames.user}).byId(account.userId)
         } else {
           null
         }
@@ -205,34 +228,34 @@ export function FaunaAdapter(client) {
         async updateUser(user) {
             const _user = { ...user };
             delete _user.id;
-            const response = await client.query(fql `User.byId(${user.id}).update(${format.to(_user)})`);
+            const response = await client.query(fql `Collection(${collectionNames.user}).byId(${user.id}).update(${format.to(_user)})`);
             return format.from(response.data);
         },
         async deleteUser(userId) {
             await client.query(fql `
         // Delete the user's sessions
-        Session.byUserId(${userId}).forEach(session => session.delete())
+        Collection(${collectionNames.session}).byUserId(${userId}).forEach(session => session.delete())
         
         // Delete the user's accounts
-        Account.byUserId(${userId}).forEach(account => account.delete())
+        Collection(${collectionNames.account}).byUserId(${userId}).forEach(account => account.delete())
         
         // Delete the user
-        User.byId(${userId}).delete()
+        Collection(${collectionNames.user}).byId(${userId}).delete()
       `);
         },
         async linkAccount(account) {
-            await client.query(fql `Account.create(${format.to(account)})`);
+            await client.query(fql `Collection(${collectionNames.account}).create(${format.to(account)})`);
             return account;
         },
         async unlinkAccount({ provider, providerAccountId }) {
-            const response = await client.query(fql `Account.byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first().delete()`);
+            const response = await client.query(fql `Collection(${collectionNames.account}).byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first().delete()`);
             return format.from(response.data);
         },
         async getSessionAndUser(sessionToken) {
             const response = await client.query(fql `
-        let session = Session.bySessionToken(${sessionToken}).first()
+        let session = Collection(${collectionNames.session}).bySessionToken(${sessionToken}).first()
         if (session != null) {
-          let user = User.byId(session.userId)
+          let user = Collection(${collectionNames.user}).byId(session.userId)
           if (user != null) {
             [user, session]
           } else {
@@ -248,26 +271,26 @@ export function FaunaAdapter(client) {
             return { session: format.from(session), user: format.from(user) };
         },
         async createSession(session) {
-            await client.query(fql `Session.create(${format.to(session)})`);
+            await client.query(fql `Collection(${collectionNames.session}).create(${format.to(session)})`);
             return session;
         },
         async updateSession(session) {
-            const response = await client.query(fql `Session.bySessionToken(${session.sessionToken}).first().update(${format.to(session)})`);
+            const response = await client.query(fql `Collection(${collectionNames.session}).bySessionToken(${session.sessionToken}).first().update(${format.to(session)})`);
             return format.from(response.data);
         },
         async deleteSession(sessionToken) {
-            await client.query(fql `Session.bySessionToken(${sessionToken}).first().delete()`);
+            await client.query(fql `Collection(${collectionNames.session}).bySessionToken(${sessionToken}).first().delete()`);
         },
         async createVerificationToken(verificationToken) {
-            await client.query(fql `VerificationToken.create(${format.to(verificationToken)})`);
+            await client.query(fql `Collection(${collectionNames.verificationToken}).create(${format.to(verificationToken)})`);
             return verificationToken;
         },
         async useVerificationToken({ identifier, token }) {
-            const response = await client.query(fql `VerificationToken.byIdentifierAndToken(${identifier}, ${token}).first()`);
+            const response = await client.query(fql `Collection(${collectionNames.verificationToken}).byIdentifierAndToken(${identifier}, ${token}).first()`);
             if (response.data === null)
                 return null;
             // Delete the verification token so it can only be used once
-            await client.query(fql `VerificationToken.byId(${response.data.id}).delete()`);
+            await client.query(fql `Collection(${collectionNames.verificationToken}).byId(${response.data.id}).delete()`);
             const _verificationToken = { ...response.data };
             delete _verificationToken.id;
             return format.from(_verificationToken);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/fauna-adapter",
-  "version": "2.1.1",
+  "version": "2.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.28.1"
+    "@auth/core": "0.29.0"
   },
   "peerDependencies": {
     "fauna": "^1.3.1"

package/src/index.ts

@@ -14,7 +14,7 @@
  *
  * @module @auth/fauna-adapter
  */
-import { Client, TimeStub, fql, NullDocument, QueryValue, QueryValueObject } from "fauna"
+import { Client, TimeStub, fql, NullDocument, QueryValue, QueryValueObject, Module } from "fauna"
 
 import type {
   Adapter,
@@ -33,6 +33,22 @@ export type FaunaSession = ToFauna<AdapterSession>
 export type FaunaVerificationToken = ToFauna<VerificationToken> & { id: string }
 export type FaunaAccount = ToFauna<AdapterAccount>
 
+type AdapterConfig = {
+  collectionNames: {
+    user: string
+    session: string
+    account: string
+    verificationToken: string
+  }
+}
+
+const defaultCollectionNames = {
+  user: "User",
+  session: "Session",
+  account: "Account",
+  verificationToken: "VerificationToken",
+}
+
 /**
  *
  * ## Setup
@@ -136,6 +152,22 @@ export type FaunaAccount = ToFauna<AdapterAccount>
  *
  * > 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.
@@ -191,33 +223,35 @@ export type FaunaAccount = ToFauna<AdapterAccount>
  * ```
  *
  **/
-export function FaunaAdapter(client: Client): Adapter {
+export function FaunaAdapter(client: Client, config?: AdapterConfig): Adapter {
+  const { collectionNames = defaultCollectionNames } = config || {}
+
   return {
     async createUser(user) {
       const response = await client.query<FaunaUser>(
-        fql`User.create(${format.to(user)})`,
+        fql`Collection(${collectionNames.user}).create(${format.to(user)})`,
       )
       return format.from(response.data)
     },
     async getUser(id) {
       const response = await client.query<FaunaUser | NullDocument>(
-        fql`User.byId(${id})`,
+        fql`Collection(${collectionNames.user}).byId(${id})`,
       )
       if (response.data instanceof NullDocument) return null
       return format.from(response.data)
     },
     async getUserByEmail(email) {
       const response = await client.query<FaunaUser>(
-        fql`User.byEmail(${email}).first()`,
+        fql`Collection(${collectionNames.user}).byEmail(${email}).first()`,
       )
       if (response.data === null) return null
       return format.from(response.data)
     },
     async getUserByAccount({ provider, providerAccountId }) {
       const response = await client.query<FaunaUser>(fql`
-        let account = Account.byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first()
+        let account = Collection(${collectionNames.account}).byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first()
         if (account != null) {
-          User.byId(account.userId)
+          Collection(${collectionNames.user}).byId(account.userId)
         } else {
           null
         }
@@ -228,39 +262,39 @@ export function FaunaAdapter(client: Client): Adapter {
       const _user: Partial<AdapterUser> = { ...user }
       delete _user.id
       const response = await client.query<FaunaUser>(
-        fql`User.byId(${user.id}).update(${format.to(_user)})`,
+        fql`Collection(${collectionNames.user}).byId(${user.id}).update(${format.to(_user)})`,
       )
       return format.from(response.data)
     },
     async deleteUser(userId) {
       await client.query(fql`
         // Delete the user's sessions
-        Session.byUserId(${userId}).forEach(session => session.delete())
+        Collection(${collectionNames.session}).byUserId(${userId}).forEach(session => session.delete())
         
         // Delete the user's accounts
-        Account.byUserId(${userId}).forEach(account => account.delete())
+        Collection(${collectionNames.account}).byUserId(${userId}).forEach(account => account.delete())
         
         // Delete the user
-        User.byId(${userId}).delete()
+        Collection(${collectionNames.user}).byId(${userId}).delete()
       `)
     },
     async linkAccount(account) {
       await client.query<FaunaAccount>(
-        fql`Account.create(${format.to(account)})`,
+        fql`Collection(${collectionNames.account}).create(${format.to(account)})`,
       )
       return account
     },
     async unlinkAccount({ provider, providerAccountId }) {
       const response = await client.query<FaunaAccount>(
-        fql`Account.byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first().delete()`,
+        fql`Collection(${collectionNames.account}).byProviderAndProviderAccountId(${provider}, ${providerAccountId}).first().delete()`,
       )
       return format.from<AdapterAccount>(response.data)
     },
     async getSessionAndUser(sessionToken) {
       const response = await client.query<[FaunaUser, FaunaSession]>(fql`
-        let session = Session.bySessionToken(${sessionToken}).first()
+        let session = Collection(${collectionNames.session}).bySessionToken(${sessionToken}).first()
         if (session != null) {
-          let user = User.byId(session.userId)
+          let user = Collection(${collectionNames.user}).byId(session.userId)
           if (user != null) {
             [user, session]
           } else {
@@ -276,13 +310,13 @@ export function FaunaAdapter(client: Client): Adapter {
     },
     async createSession(session) {
       await client.query<FaunaSession>(
-        fql`Session.create(${format.to(session)})`,
+        fql`Collection(${collectionNames.session}).create(${format.to(session)})`,
       )
       return session
     },
     async updateSession(session) {
       const response = await client.query<FaunaSession>(
-        fql`Session.bySessionToken(${
+        fql`Collection(${collectionNames.session}).bySessionToken(${
           session.sessionToken
         }).first().update(${format.to(session)})`,
       )
@@ -290,12 +324,12 @@ export function FaunaAdapter(client: Client): Adapter {
     },
     async deleteSession(sessionToken) {
       await client.query(
-        fql`Session.bySessionToken(${sessionToken}).first().delete()`,
+        fql`Collection(${collectionNames.session}).bySessionToken(${sessionToken}).first().delete()`,
       )
     },
     async createVerificationToken(verificationToken) {
       await client.query<FaunaVerificationToken>(
-        fql`VerificationToken.create(${format.to(
+        fql`Collection(${collectionNames.verificationToken}).create(${format.to(
           verificationToken,
         )})`,
       )
@@ -303,12 +337,12 @@ export function FaunaAdapter(client: Client): Adapter {
     },
     async useVerificationToken({ identifier, token }) {
       const response = await client.query<FaunaVerificationToken>(
-        fql`VerificationToken.byIdentifierAndToken(${identifier}, ${token}).first()`,
+        fql`Collection(${collectionNames.verificationToken}).byIdentifierAndToken(${identifier}, ${token}).first()`,
       )
       if (response.data === null) return null
       // Delete the verification token so it can only be used once
       await client.query(
-        fql`VerificationToken.byId(${response.data.id}).delete()`,
+        fql`Collection(${collectionNames.verificationToken}).byId(${response.data.id}).delete()`,
       )
       const _verificationToken: Partial<FaunaVerificationToken> = { ...response.data }
       delete _verificationToken.id