@auth/firebase-adapter 2.5.2 → 2.6.0

package/index.d.ts

@@ -29,17 +29,30 @@ export interface FirebaseAdapterConfig extends AppOptions {
      *
      *
      * @example
-     * ```ts title="pages/api/auth/[...nextauth].ts"
-     * import NextAuth from "next-auth"
-     * import { FirestoreAdapter } from "@auth/firebase-adapter"
-     *
-     * export default NextAuth({
+     * ```ts
+     *  // This will convert all field and collection names to snake_case
      *  adapter: FirestoreAdapter({ namingStrategy: "snake_case" })
      *  // ...
      * })
      * ```
      */
     namingStrategy?: "snake_case" | "default";
+    /**
+     * Use this option if you already have one of the default collections in your Firestore database.
+     *
+     * @example
+     * ```ts
+     *  // This will use the collection name "authjs_users" instead of the default "users"
+     *  adapter: FirestoreAdapter({ collections: { users: "authjs_users" } })
+     *  // ...
+     * ```
+     */
+    collections?: {
+        users?: string;
+        sessions?: string;
+        accounts?: string;
+        verificationTokens?: string;
+    };
 }
 export declare function FirestoreAdapter(config?: FirebaseAdapterConfig | Firestore): Adapter;
 /**

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,KAAK,UAAU,EAA0B,MAAM,oBAAoB,CAAA;AAE5E,OAAO,EACL,SAAS,EAIV,MAAM,0BAA0B,CAAA;AAEjC,OAAO,KAAK,EACV,OAAO,EAKR,MAAM,qBAAqB,CAAA;AAE5B,sCAAsC;AACtC,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;CAC1C;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,CAAC,EAAE,qBAAqB,GAAG,SAAS,GACzC,OAAO,CAgKT;AA8HD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,OAAO,GAAE,UAAU,GAAG;IAAE,IAAI,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAA;CAAO,aAQpE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,KAAK,UAAU,EAA0B,MAAM,oBAAoB,CAAA;AAE5E,OAAO,EACL,SAAS,EAIV,MAAM,0BAA0B,CAAA;AAEjC,OAAO,KAAK,EACV,OAAO,EAKR,MAAM,qBAAqB,CAAA;AAE5B,sCAAsC;AACtC,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACzC;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE;QACZ,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAC5B,CAAA;CACF;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,CAAC,EAAE,qBAAqB,GAAG,SAAS,GACzC,OAAO,CA2KT;AA2HD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,OAAO,GAAE,UAAU,GAAG;IAAE,IAAI,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAA;CAAO,aAQpE"}

package/index.js

@@ -14,11 +14,19 @@
 import { getApps, initializeApp } from "firebase-admin/app";
 import { Firestore, getFirestore, initializeFirestore, Timestamp, } from "firebase-admin/firestore";
 export function FirestoreAdapter(config) {
-    const { db, namingStrategy = "default" } = config instanceof Firestore
+    const { db, namingStrategy = "default", collections = {}, } = config instanceof Firestore
         ? { db: config }
         : { ...config, db: config?.firestore ?? initFirestore(config) };
     const preferSnakeCase = namingStrategy === "snake_case";
-    const C = collectionsFactory(db, preferSnakeCase);
+    const C = collectionsFactory(db, preferSnakeCase, {
+        users: "users",
+        sessions: "sessions",
+        accounts: "accounts",
+        verificationTokens: preferSnakeCase
+            ? "verification_tokens"
+            : "verificationTokens",
+        ...collections,
+    });
     const mapper = mapFieldsFactory(preferSnakeCase);
     return {
         async createUser(userInit) {
@@ -154,9 +162,8 @@ export function mapFieldsFactory(preferSnakeCase) {
     }
     return { toDb: identity, fromDb: identity };
 }
-/** @internal */
 function getConverter(options) {
-    const mapper = mapFieldsFactory(options?.preferSnakeCase ?? false);
+    const mapper = mapFieldsFactory(options?.preferSnakeCase);
     return {
         toFirestore(object) {
             const document = {};
@@ -194,7 +201,6 @@ export async function getOneDoc(querySnapshot) {
     const querySnap = await querySnapshot.limit(1).get();
     return querySnap.docs[0]?.data() ?? null;
 }
-/** @internal */
 async function deleteDocs(querySnapshot) {
     const querySnap = await querySnapshot.get();
     for (const doc of querySnap.docs) {
@@ -207,19 +213,19 @@ export async function getDoc(docRef) {
     return docSnap.data() ?? null;
 }
 /** @internal */
-export function collectionsFactory(db, preferSnakeCase = false) {
+export function collectionsFactory(db, preferSnakeCase = false, collections) {
     return {
         users: db
-            .collection("users")
+            .collection(collections.users)
             .withConverter(getConverter({ preferSnakeCase })),
         sessions: db
-            .collection("sessions")
+            .collection(collections.sessions)
             .withConverter(getConverter({ preferSnakeCase })),
         accounts: db
-            .collection("accounts")
+            .collection(collections.accounts)
             .withConverter(getConverter({ preferSnakeCase })),
         verification_tokens: db
-            .collection(preferSnakeCase ? "verification_tokens" : "verificationTokens")
+            .collection(collections.verificationTokens)
             .withConverter(getConverter({ preferSnakeCase, excludeId: true })),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/firebase-adapter",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "description": "Firebase adapter for Auth.js",
   "homepage": "https://authjs.dev",
   "repository": "https://github.com/nextauthjs/next-auth",
@@ -37,7 +37,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@auth/core": "0.35.2"
+    "@auth/core": "0.36.0"
   },
   "peerDependencies": {
     "firebase-admin": "^12.0.0"

package/src/index.ts

@@ -44,29 +44,53 @@ export interface FirebaseAdapterConfig extends AppOptions {
    *
    *
    * @example
-   * ```ts title="pages/api/auth/[...nextauth].ts"
-   * import NextAuth from "next-auth"
-   * import { FirestoreAdapter } from "@auth/firebase-adapter"
-   *
-   * export default NextAuth({
+   * ```ts
+   *  // This will convert all field and collection names to snake_case
    *  adapter: FirestoreAdapter({ namingStrategy: "snake_case" })
    *  // ...
    * })
    * ```
    */
   namingStrategy?: "snake_case" | "default"
+  /**
+   * Use this option if you already have one of the default collections in your Firestore database.
+   *
+   * @example
+   * ```ts
+   *  // This will use the collection name "authjs_users" instead of the default "users"
+   *  adapter: FirestoreAdapter({ collections: { users: "authjs_users" } })
+   *  // ...
+   * ```
+   */
+  collections?: {
+    users?: string
+    sessions?: string
+    accounts?: string
+    verificationTokens?: string
+  }
 }
 
 export function FirestoreAdapter(
   config?: FirebaseAdapterConfig | Firestore
 ): Adapter {
-  const { db, namingStrategy = "default" } =
-    config instanceof Firestore
-      ? { db: config }
-      : { ...config, db: config?.firestore ?? initFirestore(config) }
+  const {
+    db,
+    namingStrategy = "default",
+    collections = {},
+  } = config instanceof Firestore
+    ? { db: config }
+    : { ...config, db: config?.firestore ?? initFirestore(config) }
 
   const preferSnakeCase = namingStrategy === "snake_case"
-  const C = collectionsFactory(db, preferSnakeCase)
+  const C = collectionsFactory(db, preferSnakeCase, {
+    users: "users",
+    sessions: "sessions",
+    accounts: "accounts",
+    verificationTokens: preferSnakeCase
+      ? "verification_tokens"
+      : "verificationTokens",
+    ...collections,
+  })
   const mapper = mapFieldsFactory(preferSnakeCase)
 
   return {
@@ -247,12 +271,11 @@ export function mapFieldsFactory(preferSnakeCase?: boolean) {
   return { toDb: identity, fromDb: identity }
 }
 
-/** @internal */
 function getConverter<Document extends Record<string, any>>(options: {
   excludeId?: boolean
   preferSnakeCase?: boolean
 }): FirebaseFirestore.FirestoreDataConverter<Document> {
-  const mapper = mapFieldsFactory(options?.preferSnakeCase ?? false)
+  const mapper = mapFieldsFactory(options?.preferSnakeCase)
 
   return {
     toFirestore(object) {
@@ -302,7 +325,6 @@ export async function getOneDoc<T>(
   return querySnap.docs[0]?.data() ?? null
 }
 
-/** @internal */
 async function deleteDocs<T>(
   querySnapshot: FirebaseFirestore.Query<T>
 ): Promise<void> {
@@ -323,22 +345,21 @@ export async function getDoc<T>(
 /** @internal */
 export function collectionsFactory(
   db: FirebaseFirestore.Firestore,
-  preferSnakeCase = false
+  preferSnakeCase = false,
+  collections: Required<NonNullable<FirebaseAdapterConfig["collections"]>>
 ) {
   return {
     users: db
-      .collection("users")
+      .collection(collections.users)
       .withConverter(getConverter<AdapterUser>({ preferSnakeCase })),
     sessions: db
-      .collection("sessions")
+      .collection(collections.sessions)
       .withConverter(getConverter<AdapterSession>({ preferSnakeCase })),
     accounts: db
-      .collection("accounts")
+      .collection(collections.accounts)
       .withConverter(getConverter<AdapterAccount>({ preferSnakeCase })),
     verification_tokens: db
-      .collection(
-        preferSnakeCase ? "verification_tokens" : "verificationTokens"
-      )
+      .collection(collections.verificationTokens)
       .withConverter(
         getConverter<VerificationToken>({ preferSnakeCase, excludeId: true })
       ),