@auth/firebase-adapter 1.6.0 → 2.1.0

package/README.md

@@ -1,7 +1,7 @@
 <p align="center">
   <br/>
   <a href="https://authjs.dev" target="_blank">
-    <img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" />
+    <img height="64px" src="https://authjs.dev/img/logo-sm.png" />
   </a>
   <a href="https://firebase.google.com" target="_blank">
     <img height="64px" src="https://authjs.dev/img/adapters/firebase.svg"/>
@@ -18,7 +18,7 @@
       <img src="https://img.shields.io/npm/dm/@auth/firebase-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

@@ -41,77 +41,6 @@ export interface FirebaseAdapterConfig extends AppOptions {
      */
     namingStrategy?: "snake_case" | "default";
 }
-/**
- * ## Setup
- *
- * First, create a Firebase project and generate a service account key. Visit: `https://console.firebase.google.com/u/0/project/{project-id}/settings/serviceaccounts/adminsdk` (replace `{project-id}` with your project's id)
- *
- * Now you have a few options to authenticate with the Firebase Admin SDK in your app:
- *
- * ### Environment variables
- *  - 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 "@auth/firebase-adapter"
- *
- * export default NextAuth({
- *   adapter: FirestoreAdapter(),
- *   // ...
- * })
- * ```
- *
- * ### Service account values
- *
- * - 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 "@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,
- *    })
- *  })
- *  // ...
- * })
- * ```
- *
- * ### Using 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 "@auth/firebase-adapter"
- * import { firestore } from "lib/firestore"
- *
- * export default NextAuth({
- *  adapter: FirestoreAdapter(firestore),
- *  // ...
- * })
- * ```
- */
 export declare function FirestoreAdapter(config?: FirebaseAdapterConfig | Firestore): Adapter;
 /**
  * Utility function that helps making sure that there is no duplicate app initialization issues in serverless environments.

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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,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;;;;;;;;;;;;;;;;;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"}

package/index.js

@@ -13,77 +13,6 @@
  */
 import { getApps, initializeApp } from "firebase-admin/app";
 import { Firestore, getFirestore, initializeFirestore, Timestamp, } from "firebase-admin/firestore";
-/**
- * ## Setup
- *
- * First, create a Firebase project and generate a service account key. Visit: `https://console.firebase.google.com/u/0/project/{project-id}/settings/serviceaccounts/adminsdk` (replace `{project-id}` with your project's id)
- *
- * Now you have a few options to authenticate with the Firebase Admin SDK in your app:
- *
- * ### Environment variables
- *  - 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 "@auth/firebase-adapter"
- *
- * export default NextAuth({
- *   adapter: FirestoreAdapter(),
- *   // ...
- * })
- * ```
- *
- * ### Service account values
- *
- * - 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 "@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,
- *    })
- *  })
- *  // ...
- * })
- * ```
- *
- * ### Using 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 "@auth/firebase-adapter"
- * import { firestore } from "lib/firestore"
- *
- * export default NextAuth({
- *  adapter: FirestoreAdapter(firestore),
- *  // ...
- * })
- * ```
- */
 export function FirestoreAdapter(config) {
     const { db, namingStrategy = "default" } = config instanceof Firestore
         ? { db: config }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/firebase-adapter",
-  "version": "1.6.0",
+  "version": "2.1.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.29.0"
+    "@auth/core": "0.31.0"
   },
   "peerDependencies": {
     "firebase-admin": "^11.4.1"

package/src/index.ts

@@ -57,77 +57,6 @@ export interface FirebaseAdapterConfig extends AppOptions {
   namingStrategy?: "snake_case" | "default"
 }
 
-/**
- * ## Setup
- *
- * First, create a Firebase project and generate a service account key. Visit: `https://console.firebase.google.com/u/0/project/{project-id}/settings/serviceaccounts/adminsdk` (replace `{project-id}` with your project's id)
- *
- * Now you have a few options to authenticate with the Firebase Admin SDK in your app:
- *
- * ### Environment variables
- *  - 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 "@auth/firebase-adapter"
- *
- * export default NextAuth({
- *   adapter: FirestoreAdapter(),
- *   // ...
- * })
- * ```
- *
- * ### Service account values
- *
- * - 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 "@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,
- *    })
- *  })
- *  // ...
- * })
- * ```
- *
- * ### Using 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 "@auth/firebase-adapter"
- * import { firestore } from "lib/firestore"
- *
- * export default NextAuth({
- *  adapter: FirestoreAdapter(firestore),
- *  // ...
- * })
- * ```
- */
 export function FirestoreAdapter(
   config?: FirebaseAdapterConfig | Firestore
 ): Adapter {