nestjs-firebase-admin 0.5.9 → 0.6.1

package/README.md

@@ -2,7 +2,15 @@
   <img src="art/logo.png" alt="nestjs-firebase-admin logo" width="200">
 </p>
 
+<h1 align="center">nestjs-firebase-admin</h1>
+
+<p align="center">
+  Firebase Admin SDK module for <a href="https://nestjs.com/">NestJS</a> — injectable services for Auth, Firestore, Realtime Database, and Cloud Messaging.
+</p>
+
 <p align="center">
+  <a href="https://www.npmjs.com/package/nestjs-firebase-admin"><img src="https://img.shields.io/npm/v/nestjs-firebase-admin.svg" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/nestjs-firebase-admin"><img src="https://img.shields.io/npm/dm/nestjs-firebase-admin.svg" alt="npm downloads"></a>
   <a href="https://codecov.io/gh/hebertcisco/nestjs-firebase-admin">
     <img src="https://codecov.io/gh/hebertcisco/nestjs-firebase-admin/branch/main/graph/badge.svg?token=N0IW1UNNIP" alt="codecov">
   </a>
@@ -12,90 +20,139 @@
   <a href="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml">
     <img src="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml/badge.svg" alt="Running Code Coverage">
   </a>
-  <img src="https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white" alt="TypeScript">
-  <img src="https://img.shields.io/badge/Nestjs-ea2845?style=flat&logo=nestjs&logoColor=white" alt="Nestjs">
-  <img src="https://img.shields.io/badge/VS_Code-0078D4?style=flat&logo=visual%20studio%20code&logoColor=white" alt="VS Code">
-  <img src="https://img.shields.io/badge/github%20actions-%232671E5.svg?style=flat&logo=githubactions&logoColor=white" alt="GitHub Actions">
 </p>
 
-> Firebase Admin SDK for NestJS :fire:
+## Features
 
-## Requirements
-
-- **Node.js**: >= 20
-- **NPM**: >= 10
-- **NestJS**: >= 7.0.0
+- **AdminService** — Firebase app initialization and lifecycle management
+- **AuthService** — Create, update, delete users; verify ID tokens; manage custom claims
+- **FirestoreService** — Typed CRUD, collection queries, batch writes, transactions
+- **DatabaseService** — Realtime Database read, write, push, update, remove, and listeners
+- **MessagingService** — Send to device tokens, topics, and conditions; manage subscriptions
+- Sync (`register`) and async (`registerAsync`) module registration
+- Compatible with **NestJS 7 – 11** and **Firebase Admin 13+**
+- TypeScript-first with full type support
 
 ## Installation
 
-Install the package using `yarn`, `npm`, or `pnpm`:
-
 ```bash
-# yarn
-yarn add nestjs-firebase-admin
-```
-
-```bash
-# npm
 npm i nestjs-firebase-admin --save
 ```
 
+<details>
+<summary>yarn / pnpm</summary>
+
 ```bash
-# pnpm
-pnpm add nestjs-firebase-admin --save
+yarn add nestjs-firebase-admin
 ```
 
-## Testing
-
-To run tests, use the following commands:
-
-### Unit Tests
-
 ```bash
-npm test
+pnpm add nestjs-firebase-admin
 ```
 
-### Coverage Tests
+</details>
+
+## Quick start
+
+Import `AdminModule` in your root or feature module:
+
+```ts
+import { Module } from '@nestjs/common';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+@Module({
+  imports: [
+    AdminModule.register({
+      credential: {
+        projectId: 'my-project-id',
+        clientEmail: 'my-client-email',
+        privateKey: 'my-private-key',
+      },
+      databaseURL: 'https://my-project-id.firebaseio.com',
+    }),
+  ],
+})
+export class AppModule {}
+```
 
-```bash
-npm run test:cov
+### Async configuration
+
+Use `registerAsync` to load credentials from `ConfigService` or any other provider:
+
+```ts
+import { Module } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+@Module({
+  imports: [
+    AdminModule.registerAsync({
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => ({
+        credential: {
+          projectId: config.get('FIREBASE_PROJECT_ID'),
+          clientEmail: config.get('FIREBASE_CLIENT_EMAIL'),
+          privateKey: config.get('FIREBASE_PRIVATE_KEY'),
+        },
+        databaseURL: config.get('FIREBASE_DATABASE_URL'),
+      }),
+    }),
+  ],
+})
+export class AppModule {}
 ```
 
-### Watch Mode Tests
+## Usage examples
 
-```bash
-npm run test:watch
-```
+Once `AdminModule` is imported, inject any service:
 
-### Debug Tests
+```ts
+import { Injectable } from '@nestjs/common';
+import { AuthService, FirestoreService } from 'nestjs-firebase-admin';
 
-```bash
-npm run test:debug
-```
+@Injectable()
+export class UsersService {
+  constructor(
+    private readonly auth: AuthService,
+    private readonly firestore: FirestoreService,
+  ) {}
 
-## Available Scripts
+  async createUser(email: string, password: string) {
+    const user = await this.auth.createUser({ email, password });
+    await this.firestore.set(`users/${user.uid}`, { email, createdAt: new Date() });
+    return user;
+  }
 
-The available scripts in `package.json` include:
+  async getUser(uid: string) {
+    return this.firestore.get(`users/${uid}`);
+  }
+}
+```
 
-- **Build**: `npm run build`
-- **Lint**: `npm run lint`
-- **Format**: `npm run format`
-- **Release**: `npm run release`
+## Requirements
 
-## Contributing
+| Dependency | Version |
+|-----------|---------|
+| Node.js | >= 20 |
+| NestJS | >= 7.0.0 |
+| firebase-admin | >= 13.0.0 |
 
-Contributions, issues, and feature requests are welcome!<br />Feel free to check the [issues page](https://github.com/hebertcisco/nestjs-firebase-admin/issues).
+## Documentation
 
-## Show Your Support
+Full documentation is available at **[hebertcisco.github.io/nestjs-firebase-admin](https://hebertcisco.github.io/nestjs-firebase-admin/)**.
 
-Give a ⭐️ if this project helped you!
+- [Getting Started](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/getting-started)
+- [Admin Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/admin-service)
+- [Auth Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/auth-service)
+- [Firestore Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/firestore-service)
+- [Database Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/database-service)
+- [Messaging Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/messaging-service)
+- [Testing](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/testing)
 
-Or buy the author a coffee 🙌🏾
+## Contributing
 
-<a href="https://www.buymeacoffee.com/hebertcisco">
-    <img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=hebertcisco&button_colour=FFDD00&font_colour=000000&font_family=Inter&outline_colour=000000&coffee_colour=ffffff" />
-</a>
+Contributions, issues, and feature requests are welcome! Check the [issues page](https://github.com/hebertcisco/nestjs-firebase-admin/issues) or read the [contributing guide](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/contributing).
 
-## 📝 License
+## License
 
-This project is under the [MIT](LICENSE) license.
+[MIT](LICENSE)

package/_coverpage.md

@@ -0,0 +1,13 @@
+![logo](art/logo.png ':size=120')
+
+# nestjs-firebase-admin
+
+> Firebase Admin SDK module for NestJS
+
+- Injectable services for Auth, Firestore, Database, and Messaging
+- Sync and async module registration
+- TypeScript-first with full type support
+- Compatible with NestJS 7 through 11
+
+[Get Started](docs/getting-started.md)
+[GitHub](https://github.com/hebertcisco/nestjs-firebase-admin)

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './modules/admin/admin.module';
 export * from './modules/admin/services/admin.service';
+export * from './modules/admin/services/auth.service';
 export * from './modules/admin/services/database.service';
 export * from './modules/admin/services/messaging.service';
 export * from './modules/admin/services/firestore.service';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./modules/admin/admin.module"), exports);
 __exportStar(require("./modules/admin/services/admin.service"), exports);
+__exportStar(require("./modules/admin/services/auth.service"), exports);
 __exportStar(require("./modules/admin/services/database.service"), exports);
 __exportStar(require("./modules/admin/services/messaging.service"), exports);
 __exportStar(require("./modules/admin/services/firestore.service"), exports);

package/dist/modules/admin/admin.module.js

@@ -69,15 +69,10 @@ let AdminModule = AdminModule_1 = class AdminModule {
         };
     }
     static registerAsync(options) {
-        if (!options.useFactory) {
-            throw new Error('useFactory is required in registerAsync options');
+        if (!options.useFactory && !options.useExisting && !options.useClass) {
+            throw new Error('One of useFactory, useExisting, or useClass must be provided in AdminModuleAsyncOptions');
         }
         const providers = [
-            {
-                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
-                useFactory: options.useFactory,
-                inject: options.inject || [],
-            },
             admin_service_1.AdminService,
             database_service_1.DatabaseService,
             messaging_service_1.MessagingService,
@@ -89,6 +84,11 @@ let AdminModule = AdminModule_1 = class AdminModule {
             },
         ];
         if (options.useFactory) {
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            });
             const factory = options.useFactory;
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
@@ -105,12 +105,14 @@ let AdminModule = AdminModule_1 = class AdminModule {
             });
         }
         else if (options.useExisting) {
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
+                inject: [options.useExisting],
+            });
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
-                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
-                    const config = yield optionsFactory.createAdminOptions();
-                    return config;
-                }),
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
                 inject: [options.useExisting],
             });
             providers.push({
@@ -127,12 +129,14 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 provide: options.useClass,
                 useClass: options.useClass,
             });
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
+                inject: [options.useClass],
+            });
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
-                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
-                    const config = yield optionsFactory.createAdminOptions();
-                    return config;
-                }),
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
                 inject: [options.useClass],
             });
             providers.push({
@@ -144,9 +148,6 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 inject: [options.useClass],
             });
         }
-        else {
-            throw new Error('One of useFactory, useExisting, or useClass must be provided in AdminModuleAsyncOptions');
-        }
         return {
             module: AdminModule_1,
             imports: options.imports || [],

package/dist/modules/admin/services/messaging.service.js

@@ -39,7 +39,7 @@ let MessagingService = class MessagingService {
     sendToDevices(tokens, payload) {
         return __awaiter(this, void 0, void 0, function* () {
             const message = Object.assign({ tokens }, payload);
-            const response = yield this.messaging.sendMulticast(message);
+            const response = yield this.messaging.sendEachForMulticast(message);
             return response;
         });
     }

package/docs/getting-started.md

@@ -55,18 +55,20 @@ If you need asynchronous configuration, use the `registerAsync` method:
 
 ```ts
 import { Module } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
 import { AdminModule } from 'nestjs-firebase-admin';
 
 @Module({
   imports: [
     AdminModule.registerAsync({
-      useFactory: async () => ({
+      inject: [ConfigService],
+      useFactory: async (config: ConfigService) => ({
         credential: {
-          projectId: 'my-project-id',
-          clientEmail: 'my-client-email',
-          privateKey: 'my-private-key',
+          projectId: config.get('FIREBASE_PROJECT_ID'),
+          clientEmail: config.get('FIREBASE_CLIENT_EMAIL'),
+          privateKey: config.get('FIREBASE_PRIVATE_KEY'),
         },
-        databaseURL: 'https://my-project-id.firebaseio.com',
+        databaseURL: config.get('FIREBASE_DATABASE_URL'),
       }),
     }),
   ],
@@ -74,9 +76,18 @@ import { AdminModule } from 'nestjs-firebase-admin';
 export class AppModule {}
 ```
 
+You can also use `useClass` or `useExisting` for more advanced scenarios:
+
+```ts
+AdminModule.registerAsync({
+  useClass: FirebaseConfigService,
+})
+```
+
 ## Next Steps
 
 - Learn about the [Admin Service](services/admin-service.md)
+- Manage users with the [Auth Service](services/auth-service.md)
 - Explore the [Database Service](services/database-service.md)
 - Check out the [Firestore Service](services/firestore-service.md)
 - Discover the [Messaging Service](services/messaging-service.md)

package/docs/services/admin-service.md

@@ -56,6 +56,9 @@ export class FirebaseService {
 | `deleteApp(app)` | Deletes a Firebase app instance | [Delete App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#deleteapp) |
 | `applicationDefault(httpAgent?)` | Gets default credentials | [Application Default](https://firebase.google.com/docs/reference/admin/node/firebase-admin.credential#applicationdefault) |
 | `admin()` | Gets the Firebase Admin SDK instance | [Admin SDK](https://firebase.google.com/docs/admin/setup) |
+| `appRef` | Gets the initialized app instance reference | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
+| `initializeApp()` | Returns the initialized app instance | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
+| `initializeAppObservable()` | Creates an Observable that emits the app instance | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
 
 ## Configuration
 

package/docs/services/messaging-service.md

@@ -5,10 +5,9 @@ The `MessagingService` provides a clean and type-safe interface for sending mess
 ## Features
 
 - Send messages to individual devices
-- Send multicast messages to multiple devices
-- Topic messaging
-- Conditional messaging
-- Message customization
+- Send messages to multiple devices
+- Topic messaging and subscription management
+- Message customization per platform (Android, iOS, Web)
 - TypeScript type support
 
 ## Usage Example
@@ -23,8 +22,7 @@ export class NotificationService {
 
   // Send a message to a single device
   async sendToDevice(deviceToken: string, title: string, body: string) {
-    await this.messagingService.send({
-      token: deviceToken,
+    return this.messagingService.sendToDevice(deviceToken, {
       notification: {
         title,
         body,
@@ -34,8 +32,7 @@ export class NotificationService {
 
   // Send a message to multiple devices
   async sendToDevices(deviceTokens: string[], title: string, body: string) {
-    await this.messagingService.sendMulticast({
-      tokens: deviceTokens,
+    return this.messagingService.sendToDevices(deviceTokens, {
       notification: {
         title,
         body,
@@ -45,8 +42,7 @@ export class NotificationService {
 
   // Send a message to a topic
   async sendToTopic(topic: string, title: string, body: string) {
-    await this.messagingService.send({
-      topic,
+    return this.messagingService.sendToTopic(topic, {
       notification: {
         title,
         body,
@@ -56,12 +52,12 @@ export class NotificationService {
 
   // Subscribe devices to a topic
   async subscribeToTopic(topic: string, deviceTokens: string[]) {
-    await this.messagingService.subscribeToTopic(deviceTokens, topic);
+    return this.messagingService.subscribeToTopic(deviceTokens, topic);
   }
 
   // Unsubscribe devices from a topic
   async unsubscribeFromTopic(topic: string, deviceTokens: string[]) {
-    await this.messagingService.unsubscribeFromTopic(deviceTokens, topic);
+    return this.messagingService.unsubscribeFromTopic(deviceTokens, topic);
   }
 }
 ```
@@ -70,8 +66,9 @@ export class NotificationService {
 
 | Method | Description | Documentation |
 |--------|-------------|---------------|
-| `send(message)` | Sends a message to a device or topic | [Send Messages](https://firebase.google.com/docs/cloud-messaging/send-message) |
-| `sendMulticast(message)` | Sends a message to multiple devices | [Send Multicast](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-multiple-devices) |
+| `sendToDevice(token, payload)` | Sends a message to a single device | [Send Messages](https://firebase.google.com/docs/cloud-messaging/send-message) |
+| `sendToDevices(tokens, payload)` | Sends a message to multiple devices | [Send Multicast](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-multiple-devices) |
+| `sendToTopic(topic, payload)` | Sends a message to a topic | [Topic Messaging](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-topics) |
 | `subscribeToTopic(tokens, topic)` | Subscribes devices to a topic | [Topic Management](https://firebase.google.com/docs/cloud-messaging/manage-topics) |
 | `unsubscribeFromTopic(tokens, topic)` | Unsubscribes devices from a topic | [Topic Management](https://firebase.google.com/docs/cloud-messaging/manage-topics) |
 
@@ -82,6 +79,6 @@ The service supports various message types:
 - **Notification Messages**: Simple messages with title and body
 - **Data Messages**: Custom key-value pairs
 - **Combined Messages**: Both notification and data
-- **Android Messages**: Android-specific configurations
-- **APNS Messages**: iOS-specific configurations
-- **Webpush Messages**: Web-specific configurations
+- **Android Messages**: Android-specific configurations (priority, TTL, channel)
+- **APNS Messages**: iOS-specific configurations (sound, badge, alert)
+- **Webpush Messages**: Web-specific configurations (headers, icons, actions)

package/index.html

@@ -1,19 +1,65 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 
 <head>
     <meta charset="UTF-8">
-    <title>NestJS Firebase Admin</title>
+    <title>NestJS Firebase Admin — Firebase Admin SDK module for NestJS</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
-    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
-    <link rel="icon" type="image/png"
-        href="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
+
+    <!-- SEO -->
     <meta name="description"
-        content="NestJS Firebase Admin is a NestJS module that provides a simple and efficient way to integrate Firebase Admin SDK into your NestJS applications.">
-    <meta name="keywords" content="NestJS, Firebase, Admin SDK, Module, Integration">
+        content="NestJS Firebase Admin is a NestJS module that wraps the Firebase Admin SDK, providing injectable services for Auth, Firestore, Realtime Database, and Cloud Messaging in your NestJS applications.">
+    <meta name="keywords"
+        content="NestJS, Firebase, Admin SDK, NestJS module, Firebase Auth, Firestore, Realtime Database, Cloud Messaging, FCM, TypeScript, Node.js, serverless, backend, nestjs-firebase-admin">
     <meta name="author" content="Hebert Cisco">
+    <meta name="robots" content="index, follow">
+    <link rel="canonical" href="https://hebertcisco.github.io/nestjs-firebase-admin/" />
+
+    <!-- Open Graph -->
+    <meta property="og:type" content="website" />
+    <meta property="og:title" content="NestJS Firebase Admin — Firebase Admin SDK module for NestJS" />
+    <meta property="og:description"
+        content="Injectable NestJS services for Firebase Auth, Firestore, Realtime Database, and Cloud Messaging. TypeScript-first with sync and async module registration." />
+    <meta property="og:url" content="https://hebertcisco.github.io/nestjs-firebase-admin/" />
+    <meta property="og:image"
+        content="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
+    <meta property="og:site_name" content="nestjs-firebase-admin" />
+
+    <!-- Twitter Card -->
+    <meta name="twitter:card" content="summary" />
+    <meta name="twitter:title" content="NestJS Firebase Admin — Firebase Admin SDK module for NestJS" />
+    <meta name="twitter:description"
+        content="Injectable NestJS services for Firebase Auth, Firestore, Realtime Database, and Cloud Messaging." />
+    <meta name="twitter:image"
+        content="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
+
+    <!-- Theme -->
     <meta name="theme-color" content="#1E2830">
+    <link rel="icon" type="image/png"
+        href="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+
+    <!-- Structured Data (JSON-LD) -->
+    <script type="application/ld+json">
+    {
+        "@context": "https://schema.org",
+        "@type": "SoftwareSourceCode",
+        "name": "nestjs-firebase-admin",
+        "description": "NestJS module that wraps the Firebase Admin SDK, providing injectable services for Auth, Firestore, Realtime Database, and Cloud Messaging.",
+        "url": "https://hebertcisco.github.io/nestjs-firebase-admin/",
+        "codeRepository": "https://github.com/hebertcisco/nestjs-firebase-admin",
+        "programmingLanguage": "TypeScript",
+        "runtimePlatform": "Node.js",
+        "license": "https://opensource.org/licenses/MIT",
+        "author": {
+            "@type": "Person",
+            "name": "Hebert Cisco",
+            "url": "https://github.com/hebertcisco"
+        },
+        "keywords": ["NestJS", "Firebase", "Admin SDK", "Firestore", "Auth", "Cloud Messaging", "TypeScript"]
+    }
+    </script>
 </head>
 
 <body>
@@ -21,19 +67,20 @@
     <script>
         window.$docsify = {
             name: 'NestJS Firebase Admin',
+            nameLink: '/',
             repo: 'hebertcisco/nestjs-firebase-admin',
-            subMaxLevel: 3,
+            coverpage: '_coverpage.md',
             loadSidebar: 'docs/_sidebar.md',
             auto2top: true,
             subMaxLevel: 3,
             maxLevel: 3,
             themeColor: '#1E2830',
             noCompileLinks: ['benchmarks/.*'],
+            externalLinkTarget: '_blank',
             search: {
                 placeholder: 'Search documentation...',
                 maxAge: 86400000,
                 paths: 'auto',
-                placeholder: 'Search',
                 noData: 'No results found!',
                 depth: 6
             },
@@ -52,9 +99,9 @@
             ]
         }
     </script>
-    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
 </body>
 
 </html>

package/llms.txt

@@ -0,0 +1,68 @@
+# nestjs-firebase-admin
+
+> Firebase Admin SDK module for NestJS
+
+nestjs-firebase-admin is a NestJS module that wraps the Firebase Admin SDK into injectable, testable services. It supports NestJS 7-11 and Firebase Admin 13+.
+
+## Install
+
+```bash
+npm i nestjs-firebase-admin --save
+```
+
+## Quick start
+
+```ts
+import { Module } from '@nestjs/common';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+@Module({
+  imports: [
+    AdminModule.register({
+      credential: {
+        projectId: 'my-project-id',
+        clientEmail: 'my-client-email',
+        privateKey: 'my-private-key',
+      },
+      databaseURL: 'https://my-project-id.firebaseio.com',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Use `AdminModule.registerAsync()` with `useFactory`, `useClass`, or `useExisting` for dynamic configuration (e.g. from `ConfigService`).
+
+## Services
+
+After importing `AdminModule`, inject any of these services:
+
+- **AdminService** — Firebase app initialization, lifecycle management, credential access.
+- **AuthService** — User management: create, update, delete, verify ID tokens, manage custom claims.
+- **DatabaseService** — Firebase Realtime Database: read, write, push, update, remove, and listen to refs.
+- **FirestoreService** — Cloud Firestore: typed CRUD, collection queries, batch writes, transactions.
+- **MessagingService** — Firebase Cloud Messaging: send to device tokens, topics, conditions; manage topic subscriptions.
+
+## Requirements
+
+- Node.js >= 20
+- NestJS >= 7.0.0
+- firebase-admin >= 13.0.0
+
+## Links
+
+- Docs: https://hebertcisco.github.io/nestjs-firebase-admin/
+- Repository: https://github.com/hebertcisco/nestjs-firebase-admin
+- npm: https://www.npmjs.com/package/nestjs-firebase-admin
+- Issues: https://github.com/hebertcisco/nestjs-firebase-admin/issues
+
+## Detailed docs
+
+- [Getting started](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/getting-started)
+- [Admin Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/admin-service)
+- [Auth Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/auth-service)
+- [Database Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/database-service)
+- [Firestore Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/firestore-service)
+- [Messaging Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/messaging-service)
+- [Testing](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/testing)
+- [Contributing](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/contributing)

package/package.json

@@ -1,10 +1,25 @@
 {
   "name": "nestjs-firebase-admin",
-  "version": "0.5.9",
+  "version": "0.6.1",
   "description": "Firebase Admin SDK for Nestjs",
-  "author": "Hebert Cisco",
+  "author": "hebertcisco <hebertcisco@outlook.com>",
   "license": "MIT",
+  "homepage": "https://hebertcisco.github.io/nestjs-firebase-admin/",
   "url": "https://github.com/hebertcisco/nestjs-firebase-admin#readme",
+  "keywords": [
+    "nestjs",
+    "firebase",
+    "firebase-admin",
+    "nestjs-module",
+    "firebase-auth",
+    "firestore",
+    "realtime-database",
+    "cloud-messaging",
+    "fcm",
+    "typescript",
+    "nestjs-firebase",
+    "admin-sdk"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
@@ -18,8 +33,6 @@
     "prepublish:next": "npm run build",
     "publish:next": "npm publish --access public --tag next",
     "test:e2e": "npx jest --config ./tests/jest-e2e.json --runInBand",
-    "prerelease": "npm run build",
-    "release": "release-it",
     "prepare": "npm run build",
     "test": "npx jest",
     "test:watch": "npx jest --watch",
@@ -30,21 +43,17 @@
     "version": "npm run format && git add -A lib",
     "postversion": "git push && git push --tags"
   },
-  "dependencies": {
-    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1",
-    "@nestjs/core": "10.4.13",
-    "@nestjs/platform-express": "^10.4.17",
-    "firebase-admin": "12.7.0",
-    "nest-shared": "^5.0.6"
-  },
   "engines": {
     "node": ">=20",
     "npm": ">=10"
   },
+  "dependencies": {
+    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
+    "@nestjs/core": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
+    "firebase-admin": "^13.7.0"
+  },
   "devDependencies": {
-    "@commitlint/cli": "18.6.1",
-    "@commitlint/config-angular": "18.6.1",
-    "@nestjs/testing": "10.4.13",
+    "@nestjs/testing": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
     "@types/jest": "29.5.14",
     "@types/node": "20.17.9",
     "@types/supertest": "^2.0.16",
@@ -55,12 +64,9 @@
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-jest": "^28.8.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "husky": "8.0.3",
     "jest": "29.7.0",
-    "lint-staged": "15.2.10",
     "prettier": "^3.4.2",
-    "reflect-metadata": "0.2.2",
-    "release-it": "^19.0.2",
+    "reflect-metadata": "^0.2.2",
     "rimraf": "5.0.10",
     "rxjs": "7.8.1",
     "supertest": "^7.1.0",
@@ -68,21 +74,10 @@
     "typescript": "5.7.2"
   },
   "peerDependencies": {
-    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1",
+    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^6.0.0 || ^7.0.0"
   },
-  "lint-staged": {
-    "*.ts": [
-      "prettier --write"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -c .commitlintrc.json -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/hebertcisco/nestjs-firebase-admin"
@@ -99,9 +94,23 @@
       "^.+\\.(t|j)s$": "ts-jest"
     },
     "collectCoverageFrom": [
-      "**/*.(t|j)s"
+      "**/*.(t|j)s",
+      "!**/*.spec.ts",
+      "!**/tests/**",
+      "!**/mocks/**",
+      "!**/interfaces/index.ts",
+      "!**/types/index.ts",
+      "!index.ts"
     ],
     "coverageDirectory": "../coverage",
+    "coverageThreshold": {
+      "global": {
+        "statements": 85,
+        "branches": 65,
+        "functions": 92,
+        "lines": 95
+      }
+    },
     "testEnvironment": "node"
   }
 }

package/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://hebertcisco.github.io/nestjs-firebase-admin/sitemap.xml

package/sitemap.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/</loc>
+    <changefreq>weekly</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/getting-started</loc>
+    <changefreq>weekly</changefreq>
+    <priority>0.9</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/admin-service</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/auth-service</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/database-service</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/firestore-service</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/messaging-service</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/testing</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.6</priority>
+  </url>
+  <url>
+    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/contributing</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>